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
1487         switch ( f->f_choice ) {
1488         case LDAP_FILTER_EQUALITY:
1489                 ad = f->f_av_desc;
1490                 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
1491                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
1492                 break;
1493
1494         case LDAP_FILTER_GE:
1495                 ad = f->f_av_desc;
1496                 sprintf( fstr->bv_val+fstr->bv_len, "(%s>=)", ad->ad_cname.bv_val);
1497                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(>=)") - 1 );
1498                 break;
1499
1500         case LDAP_FILTER_LE:
1501                 ad = f->f_av_desc;
1502                 sprintf( fstr->bv_val+fstr->bv_len, "(%s<=)", ad->ad_cname.bv_val);
1503                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(<=)") - 1 );
1504                 break;
1505
1506         case LDAP_FILTER_APPROX:
1507                 ad = f->f_av_desc;
1508                 sprintf( fstr->bv_val+fstr->bv_len, "(%s~=)", ad->ad_cname.bv_val);
1509                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(~=)") - 1 );
1510                 break;
1511
1512         case LDAP_FILTER_SUBSTRINGS:
1513                 ad = f->f_sub_desc;
1514                 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
1515                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
1516                 break;
1517
1518         case LDAP_FILTER_PRESENT:
1519                 ad = f->f_desc;
1520                 sprintf( fstr->bv_val+fstr->bv_len, "(%s=*)", ad->ad_cname.bv_val );
1521                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=*)") - 1 );
1522                 break;
1523
1524         case LDAP_FILTER_AND:
1525         case LDAP_FILTER_OR:
1526         case LDAP_FILTER_NOT: {
1527                 int rc = 0;
1528                 sprintf( fstr->bv_val+fstr->bv_len, "(%c",
1529                         f->f_choice == LDAP_FILTER_AND ? '&' :
1530                         f->f_choice == LDAP_FILTER_OR ? '|' : '!' );
1531                 fstr->bv_len += sizeof("(%") - 1;
1532
1533                 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1534                         rc = filter2template( op, f, fstr, filter_attrs, filter_cnt,
1535                                 filter_got_oc );
1536                         if ( rc ) break;
1537                 }
1538                 sprintf( fstr->bv_val+fstr->bv_len, ")" );
1539                 fstr->bv_len += sizeof(")") - 1;
1540
1541                 return rc;
1542                 }
1543
1544         default:
1545                 strcpy( fstr->bv_val, "(?=?)" );
1546                 fstr->bv_len += sizeof("(?=?)")-1;
1547                 return -1;
1548         }
1549
1550         if ( filter_attrs != NULL ) {
1551                 *filter_attrs = (AttributeName *)op->o_tmprealloc(*filter_attrs,
1552                                 (*filter_cnt + 2)*sizeof(AttributeName), op->o_tmpmemctx);
1553
1554                 (*filter_attrs)[*filter_cnt].an_desc = ad;
1555                 (*filter_attrs)[*filter_cnt].an_name = ad->ad_cname;
1556                 (*filter_attrs)[*filter_cnt].an_oc = NULL;
1557                 (*filter_attrs)[*filter_cnt].an_oc_exclude = 0;
1558                 BER_BVZERO( &(*filter_attrs)[*filter_cnt+1].an_name );
1559                 (*filter_cnt)++;
1560                 if ( ad == slap_schema.si_ad_objectClass )
1561                         *filter_got_oc = 1;
1562         }
1563
1564         return 0;
1565 }
1566
1567 struct search_info {
1568         slap_overinst *on;
1569         Query query;
1570         QueryTemplate *qtemp;
1571         AttributeName*  save_attrs;     /* original attributes, saved for response */
1572         int max;
1573         int over;
1574         int count;
1575         int slimit;
1576         int slimit_exceeded;
1577         pc_caching_reason_t caching_reason;
1578         Entry *head, *tail;
1579 };
1580
1581 static void
1582 remove_query_and_data(
1583         Operation       *op,
1584         SlapReply       *rs,
1585         cache_manager   *cm,
1586         struct berval   *uuid )
1587 {
1588         query_manager*          qm = cm->qm;
1589
1590         qm->crfunc( qm, uuid );
1591         if ( !BER_BVISNULL( uuid ) ) {
1592                 int     return_val;
1593
1594                 Debug( pcache_debug,
1595                         "Removing query UUID %s\n",
1596                         uuid->bv_val, 0, 0 );
1597                 return_val = remove_query_data( op, rs, uuid );
1598                 Debug( pcache_debug,
1599                         "QUERY REMOVED, SIZE=%d\n",
1600                         return_val, 0, 0);
1601                 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1602                 cm->cur_entries -= return_val;
1603                 cm->num_cached_queries--;
1604                 Debug( pcache_debug,
1605                         "STORED QUERIES = %lu\n",
1606                         cm->num_cached_queries, 0, 0 );
1607                 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1608                 Debug( pcache_debug,
1609                         "QUERY REMOVED, CACHE ="
1610                         "%d entries\n",
1611                         cm->cur_entries, 0, 0 );
1612         }
1613 }
1614
1615 /*
1616  * Callback used to fetch queryId values based on entryUUID;
1617  * used by pcache_remove_entries_from_cache()
1618  */
1619 static int
1620 fetch_queryId_cb( Operation *op, SlapReply *rs )
1621 {
1622         int             rc = 0;
1623
1624         /* only care about searchEntry responses */
1625         if ( rs->sr_type != REP_SEARCH ) {
1626                 return 0;
1627         }
1628
1629         /* allow only one response per entryUUID */
1630         if ( op->o_callback->sc_private != NULL ) {
1631                 rc = 1;
1632
1633         } else {
1634                 Attribute       *a;
1635
1636                 /* copy all queryId values into callback's private data */
1637                 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1638                 if ( a != NULL ) {
1639                         BerVarray       vals = NULL;
1640
1641                         ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
1642                         op->o_callback->sc_private = (void *)vals;
1643                 }
1644         }
1645
1646         /* clear entry if required */
1647         if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
1648                 entry_free( rs->sr_entry );
1649                 rs->sr_entry = NULL;
1650                 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
1651         }
1652
1653         return rc;
1654 }
1655
1656 /*
1657  * Call that allows to remove a set of entries from the cache,
1658  * by forcing the removal of all the related queries.
1659  */
1660 int
1661 pcache_remove_entries_from_cache(
1662         Operation       *op,
1663         cache_manager   *cm,
1664         BerVarray       entryUUIDs )
1665 {
1666         Connection      conn = { 0 };
1667         OperationBuffer opbuf;
1668         Operation       op2;
1669         slap_callback   sc = { 0 };
1670         SlapReply       rs = { REP_RESULT };
1671         Filter          f = { 0 };
1672         char            filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
1673         AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1674         AttributeName   attrs[ 2 ] = { 0 };
1675         int             s, rc;
1676
1677         if ( op == NULL ) {
1678                 void    *thrctx = ldap_pvt_thread_pool_context();
1679
1680                 connection_fake_init( &conn, &opbuf, thrctx );
1681                 op = &opbuf.ob_op;
1682
1683         } else {
1684                 op2 = *op;
1685                 op = &op2;
1686         }
1687
1688         memset( &op->oq_search, 0, sizeof( op->oq_search ) );
1689         op->ors_scope = LDAP_SCOPE_SUBTREE;
1690         op->ors_deref = LDAP_DEREF_NEVER;
1691         f.f_choice = LDAP_FILTER_EQUALITY;
1692         f.f_ava = &ava;
1693         ava.aa_desc = slap_schema.si_ad_entryUUID;
1694         op->ors_filter = &f;
1695         op->ors_slimit = 1;
1696         op->ors_tlimit = SLAP_NO_LIMIT;
1697         attrs[ 0 ].an_desc = ad_queryId;
1698         attrs[ 0 ].an_name = ad_queryId->ad_cname;
1699         op->ors_attrs = attrs;
1700         op->ors_attrsonly = 0;
1701
1702         op->o_req_dn = cm->db.be_suffix[ 0 ];
1703         op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
1704
1705         op->o_tag = LDAP_REQ_SEARCH;
1706         op->o_protocol = LDAP_VERSION3;
1707         op->o_managedsait = SLAP_CONTROL_CRITICAL;
1708         op->o_bd = &cm->db;
1709         op->o_dn = op->o_bd->be_rootdn;
1710         op->o_ndn = op->o_bd->be_rootndn;
1711         sc.sc_response = fetch_queryId_cb;
1712         op->o_callback = &sc;
1713
1714         for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
1715                 BerVarray       vals = NULL;
1716
1717                 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
1718                         "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
1719                 op->ors_filterstr.bv_val = filtbuf;
1720                 ava.aa_value = entryUUIDs[ s ];
1721
1722                 rc = op->o_bd->be_search( op, &rs );
1723                 if ( rc != LDAP_SUCCESS ) {
1724                         continue;
1725                 }
1726
1727                 vals = (BerVarray)op->o_callback->sc_private;
1728                 if ( vals != NULL ) {
1729                         int             i;
1730
1731                         for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
1732                                 struct berval   val = vals[ i ];
1733
1734                                 remove_query_and_data( op, &rs, cm, &val );
1735
1736                                 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
1737                                         ch_free( val.bv_val );
1738                                 }
1739                         }
1740
1741                         ber_bvarray_free_x( vals, op->o_tmpmemctx );
1742                         op->o_callback->sc_private = NULL;
1743                 }
1744         }
1745
1746         return 0;
1747 }
1748
1749 /*
1750  * Call that allows to remove a query from the cache.
1751  */
1752 int
1753 pcache_remove_query_from_cache(
1754         Operation       *op,
1755         cache_manager   *cm,
1756         struct berval   *queryid )
1757 {
1758         Operation       op2 = *op;
1759         SlapReply       rs2 = { 0 };
1760
1761         op2.o_bd = &cm->db;
1762
1763         /* remove the selected query */
1764         remove_query_and_data( &op2, &rs2, cm, queryid );
1765
1766         return LDAP_SUCCESS;
1767 }
1768
1769 /*
1770  * Call that allows to remove a set of queries related to an entry
1771  * from the cache; if queryid is not null, the entry must belong to
1772  * the query indicated by queryid.
1773  */
1774 int
1775 pcache_remove_entry_queries_from_cache(
1776         Operation       *op,
1777         cache_manager   *cm,
1778         struct berval   *ndn,
1779         struct berval   *queryid )
1780 {
1781         Connection              conn = { 0 };
1782         OperationBuffer         opbuf;
1783         Operation               op2;
1784         slap_callback           sc = { 0 };
1785         SlapReply               rs = { REP_RESULT };
1786         Filter                  f = { 0 };
1787         char                    filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(queryId=)" ) ];
1788         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
1789         AttributeName           attrs[ 2 ] = { 0 };
1790         int                     rc;
1791
1792         BerVarray               vals = NULL;
1793
1794         if ( op == NULL ) {
1795                 void    *thrctx = ldap_pvt_thread_pool_context();
1796
1797                 connection_fake_init( &conn, &opbuf, thrctx );
1798                 op = &opbuf.ob_op;
1799
1800         } else {
1801                 op2 = *op;
1802                 op = &op2;
1803         }
1804
1805         memset( &op->oq_search, 0, sizeof( op->oq_search ) );
1806         op->ors_scope = LDAP_SCOPE_BASE;
1807         op->ors_deref = LDAP_DEREF_NEVER;
1808         if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
1809                 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
1810                 f.f_choice = LDAP_FILTER_PRESENT;
1811                 f.f_desc = slap_schema.si_ad_objectClass;
1812
1813         } else {
1814                 op->ors_filterstr.bv_len = snprintf( filter_str,
1815                         sizeof( filter_str ), "(%s=%s)",
1816                         ad_queryId->ad_cname.bv_val, queryid->bv_val );
1817                 f.f_choice = LDAP_FILTER_EQUALITY;
1818                 f.f_ava = &ava;
1819                 f.f_av_desc = ad_queryId;
1820                 f.f_av_value = *queryid;
1821         }
1822         op->ors_filter = &f;
1823         op->ors_slimit = 1;
1824         op->ors_tlimit = SLAP_NO_LIMIT;
1825         attrs[ 0 ].an_desc = ad_queryId;
1826         attrs[ 0 ].an_name = ad_queryId->ad_cname;
1827         op->ors_attrs = attrs;
1828         op->ors_attrsonly = 0;
1829
1830         op->o_req_dn = *ndn;
1831         op->o_req_ndn = *ndn;
1832
1833         op->o_tag = LDAP_REQ_SEARCH;
1834         op->o_protocol = LDAP_VERSION3;
1835         op->o_managedsait = SLAP_CONTROL_CRITICAL;
1836         op->o_bd = &cm->db;
1837         op->o_dn = op->o_bd->be_rootdn;
1838         op->o_ndn = op->o_bd->be_rootndn;
1839         sc.sc_response = fetch_queryId_cb;
1840         op->o_callback = &sc;
1841
1842         rc = op->o_bd->be_search( op, &rs );
1843         if ( rc != LDAP_SUCCESS ) {
1844                 return rc;
1845         }
1846
1847         vals = (BerVarray)op->o_callback->sc_private;
1848         if ( vals != NULL ) {
1849                 int             i;
1850
1851                 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
1852                         struct berval   val = vals[ i ];
1853
1854                         remove_query_and_data( op, &rs, cm, &val );
1855
1856                         if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
1857                                 ch_free( val.bv_val );
1858                         }
1859                 }
1860
1861                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
1862         }
1863
1864         return LDAP_SUCCESS;
1865 }
1866
1867 static int
1868 cache_entries(
1869         Operation       *op,
1870         SlapReply       *rs,
1871         struct berval *query_uuid )
1872 {
1873         struct search_info *si = op->o_callback->sc_private;
1874         slap_overinst *on = si->on;
1875         cache_manager *cm = on->on_bi.bi_private;
1876         int             return_val = 0;
1877         Entry           *e;
1878         struct berval   crp_uuid;
1879         char            uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
1880         Operation       *op_tmp;
1881         Connection      conn = {0};
1882         OperationBuffer opbuf;
1883         void            *thrctx = ldap_pvt_thread_pool_context();
1884
1885         query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
1886         ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
1887
1888         connection_fake_init2( &conn, &opbuf, thrctx, 0 );
1889         op_tmp = &opbuf.ob_op;
1890         op_tmp->o_bd = &cm->db;
1891         op_tmp->o_dn = cm->db.be_rootdn;
1892         op_tmp->o_ndn = cm->db.be_rootndn;
1893
1894         Debug( pcache_debug, "UUID for query being added = %s\n",
1895                         uuidbuf, 0, 0 );
1896
1897         for ( e=si->head; e; e=si->head ) {
1898                 si->head = e->e_private;
1899                 e->e_private = NULL;
1900                 while ( cm->cur_entries > (cm->max_entries) ) {
1901                         BER_BVZERO( &crp_uuid );
1902                         remove_query_and_data( op_tmp, rs, cm, &crp_uuid );
1903                 }
1904
1905                 return_val = merge_entry(op_tmp, e, query_uuid);
1906                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1907                 cm->cur_entries += return_val;
1908                 Debug( pcache_debug,
1909                         "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
1910                         cm->cur_entries, 0, 0 );
1911                 return_val = 0;
1912                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1913         }
1914
1915         return return_val;
1916 }
1917
1918 static int
1919 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
1920         slap_callback   *cb = op->o_callback;
1921         struct search_info *si = cb->sc_private;
1922         slap_overinst *on = si->on;
1923         cache_manager *cm = on->on_bi.bi_private;
1924         query_manager*          qm = cm->qm;
1925
1926         if ( rs->sr_type == REP_SEARCH ) {
1927                 Entry *e;
1928
1929                 /* don't return more entries than requested by the client */
1930                 if ( si->slimit && rs->sr_nentries >= si->slimit ) {
1931                         si->slimit_exceeded = 1;
1932                 }
1933
1934                 /* If we haven't exceeded the limit for this query,
1935                  * build a chain of answers to store. If we hit the
1936                  * limit, empty the chain and ignore the rest.
1937                  */
1938                 if ( !si->over ) {
1939                         if ( si->count < si->max ) {
1940                                 si->count++;
1941                                 e = entry_dup( rs->sr_entry );
1942                                 if ( !si->head ) si->head = e;
1943                                 if ( si->tail ) si->tail->e_private = e;
1944                                 si->tail = e;
1945
1946                         } else {
1947                                 si->over = 1;
1948                                 si->count = 0;
1949                                 for (;si->head; si->head=e) {
1950                                         e = si->head->e_private;
1951                                         si->head->e_private = NULL;
1952                                         entry_free(si->head);
1953                                 }
1954                                 si->tail = NULL;
1955                         }
1956                 }
1957
1958         }
1959
1960         if ( rs->sr_type == REP_RESULT ||
1961                 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
1962         {
1963                 if ( si->save_attrs != NULL ) {
1964                         rs->sr_attrs = si->save_attrs;
1965                         op->ors_attrs = si->save_attrs;
1966                 }
1967                 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
1968                                 si->caching_reason == PC_IGNORE ) {
1969                         filter_free( si->query.filter );
1970                         if ( si->count ) {
1971                                 /* duplicate query, free it */
1972                                 Entry *e;
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                         }
1979                         op->o_callback = op->o_callback->sc_next;
1980                         op->o_tmpfree( cb, op->o_tmpmemctx );
1981                 } else if ( si->caching_reason != PC_IGNORE ) {
1982                         CachedQuery *qc = qm->addfunc(op, qm, &si->query,
1983                                 si->qtemp, si->caching_reason, 1 );
1984
1985                         if ( qc != NULL ) {
1986                                 switch ( si->caching_reason ) {
1987                                 case PC_POSITIVE:
1988                                         cache_entries( op, rs, &qc->q_uuid );
1989                                         break;
1990
1991                                 case PC_SIZELIMIT:
1992                                         qc->q_sizelimit = rs->sr_nentries;
1993                                         break;
1994                                 }
1995                                 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
1996                                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1997                                 cm->num_cached_queries++;
1998                                 Debug( pcache_debug, "STORED QUERIES = %lu\n",
1999                                                 cm->num_cached_queries, 0, 0 );
2000                                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2001
2002                                 /* If the consistency checker suspended itself,
2003                                  * wake it back up
2004                                  */
2005                                 if ( cm->cc_paused ) {
2006                                         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2007                                         if ( cm->cc_paused ) {
2008                                                 cm->cc_paused = 0;
2009                                                 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2010                                         }
2011                                         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2012                                 }
2013
2014                         } else if ( si->count ) {
2015                                 /* duplicate query, free it */
2016                                 Entry *e;
2017                                 for (;si->head; si->head=e) {
2018                                         e = si->head->e_private;
2019                                         si->head->e_private = NULL;
2020                                         entry_free(si->head);
2021                                 }
2022                         }
2023
2024                 } else {
2025                         filter_free( si->query.filter );
2026                 }
2027         }
2028
2029         return SLAP_CB_CONTINUE;
2030 }
2031
2032 static int
2033 pcache_response(
2034         Operation       *op,
2035         SlapReply       *rs )
2036 {
2037         struct search_info *si = op->o_callback->sc_private;
2038
2039         if ( si->save_attrs != NULL ) {
2040                 rs->sr_attrs = si->save_attrs;
2041                 op->ors_attrs = si->save_attrs;
2042         }
2043
2044         if ( rs->sr_type == REP_SEARCH ) {
2045                 /* don't return more entries than requested by the client */
2046                 if ( si->slimit_exceeded ) {
2047                         return 0;
2048                 }
2049
2050         } else if ( rs->sr_type == REP_RESULT ) {
2051
2052                 if ( si->count ) {
2053                         if ( rs->sr_err == LDAP_SUCCESS ) {
2054                                 si->caching_reason = PC_POSITIVE;
2055
2056                         } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2057                                 && si->qtemp->limitttl )
2058                         {
2059                                 si->caching_reason = PC_SIZELIMIT;
2060                         }
2061
2062                 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2063                                 rs->sr_err == LDAP_SUCCESS )
2064                 {
2065                         si->caching_reason = PC_NEGATIVE;
2066                 }
2067
2068
2069                 if ( si->slimit_exceeded ) {
2070                         rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2071                 }
2072         }
2073
2074         return SLAP_CB_CONTINUE;
2075 }
2076
2077 static int
2078 add_filter_attrs(
2079         Operation *op,
2080         AttributeName** new_attrs,
2081         struct attr_set *attrs,
2082         AttributeName* filter_attrs,
2083         int fattr_cnt,
2084         int fattr_got_oc)
2085 {
2086         int alluser = 0;
2087         int allop = 0;
2088         int i, j;
2089         int count;
2090         int addoc = 0;
2091
2092         /* duplicate attrs */
2093         count = attrs->count + fattr_cnt;
2094         if ( !fattr_got_oc && !(attrs->flags & PC_GOT_OC)) {
2095                 addoc = 1;
2096                 count++;
2097         }
2098
2099         *new_attrs = (AttributeName*)ch_calloc( count + 1,
2100                 sizeof(AttributeName) );
2101         for (i=0; i<attrs->count; i++) {
2102                 (*new_attrs)[i].an_name = attrs->attrs[i].an_name;
2103                 (*new_attrs)[i].an_desc = attrs->attrs[i].an_desc;
2104         }
2105         BER_BVZERO( &(*new_attrs)[i].an_name );
2106         alluser = an_find(*new_attrs, &AllUser);
2107         allop = an_find(*new_attrs, &AllOper);
2108
2109         j = i;
2110         for ( i=0; i<fattr_cnt; i++ ) {
2111                 if ( an_find(*new_attrs, &filter_attrs[i].an_name ) ) {
2112                         continue;
2113                 }
2114                 if ( is_at_operational(filter_attrs[i].an_desc->ad_type) ) {
2115                         if ( allop ) {
2116                                 continue;
2117                         }
2118                 } else if ( alluser ) {
2119                         continue;
2120                 }
2121                 (*new_attrs)[j].an_name = filter_attrs[i].an_name;
2122                 (*new_attrs)[j].an_desc = filter_attrs[i].an_desc;
2123                 (*new_attrs)[j].an_oc = NULL;
2124                 (*new_attrs)[j].an_oc_exclude = 0;
2125                 j++;
2126         }
2127         if ( addoc ) {
2128                 (*new_attrs)[j].an_name = slap_schema.si_ad_objectClass->ad_cname;
2129                 (*new_attrs)[j].an_desc = slap_schema.si_ad_objectClass;
2130                 (*new_attrs)[j].an_oc = NULL;
2131                 (*new_attrs)[j].an_oc_exclude = 0;
2132                 j++;
2133         }
2134         BER_BVZERO( &(*new_attrs)[j].an_name );
2135
2136         return count;
2137 }
2138
2139 /* NOTE: this is a quick workaround to let pcache minimally interact
2140  * with pagedResults.  A more articulated solutions would be to
2141  * perform the remote query without control and cache all results,
2142  * performing the pagedResults search only within the client
2143  * and the proxy.  This requires pcache to understand pagedResults. */
2144 static int
2145 pcache_chk_controls(
2146         Operation       *op,
2147         SlapReply       *rs )
2148 {
2149         const char      *non = "";
2150         const char      *stripped = "";
2151
2152         switch( op->o_pagedresults ) {
2153         case SLAP_CONTROL_NONCRITICAL:
2154                 non = "non-";
2155                 stripped = "; stripped";
2156                 /* fallthru */
2157
2158         case SLAP_CONTROL_CRITICAL:
2159                 Debug( pcache_debug, "%s: "
2160                         "%scritical pagedResults control "
2161                         "disabled with proxy cache%s.\n",
2162                         op->o_log_prefix, non, stripped );
2163
2164                 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2165                 break;
2166
2167         default:
2168                 rs->sr_err = SLAP_CB_CONTINUE;
2169                 break;
2170         }
2171
2172         return rs->sr_err;
2173 }
2174
2175 #ifdef PCACHE_CONTROL_PRIVDB
2176 static int
2177 pcache_op_privdb(
2178         Operation               *op,
2179         SlapReply               *rs )
2180 {
2181         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
2182         cache_manager   *cm = on->on_bi.bi_private;
2183         slap_callback   *save_cb;
2184         slap_op_t       type;
2185
2186         /* skip if control is unset */
2187         if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2188                 return SLAP_CB_CONTINUE;
2189         }
2190
2191         /* The cache DB isn't open yet */
2192         if ( cm->defer_db_open ) {
2193                 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2194                         "pcachePrivDB: cacheDB not available" );
2195                 return rs->sr_err;
2196         }
2197
2198         /* FIXME: might be a little bit exaggerated... */
2199         if ( !be_isroot( op ) ) {
2200                 save_cb = op->o_callback;
2201                 op->o_callback = NULL;
2202                 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2203                         "pcachePrivDB: operation not allowed" );
2204                 op->o_callback = save_cb;
2205
2206                 return rs->sr_err;
2207         }
2208
2209         /* map tag to operation */
2210         type = slap_req2op( op->o_tag );
2211         if ( type != SLAP_OP_LAST ) {
2212                 BI_op_func      **func;
2213                 int             rc;
2214
2215                 /* execute, if possible */
2216                 func = &cm->db.be_bind;
2217                 if ( func[ type ] != NULL ) {
2218                         Operation       op2 = *op;
2219
2220                         op2.o_bd = &cm->db;
2221
2222                         rc = func[ type ]( &op2, rs );
2223                         if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2224                                 op->o_conn->c_authz_cookie = cm->db.be_private;
2225                         }
2226                 }
2227         }
2228
2229         /* otherwise fall back to error */
2230         save_cb = op->o_callback;
2231         op->o_callback = NULL;
2232         send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2233                 "operation not supported with pcachePrivDB control" );
2234         op->o_callback = save_cb;
2235
2236         return rs->sr_err;
2237 }
2238 #endif /* PCACHE_CONTROL_PRIVDB */
2239
2240 static int
2241 pcache_op_search(
2242         Operation       *op,
2243         SlapReply       *rs )
2244 {
2245         slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2246         cache_manager *cm = on->on_bi.bi_private;
2247         query_manager*          qm = cm->qm;
2248
2249         int i = -1;
2250
2251         AttributeName   *filter_attrs = NULL;
2252
2253         Query           query;
2254         QueryTemplate   *qtemp = NULL;
2255
2256         int             attr_set = -1;
2257         CachedQuery     *answerable = NULL;
2258         int             cacheable = 0;
2259         int             fattr_cnt=0;
2260         int             fattr_got_oc = 0;
2261
2262         struct berval   tempstr;
2263
2264 #ifdef PCACHE_CONTROL_PRIVDB
2265         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2266                 return pcache_op_privdb( op, rs );
2267         }
2268 #endif /* PCACHE_CONTROL_PRIVDB */
2269
2270         /* The cache DB isn't open yet */
2271         if ( cm->defer_db_open ) {
2272                 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2273                         "pcachePrivDB: cacheDB not available" );
2274                 return rs->sr_err;
2275         }
2276
2277         tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1, op->o_tmpmemctx );
2278         tempstr.bv_len = 0;
2279         if ( filter2template( op, op->ors_filter, &tempstr, &filter_attrs,
2280                 &fattr_cnt, &fattr_got_oc )) {
2281                 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2282                 return SLAP_CB_CONTINUE;
2283         }
2284
2285         Debug( pcache_debug, "query template of incoming query = %s\n",
2286                                         tempstr.bv_val, 0, 0 );
2287
2288         /* FIXME: cannot cache/answer requests with pagedResults control */
2289
2290         /* find attr set */
2291         attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2292
2293         query.filter = op->ors_filter;
2294         query.base = op->o_req_ndn;
2295         query.scope = op->ors_scope;
2296
2297         /* check for query containment */
2298         if (attr_set > -1) {
2299                 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2300                 for (; qt; qt = qt->qtnext ) {
2301                         /* find if template i can potentially answer tempstr */
2302                         if (qt->querystr.bv_len != tempstr.bv_len ||
2303                                 strcasecmp( qt->querystr.bv_val, tempstr.bv_val ))
2304                                 continue;
2305                         cacheable = 1;
2306                         qtemp = qt;
2307                         Debug( pcache_debug, "Entering QC, querystr = %s\n",
2308                                         op->ors_filterstr.bv_val, 0, 0 );
2309                         answerable = (*(qm->qcfunc))(op, qm, &query, qt);
2310
2311                         if (answerable)
2312                                 break;
2313                 }
2314         }
2315         op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2316
2317         if (answerable) {
2318                 /* Need to clear the callbacks of the original operation,
2319                  * in case there are other overlays */
2320                 BackendDB       *save_bd = op->o_bd;
2321                 slap_callback   *save_cb = op->o_callback;
2322
2323                 Debug( pcache_debug, "QUERY ANSWERABLE\n", 0, 0, 0 );
2324                 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
2325                 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
2326                 if ( BER_BVISNULL( &answerable->q_uuid )) {
2327                         /* No entries cached, just an empty result set */
2328                         i = rs->sr_err = 0;
2329                         send_ldap_result( op, rs );
2330                 } else {
2331                         op->o_bd = &cm->db;
2332                         op->o_callback = NULL;
2333                         i = cm->db.bd_info->bi_op_search( op, rs );
2334                 }
2335                 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
2336                 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
2337                 op->o_bd = save_bd;
2338                 op->o_callback = save_cb;
2339                 return i;
2340         }
2341
2342         Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
2343
2344         ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2345         if (cm->num_cached_queries >= cm->max_queries) {
2346                 cacheable = 0;
2347         }
2348         ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2349
2350         if (op->ors_attrsonly)
2351                 cacheable = 0;
2352
2353         if (cacheable) {
2354                 slap_callback           *cb;
2355                 struct search_info      *si;
2356
2357                 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
2358                 query.filter = filter_dup(op->ors_filter, NULL);
2359                 ldap_pvt_thread_rdwr_wlock(&qtemp->t_rwlock);
2360                 if ( !qtemp->t_attrs.count ) {
2361                         qtemp->t_attrs.count = add_filter_attrs(op,
2362                                 &qtemp->t_attrs.attrs,
2363                                 &qm->attr_sets[attr_set],
2364                                 filter_attrs, fattr_cnt, fattr_got_oc);
2365                 }
2366                 ldap_pvt_thread_rdwr_wunlock(&qtemp->t_rwlock);
2367
2368                 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
2369                 cb->sc_response = pcache_response;
2370                 cb->sc_cleanup = pcache_op_cleanup;
2371                 cb->sc_private = (cb+1);
2372                 si = cb->sc_private;
2373                 si->on = on;
2374                 si->query = query;
2375                 si->qtemp = qtemp;
2376                 si->max = cm->num_entries_limit ;
2377                 si->over = 0;
2378                 si->count = 0;
2379                 si->slimit = 0;
2380                 si->slimit_exceeded = 0;
2381                 si->caching_reason = PC_IGNORE;
2382                 if ( op->ors_slimit && op->ors_slimit < cm->num_entries_limit ) {
2383                         si->slimit = op->ors_slimit;
2384                         op->ors_slimit = cm->num_entries_limit;
2385                 }
2386                 si->head = NULL;
2387                 si->tail = NULL;
2388                 si->save_attrs = op->ors_attrs;
2389
2390                 op->ors_attrs = qtemp->t_attrs.attrs;
2391
2392                 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2393                         cb->sc_next = op->o_callback;
2394                         op->o_callback = cb;
2395
2396                 } else {
2397                         slap_callback           **pcb;
2398
2399                         /* need to move the callback at the end, in case other
2400                          * overlays are present, so that the final entry is
2401                          * actually cached */
2402                         cb->sc_next = NULL;
2403                         for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
2404                         *pcb = cb;
2405                 }
2406
2407         } else {
2408                 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
2409                                         0, 0, 0);
2410         }
2411
2412         op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
2413
2414         return SLAP_CB_CONTINUE;
2415 }
2416
2417 static int
2418 get_attr_set(
2419         AttributeName* attrs,
2420         query_manager* qm,
2421         int num )
2422 {
2423         int i;
2424         int count = 0;
2425
2426         if ( attrs ) {
2427                 for ( ; attrs[count].an_name.bv_val; count++ );
2428         }
2429
2430         /* recognize a single "*" or a "1.1" */
2431         if ( count == 0 ) {
2432                 count = 1;
2433                 attrs = slap_anlist_all_user_attributes;
2434
2435         } else if ( count == 1 && strcmp( attrs[0].an_name.bv_val, LDAP_NO_ATTRS ) == 0 ) {
2436                 count = 0;
2437                 attrs = NULL;
2438         }
2439
2440         for ( i = 0; i < num; i++ ) {
2441                 AttributeName *a2;
2442                 int found = 1;
2443
2444                 if ( count > qm->attr_sets[i].count ) {
2445                         continue;
2446                 }
2447
2448                 if ( !count ) {
2449                         if ( !qm->attr_sets[i].count ) {
2450                                 break;
2451                         }
2452                         continue;
2453                 }
2454
2455                 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
2456                         if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
2457                                 found = 0;
2458                                 break;
2459                         }
2460                 }
2461
2462                 if ( found ) {
2463                         break;
2464                 }
2465         }
2466
2467         if ( i == num ) {
2468                 i = -1;
2469         }
2470
2471         return i;
2472 }
2473
2474 static void*
2475 consistency_check(
2476         void *ctx,
2477         void *arg )
2478 {
2479         struct re_s *rtask = arg;
2480         slap_overinst *on = rtask->arg;
2481         cache_manager *cm = on->on_bi.bi_private;
2482         query_manager *qm = cm->qm;
2483         Connection conn = {0};
2484         OperationBuffer opbuf;
2485         Operation *op;
2486
2487         SlapReply rs = {REP_RESULT};
2488         CachedQuery* query;
2489         int return_val, pause = 1;
2490         QueryTemplate* templ;
2491
2492         connection_fake_init( &conn, &opbuf, ctx );
2493         op = &opbuf.ob_op;
2494
2495         op->o_bd = &cm->db;
2496         op->o_dn = cm->db.be_rootdn;
2497         op->o_ndn = cm->db.be_rootndn;
2498
2499         cm->cc_arg = arg;
2500
2501         for (templ = qm->templates; templ; templ=templ->qmnext) {
2502                 query = templ->query_last;
2503                 if ( query ) pause = 0;
2504                 op->o_time = slap_get_time();
2505                 while (query && (query->expiry_time < op->o_time)) {
2506                         int rem = 0;
2507                         Debug( pcache_debug, "Lock CR index = %p\n",
2508                                         (void *) templ, 0, 0 );
2509                         ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
2510                         if ( query == templ->query_last ) {
2511                                 rem = 1;
2512                                 remove_from_template(query, templ);
2513                                 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
2514                                                 (void *) templ, templ->no_of_queries, 0 );
2515                                 Debug( pcache_debug, "Unlock CR index = %p\n",
2516                                                 (void *) templ, 0, 0 );
2517                         }
2518                         ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
2519                         if ( !rem ) {
2520                                 query = templ->query_last;
2521                                 continue;
2522                         }
2523                         ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
2524                         remove_query(qm, query);
2525                         ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
2526                         if ( BER_BVISNULL( &query->q_uuid ))
2527                                 return_val = 0;
2528                         else
2529                                 return_val = remove_query_data(op, &rs, &query->q_uuid);
2530                         Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
2531                                                 return_val, 0, 0 );
2532                         ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2533                         cm->cur_entries -= return_val;
2534                         cm->num_cached_queries--;
2535                         Debug( pcache_debug, "STORED QUERIES = %lu\n",
2536                                         cm->num_cached_queries, 0, 0 );
2537                         ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2538                         Debug( pcache_debug,
2539                                 "STALE QUERY REMOVED, CACHE ="
2540                                 "%d entries\n",
2541                                 cm->cur_entries, 0, 0 );
2542                         free_query(query);
2543                         query = templ->query_last;
2544                 }
2545         }
2546         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2547         if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
2548                 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
2549         }
2550         /* If there were no queries, defer processing for a while */
2551         cm->cc_paused = pause;
2552         ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
2553
2554         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2555         return NULL;
2556 }
2557
2558
2559 #define MAX_ATTR_SETS 500
2560
2561 enum {
2562         PC_MAIN = 1,
2563         PC_ATTR,
2564         PC_TEMP,
2565         PC_RESP,
2566         PC_QUERIES
2567 };
2568
2569 static ConfigDriver pc_cf_gen;
2570 static ConfigLDAPadd pc_ldadd;
2571 static ConfigCfAdd pc_cfadd;
2572
2573 static ConfigTable pccfg[] = {
2574         { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
2575                                 "<cycle_time",
2576                 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
2577                 "( OLcfgOvAt:2.1 NAME 'olcProxyCache' "
2578                         "DESC 'ProxyCache basic parameters' "
2579                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2580         { "proxyattrset", "index> <attributes...",
2581                 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
2582                 "( OLcfgOvAt:2.2 NAME 'olcProxyAttrset' "
2583                         "DESC 'A set of attributes to cache' "
2584                         "SYNTAX OMsDirectoryString )", NULL, NULL },
2585         { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
2586                 4, 6, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
2587                 "( OLcfgOvAt:2.3 NAME 'olcProxyTemplate' "
2588                         "DESC 'Filter template, attrset, cache TTL, "
2589                                 "optional negative TTL, optional sizelimit TTL' "
2590                         "SYNTAX OMsDirectoryString )", NULL, NULL },
2591         { "response-callback", "head|tail(default)",
2592                 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
2593                 "( OLcfgOvAt:2.4 NAME 'olcProxyResponseCB' "
2594                         "DESC 'Response callback position in overlay stack' "
2595                         "SYNTAX OMsDirectoryString )", NULL, NULL },
2596         { "proxyCacheQueries", "queries",
2597                 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
2598                 "( OLcfgOvAt:2.5 NAME 'olcProxyCacheQueries' "
2599                         "DESC 'Maximum number of queries to cache' "
2600                         "SYNTAX OMsInteger )", NULL, NULL },
2601         { "proxySaveQueries", "TRUE|FALSE",
2602                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
2603                 "( OLcfgOvAt:2.6 NAME 'olcProxySaveQueries' "
2604                         "DESC 'Save cached queries for hot restart' "
2605                         "SYNTAX OMsBoolean )", NULL, NULL },
2606
2607         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2608 };
2609
2610 /* Need to no-op this keyword for dynamic config */
2611 static ConfigTable pcdummy[] = {
2612         { "", "", 0, 0, 0, ARG_IGNORED,
2613                 NULL, "( OLcfgGlAt:13 NAME 'olcDatabase' "
2614                         "DESC 'The backend type for a database instance' "
2615                         "SUP olcBackend SINGLE-VALUE X-ORDERED 'SIBLINGS' )", NULL, NULL },
2616         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2617 };
2618
2619 static ConfigOCs pcocs[] = {
2620         { "( OLcfgOvOc:2.1 "
2621                 "NAME 'olcPcacheConfig' "
2622                 "DESC 'ProxyCache configuration' "
2623                 "SUP olcOverlayConfig "
2624                 "MUST ( olcProxyCache $ olcProxyAttrset $ olcProxyTemplate ) "
2625                 "MAY ( olcProxyResponseCB $ olcProxyCacheQueries $ olcProxySaveQueries ) )",
2626                 Cft_Overlay, pccfg, NULL, pc_cfadd },
2627         { "( OLcfgOvOc:2.2 "
2628                 "NAME 'olcPcacheDatabase' "
2629                 "DESC 'Cache database configuration' "
2630                 "AUXILIARY )", Cft_Misc, pcdummy, pc_ldadd },
2631         { NULL, 0, NULL }
2632 };
2633
2634 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
2635
2636 static int
2637 pc_ldadd_cleanup( ConfigArgs *c )
2638 {
2639         slap_overinst *on = c->private;
2640         return pcache_db_open2( on, &c->reply );
2641 }
2642
2643 static int
2644 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
2645 {
2646         slap_overinst *on;
2647         cache_manager *cm;
2648
2649         if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
2650                 p->ce_bi->bi_cf_ocs != pcocs )
2651                 return LDAP_CONSTRAINT_VIOLATION;
2652
2653         on = (slap_overinst *)p->ce_bi;
2654         cm = on->on_bi.bi_private;
2655         ca->be = &cm->db;
2656         /* Defer open if this is an LDAPadd */
2657         if ( CONFIG_ONLINE_ADD( ca ))
2658                 ca->cleanup = pc_ldadd_cleanup;
2659         else
2660                 cm->defer_db_open = 0;
2661         ca->private = on;
2662         return LDAP_SUCCESS;
2663 }
2664
2665 static int
2666 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
2667 {
2668         CfEntryInfo *pe = p->e_private;
2669         slap_overinst *on = (slap_overinst *)pe->ce_bi;
2670         cache_manager *cm = on->on_bi.bi_private;
2671         struct berval bv;
2672
2673         /* FIXME: should not hardcode "olcDatabase" here */
2674         bv.bv_len = sprintf( ca->cr_msg, "olcDatabase=%s", cm->db.bd_info->bi_type );
2675         bv.bv_val = ca->cr_msg;
2676         ca->be = &cm->db;
2677         cm->defer_db_open = 0;
2678
2679         /* We can only create this entry if the database is table-driven
2680          */
2681         if ( cm->db.bd_info->bi_cf_ocs )
2682                 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
2683                         &pcocs[1] );
2684
2685         return 0;
2686 }
2687
2688 static int
2689 pc_cf_gen( ConfigArgs *c )
2690 {
2691         slap_overinst   *on = (slap_overinst *)c->bi;
2692         cache_manager*  cm = on->on_bi.bi_private;
2693         query_manager*  qm = cm->qm;
2694         QueryTemplate*  temp;
2695         AttributeName*  attr_name;
2696         AttributeName*  attrarray;
2697         const char*     text=NULL;
2698         int             i, num, rc = 0;
2699         char            *ptr;
2700         unsigned long   t;
2701
2702         if ( c->op == SLAP_CONFIG_EMIT ) {
2703                 struct berval bv;
2704                 switch( c->type ) {
2705                 case PC_MAIN:
2706                         bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
2707                                 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
2708                                 cm->num_entries_limit, cm->cc_period );
2709                         bv.bv_val = c->cr_msg;
2710                         value_add_one( &c->rvalue_vals, &bv );
2711                         break;
2712                 case PC_ATTR:
2713                         for (i=0; i<cm->numattrsets; i++) {
2714                                 if ( !qm->attr_sets[i].count ) continue;
2715
2716                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
2717
2718                                 /* count the attr length */
2719                                 for ( attr_name = qm->attr_sets[i].attrs;
2720                                         attr_name->an_name.bv_val; attr_name++ )
2721                                         bv.bv_len += attr_name->an_name.bv_len + 1;
2722
2723                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
2724                                 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
2725                                 for ( attr_name = qm->attr_sets[i].attrs;
2726                                         attr_name->an_name.bv_val; attr_name++ ) {
2727                                         *ptr++ = ' ';
2728                                         ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
2729                                 }
2730                                 ber_bvarray_add( &c->rvalue_vals, &bv );
2731                         }
2732                         if ( !c->rvalue_vals )
2733                                 rc = 1;
2734                         break;
2735                 case PC_TEMP:
2736                         for (temp=qm->templates; temp; temp=temp->qmnext) {
2737                                 /* HEADS-UP: always print all;
2738                                  * if optional == 0, ignore */
2739                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
2740                                         " %d %ld %ld %ld",
2741                                         temp->attr_set_index,
2742                                         temp->ttl,
2743                                         temp->negttl,
2744                                         temp->limitttl );
2745                                 bv.bv_len += temp->querystr.bv_len + 2;
2746                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
2747                                 ptr = bv.bv_val;
2748                                 *ptr++ = '"';
2749                                 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
2750                                 *ptr++ = '"';
2751                                 strcpy( ptr, c->cr_msg );
2752                                 ber_bvarray_add( &c->rvalue_vals, &bv );
2753                         }
2754                         if ( !c->rvalue_vals )
2755                                 rc = 1;
2756                         break;
2757                 case PC_RESP:
2758                         if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2759                                 BER_BVSTR( &bv, "head" );
2760                         } else {
2761                                 BER_BVSTR( &bv, "tail" );
2762                         }
2763                         value_add_one( &c->rvalue_vals, &bv );
2764                         break;
2765                 case PC_QUERIES:
2766                         c->value_int = cm->max_queries;
2767                         break;
2768                 }
2769                 return rc;
2770         } else if ( c->op == LDAP_MOD_DELETE ) {
2771                 return 1;       /* FIXME */
2772 #if 0
2773                 switch( c->type ) {
2774                 case PC_ATTR:
2775                 case PC_TEMP:
2776                 }
2777                 return rc;
2778 #endif
2779         }
2780
2781         switch( c->type ) {
2782         case PC_MAIN:
2783                 if ( cm->numattrsets > 0 ) {
2784                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive already provided" );
2785                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2786                         return( 1 );
2787                 }
2788
2789                 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
2790                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
2791                                 c->argv[3] );
2792                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2793                         return( 1 );
2794                 }
2795                 if ( cm->numattrsets <= 0 ) {
2796                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
2797                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2798                         return( 1 );
2799                 }
2800                 if ( cm->numattrsets > MAX_ATTR_SETS ) {
2801                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
2802                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2803                         return( 1 );
2804                 }
2805
2806                 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
2807                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
2808                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2809                         return( 1 );
2810                 }
2811
2812                 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
2813                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
2814                                 c->argv[2] );
2815                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2816                         return( 1 );
2817                 }
2818                 if ( cm->max_entries <= 0 ) {
2819                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
2820                         Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
2821                         return( 1 );
2822                 }
2823
2824                 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
2825                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
2826                                 c->argv[4] );
2827                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2828                         return( 1 );
2829                 }
2830                 if ( cm->num_entries_limit <= 0 ) {
2831                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
2832                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2833                         return( 1 );
2834                 }
2835                 if ( cm->num_entries_limit > cm->max_entries ) {
2836                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
2837                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2838                         return( 1 );
2839                 }
2840
2841                 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
2842                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
2843                                 c->argv[5] );
2844                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2845                         return( 1 );
2846                 }
2847
2848                 cm->cc_period = (time_t)t;
2849                 Debug( pcache_debug,
2850                                 "Total # of attribute sets to be cached = %d.\n",
2851                                 cm->numattrsets, 0, 0 );
2852                 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
2853                                                 sizeof( struct attr_set ) );
2854                 break;
2855         case PC_ATTR:
2856                 if ( cm->numattrsets == 0 ) {
2857                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2858                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2859                         return( 1 );
2860                 }
2861                 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
2862                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
2863                                 c->argv[1] );
2864                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2865                         return( 1 );
2866                 }
2867
2868                 if ( num < 0 || num >= cm->numattrsets ) {
2869                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
2870                                 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2871                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2872                         return 1;
2873                 }
2874                 qm->attr_sets[num].flags |= PC_CONFIGURED;
2875                 if ( c->argc == 2 ) {
2876                         /* assume "1.1" */
2877                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
2878                                 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
2879                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2880                         return 1;
2881
2882                 } else if ( c->argc == 3 ) {
2883                         if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2884                                 qm->attr_sets[num].count = 1;
2885                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2886                                         sizeof( AttributeName ) );
2887                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2888                                 break;
2889
2890                         } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2891                                 qm->attr_sets[num].count = 1;
2892                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2893                                         sizeof( AttributeName ) );
2894                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2895                                 break;
2896
2897                         } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
2898                                 break;
2899                         }
2900                         /* else: fallthru */
2901
2902                 } else if ( c->argc == 4 ) {
2903                         if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
2904                                 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
2905                         {
2906                                 qm->attr_sets[num].count = 2;
2907                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
2908                                         sizeof( AttributeName ) );
2909                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2910                                 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2911                                 break;
2912                         }
2913                         /* else: fallthru */
2914                 }
2915
2916                 if ( c->argc > 2 ) {
2917                         int all_user = 0, all_op = 0;
2918
2919                         qm->attr_sets[num].count = c->argc - 2;
2920                         qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
2921                                 sizeof( AttributeName ) );
2922                         attr_name = qm->attr_sets[num].attrs;
2923                         for ( i = 2; i < c->argc; i++ ) {
2924                                 attr_name->an_desc = NULL;
2925                                 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
2926                                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
2927                                                 "invalid attr #%d \"%s\" in attrlist",
2928                                                 i - 2, c->argv[i] );
2929                                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2930                                         ch_free( qm->attr_sets[num].attrs );
2931                                         qm->attr_sets[num].attrs = NULL;
2932                                         qm->attr_sets[num].count = 0;
2933                                         return 1;
2934                                 }
2935                                 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2936                                         all_user = 1;
2937                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
2938                                 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2939                                         all_op = 1;
2940                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2941                                 } else {
2942                                         if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
2943                                                 strcpy( c->cr_msg, text );
2944                                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2945                                                 ch_free( qm->attr_sets[num].attrs );
2946                                                 qm->attr_sets[num].attrs = NULL;
2947                                                 qm->attr_sets[num].count = 0;
2948                                                 return 1;
2949                                         }
2950                                         attr_name->an_name = attr_name->an_desc->ad_cname;
2951                                 }
2952                                 attr_name->an_oc = NULL;
2953                                 attr_name->an_oc_exclude = 0;
2954                                 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
2955                                         qm->attr_sets[num].flags |= PC_GOT_OC;
2956                                 attr_name++;
2957                                 BER_BVZERO( &attr_name->an_name );
2958                         }
2959
2960                         /* warn if list contains both "*" and "+" */
2961                         if ( i > 4 && all_user && all_op ) {
2962                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2963                                         "warning: attribute list contains \"*\" and \"+\"" );
2964                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2965                         }
2966                 }
2967                 break;
2968         case PC_TEMP:
2969                 if ( cm->numattrsets == 0 ) {
2970                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2971                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2972                         return( 1 );
2973                 }
2974                 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
2975                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
2976                                 c->argv[2] );
2977                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2978                         return( 1 );
2979                 }
2980
2981                 if ( i < 0 || i >= cm->numattrsets ||
2982                         !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
2983                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
2984                                 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2985                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2986                         return 1;
2987                 }
2988                 temp = ch_calloc( 1, sizeof( QueryTemplate ));
2989                 temp->qmnext = qm->templates;
2990                 qm->templates = temp;
2991                 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
2992                 temp->query = temp->query_last = NULL;
2993                 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
2994                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
2995                                 "unable to parse template ttl=\"%s\"",
2996                                 c->argv[3] );
2997                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2998                         return( 1 );
2999                 }
3000                 temp->ttl = (time_t)t;
3001                 temp->negttl = (time_t)0;
3002                 temp->limitttl = (time_t)0;
3003                 switch ( c->argc ) {
3004                 case 6:
3005                         if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3006                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3007                                         "unable to parse template sizelimit ttl=\"%s\"",
3008                                         c->argv[5] );
3009                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3010                                         return( 1 );
3011                         }
3012                         temp->limitttl = (time_t)t;
3013                         /* fallthru */
3014
3015                 case 5:
3016                         if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
3017                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3018                                         "unable to parse template negative ttl=\"%s\"",
3019                                         c->argv[4] );
3020                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3021                                         return( 1 );
3022                         }
3023                         temp->negttl = (time_t)t;
3024                         break;
3025                 }
3026
3027                 temp->no_of_queries = 0;
3028
3029                 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
3030                 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
3031                 Debug( pcache_debug, "  query template: %s\n",
3032                                 temp->querystr.bv_val, 0, 0 );
3033                 temp->attr_set_index = i;
3034                 qm->attr_sets[i].flags |= PC_REFERENCED;
3035                 temp->qtnext = qm->attr_sets[i].templates;
3036                 qm->attr_sets[i].templates = temp;
3037                 Debug( pcache_debug, "  attributes: \n", 0, 0, 0 );
3038                 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
3039                         for ( i=0; attrarray[i].an_name.bv_val; i++ )
3040                                 Debug( pcache_debug, "\t%s\n",
3041                                         attrarray[i].an_name.bv_val, 0, 0 );
3042                 }
3043                 break;
3044         case PC_RESP:
3045                 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
3046                         cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
3047
3048                 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
3049                         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
3050
3051                 } else {
3052                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
3053                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3054                         return 1;
3055                 }
3056                 break;
3057         case PC_QUERIES:
3058                 if ( c->value_int <= 0 ) {
3059                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
3060                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3061                         return( 1 );
3062                 }
3063                 cm->max_queries = c->value_int;
3064                 break;
3065         }
3066         return rc;
3067 }
3068
3069 static int
3070 pcache_db_config(
3071         BackendDB       *be,
3072         const char      *fname,
3073         int             lineno,
3074         int             argc,
3075         char            **argv
3076 )
3077 {
3078         slap_overinst   *on = (slap_overinst *)be->bd_info;
3079         cache_manager*  cm = on->on_bi.bi_private;
3080
3081         /* Something for the cache database? */
3082         if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
3083                 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
3084                         argc, argv );
3085         return SLAP_CONF_UNKNOWN;
3086 }
3087
3088 static int
3089 pcache_db_init(
3090         BackendDB *be,
3091         ConfigReply *cr)
3092 {
3093         slap_overinst *on = (slap_overinst *)be->bd_info;
3094         cache_manager *cm;
3095         query_manager *qm;
3096
3097         cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
3098         on->on_bi.bi_private = cm;
3099
3100         qm = (query_manager*)ch_malloc(sizeof(query_manager));
3101
3102         cm->db = *be;
3103         SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
3104         cm->db.be_private = NULL;
3105         cm->db.be_pcl_mutexp = &cm->db.be_pcl_mutex;
3106         cm->qm = qm;
3107         cm->numattrsets = 0;
3108         cm->num_entries_limit = 5;
3109         cm->num_cached_queries = 0;
3110         cm->max_entries = 0;
3111         cm->cur_entries = 0;
3112         cm->max_queries = 10000;
3113         cm->save_queries = 0;
3114         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
3115         cm->defer_db_open = 1;
3116         cm->cc_period = 1000;
3117         cm->cc_paused = 0;
3118         cm->cc_arg = NULL;
3119
3120         qm->attr_sets = NULL;
3121         qm->templates = NULL;
3122         qm->lru_top = NULL;
3123         qm->lru_bottom = NULL;
3124
3125         qm->qcfunc = query_containment;
3126         qm->crfunc = cache_replacement;
3127         qm->addfunc = add_query;
3128         ldap_pvt_thread_mutex_init(&qm->lru_mutex);
3129
3130         ldap_pvt_thread_mutex_init(&cm->cache_mutex);
3131         return 0;
3132 }
3133
3134 static int
3135 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
3136 {
3137         assert( op->o_tag == LDAP_REQ_SEARCH );
3138
3139         if ( rs->sr_type == REP_SEARCH ) {
3140                 Attribute       *a;
3141
3142                 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
3143                 if ( a != NULL ) {
3144                         BerVarray       *valsp;
3145
3146                         assert( a->a_nvals != NULL );
3147
3148                         valsp = op->o_callback->sc_private;
3149                         assert( *valsp == NULL );
3150
3151                         ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
3152                 }
3153         }
3154
3155         return 0;
3156 }
3157
3158 static int
3159 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
3160 {
3161         assert( op->o_tag == LDAP_REQ_SEARCH );
3162
3163         if ( rs->sr_type == REP_SEARCH ) {
3164                 int     *countp = (int *)op->o_callback->sc_private;
3165
3166                 (*countp)++;
3167         }
3168
3169         return 0;
3170 }
3171
3172 static int
3173 pcache_db_open2(
3174         slap_overinst *on,
3175         ConfigReply *cr )
3176 {
3177         cache_manager   *cm = on->on_bi.bi_private;
3178         query_manager*  qm = cm->qm;
3179         int rc;
3180
3181         rc = backend_startup_one( &cm->db, NULL );
3182         if ( rc == 0 ) {
3183                 cm->defer_db_open = 0;
3184         }
3185
3186         /* There is no runqueue in TOOL mode */
3187         if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
3188                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3189                 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
3190                         consistency_check, on,
3191                         "pcache_consistency", cm->db.be_suffix[0].bv_val );
3192                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3193
3194                 /* Cached database must have the rootdn */
3195                 if ( BER_BVISNULL( &cm->db.be_rootndn )
3196                                 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
3197                 {
3198                         Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
3199                                 "underlying database of type \"%s\"\n"
3200                                 "    serving naming context \"%s\"\n"
3201                                 "    has no \"rootdn\", required by \"proxycache\".\n",
3202                                 on->on_info->oi_orig->bi_type,
3203                                 cm->db.be_suffix[0].bv_val, 0 );
3204                         return 1;
3205                 }
3206
3207                 if ( cm->save_queries ) {
3208                         void            *thrctx = ldap_pvt_thread_pool_context();
3209                         Connection      conn = { 0 };
3210                         OperationBuffer opbuf;
3211                         Operation       *op;
3212                         slap_callback   cb = { 0 };
3213                         SlapReply       rs = { 0 };
3214                         BerVarray       vals = NULL;
3215                         Filter          f = { 0 }, f2 = { 0 };
3216                         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
3217                         AttributeName   attrs[ 2 ] = { 0 };
3218
3219                         connection_fake_init( &conn, &opbuf, thrctx );
3220                         op = &opbuf.ob_op;
3221
3222                         op->o_bd = &cm->db;
3223
3224                         op->o_tag = LDAP_REQ_SEARCH;
3225                         op->o_protocol = LDAP_VERSION3;
3226                         cb.sc_response = pcache_cachedquery_open_cb;
3227                         cb.sc_private = &vals;
3228                         op->o_callback = &cb;
3229                         op->o_time = slap_get_time();
3230                         op->o_do_not_cache = 1;
3231                         op->o_managedsait = SLAP_CONTROL_CRITICAL;
3232
3233                         op->o_dn = cm->db.be_rootdn;
3234                         op->o_ndn = cm->db.be_rootndn;
3235                         op->o_req_dn = cm->db.be_suffix[ 0 ];
3236                         op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
3237
3238                         op->ors_scope = LDAP_SCOPE_BASE;
3239                         op->ors_deref = LDAP_DEREF_NEVER;
3240                         op->ors_slimit = 1;
3241                         op->ors_tlimit = SLAP_NO_LIMIT;
3242                         ber_str2bv( "(cachedQueryURL=*)", 0, 0, &op->ors_filterstr );
3243                         f.f_choice = LDAP_FILTER_PRESENT;
3244                         f.f_desc = ad_cachedQueryURL;
3245                         op->ors_filter = &f;
3246                         attrs[ 0 ].an_desc = ad_cachedQueryURL;
3247                         attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
3248                         op->ors_attrs = attrs;
3249                         op->ors_attrsonly = 0;
3250
3251                         rc = op->o_bd->be_search( op, &rs );
3252                         if ( rc == LDAP_SUCCESS && vals != NULL ) {
3253                                 int     i;
3254
3255                                 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
3256                                         if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
3257                                                 cm->num_cached_queries++;
3258                                         }
3259                                 }
3260
3261                                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
3262                         }
3263
3264                         /* count cached entries */
3265                         f.f_choice = LDAP_FILTER_NOT;
3266                         f.f_not = &f2;
3267                         f2.f_choice = LDAP_FILTER_EQUALITY;
3268                         f2.f_ava = &ava;
3269                         f2.f_av_desc = slap_schema.si_ad_objectClass;
3270                         BER_BVSTR( &f2.f_av_value, "glue" );
3271                         ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
3272
3273                         op->ors_slimit = SLAP_NO_LIMIT;
3274                         op->ors_scope = LDAP_SCOPE_SUBTREE;
3275                         op->ors_attrs = slap_anlist_no_attrs;
3276
3277                         op->o_callback->sc_response = pcache_cachedquery_count_cb;
3278                         rs.sr_nentries = 0;
3279                         op->o_callback->sc_private = &rs.sr_nentries;
3280
3281                         rc = op->o_bd->be_search( op, &rs );
3282
3283                         cm->cur_entries = rs.sr_nentries;
3284
3285                         /* ignore errors */
3286                         rc = 0;
3287                 }
3288         }
3289         return rc;
3290 }
3291
3292 static int
3293 pcache_db_open(
3294         BackendDB *be,
3295         ConfigReply *cr )
3296 {
3297         slap_overinst   *on = (slap_overinst *)be->bd_info;
3298         cache_manager   *cm = on->on_bi.bi_private;
3299         query_manager*  qm = cm->qm;
3300         int             i, ncf = 0, rf = 0, nrf = 0, rc = 0;
3301
3302         /* check attr sets */
3303         for ( i = 0; i < cm->numattrsets; i++) {
3304                 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
3305                         if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
3306                                 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
3307                                 rf++;
3308
3309                         } else {
3310                                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
3311                         }
3312                         ncf++;
3313
3314                 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
3315                         Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
3316                         nrf++;
3317                 }
3318         }
3319
3320         if ( ncf || rf || nrf ) {
3321                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
3322                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
3323                 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
3324
3325                 if ( rf > 0 ) {
3326                         return 1;
3327                 }
3328         }
3329
3330         /* need to inherit something from the original database... */
3331         cm->db.be_def_limit = be->be_def_limit;
3332         cm->db.be_limits = be->be_limits;
3333         cm->db.be_acl = be->be_acl;
3334         cm->db.be_dfltaccess = be->be_dfltaccess;
3335
3336         if ( SLAP_DBMONITORING( be ) ) {
3337                 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
3338
3339         } else {
3340                 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
3341         }
3342
3343         if ( !cm->defer_db_open )
3344                 rc = pcache_db_open2( on, cr );
3345
3346         return rc;
3347 }
3348
3349 static void
3350 pcache_free_qbase( void *v )
3351 {
3352         Qbase *qb = v;
3353         int i;
3354
3355         for (i=0; i<3; i++)
3356                 tavl_free( qb->scopes[i], NULL );
3357         ch_free( qb );
3358 }
3359
3360 static int
3361 pcache_db_close(
3362         BackendDB *be,
3363         ConfigReply *cr
3364 )
3365 {
3366         slap_overinst *on = (slap_overinst *)be->bd_info;
3367         cache_manager *cm = on->on_bi.bi_private;
3368         query_manager *qm = cm->qm;
3369         QueryTemplate *tm;
3370         int i, rc = 0;
3371
3372         if ( cm->save_queries ) {
3373                 CachedQuery     *qc;
3374                 BerVarray       vals = NULL;
3375
3376                 void            *thrctx;
3377                 Connection      conn = { 0 };
3378                 OperationBuffer opbuf;
3379                 Operation       *op;
3380                 slap_callback   cb = { 0 };
3381
3382                 SlapReply       rs = { REP_RESULT };
3383                 Modifications   mod = { 0 };
3384
3385                 thrctx = ldap_pvt_thread_pool_context();
3386
3387                 connection_fake_init( &conn, &opbuf, thrctx );
3388                 op = &opbuf.ob_op;
3389
3390                 if ( qm->templates != NULL ) {
3391                         for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
3392                                 for ( qc = tm->query; qc; qc = qc->next ) {
3393                                         struct berval   bv;
3394
3395                                         if ( query2url( op, qc, &bv ) == 0 ) {
3396                                                 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
3397                                         }
3398                                 }
3399                         }
3400                 }
3401
3402                 op->o_bd = &cm->db;
3403                 op->o_dn = cm->db.be_rootdn;
3404                 op->o_ndn = cm->db.be_rootndn;
3405
3406                 op->o_tag = LDAP_REQ_MODIFY;
3407                 op->o_protocol = LDAP_VERSION3;
3408                 cb.sc_response = slap_null_cb;
3409                 op->o_callback = &cb;
3410                 op->o_time = slap_get_time();
3411                 op->o_do_not_cache = 1;
3412                 op->o_managedsait = SLAP_CONTROL_CRITICAL;
3413
3414                 op->o_req_dn = op->o_bd->be_suffix[0];
3415                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3416
3417                 mod.sml_op = LDAP_MOD_REPLACE;
3418                 mod.sml_flags = 0;
3419                 mod.sml_desc = ad_cachedQueryURL;
3420                 mod.sml_type = ad_cachedQueryURL->ad_cname;
3421                 mod.sml_values = vals;
3422                 mod.sml_nvalues = NULL;
3423                 mod.sml_numvals = 1;
3424                 mod.sml_next = NULL;
3425                 Debug( pcache_debug,
3426                         "%sSETTING CACHED QUERY URLS\n",
3427                         vals == NULL ? "RE" : "", 0, 0 );
3428
3429                 op->orm_modlist = &mod;
3430
3431                 op->o_bd->be_modify( op, &rs );
3432
3433                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
3434         }
3435
3436         /* cleanup stuff inherited from the original database... */
3437         cm->db.be_limits = NULL;
3438         cm->db.be_acl = NULL;
3439
3440         /* stop the thread ... */
3441         if ( cm->cc_arg ) {
3442                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3443                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
3444                         ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
3445                 }
3446                 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
3447                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3448         }
3449
3450         if ( cm->db.bd_info->bi_db_close ) {
3451                 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
3452         }
3453         while ( (tm = qm->templates) != NULL ) {
3454                 CachedQuery *qc, *qn;
3455                 qm->templates = tm->qmnext;
3456                 for ( qc = tm->query; qc; qc = qn ) {
3457                         qn = qc->next;
3458                         free_query( qc );
3459                 }
3460                 avl_free( tm->qbase, pcache_free_qbase );
3461                 free( tm->querystr.bv_val );
3462                 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
3463                 free( tm->t_attrs.attrs );
3464                 free( tm );
3465         }
3466
3467         for ( i=0; i<cm->numattrsets; i++ ) {
3468                 free( qm->attr_sets[i].attrs );
3469         }
3470         free( qm->attr_sets );
3471         qm->attr_sets = NULL;
3472
3473         return rc;
3474 }
3475
3476 static int
3477 pcache_db_destroy(
3478         BackendDB *be,
3479         ConfigReply *cr
3480 )
3481 {
3482         slap_overinst *on = (slap_overinst *)be->bd_info;
3483         cache_manager *cm = on->on_bi.bi_private;
3484         query_manager *qm = cm->qm;
3485
3486         if ( cm->db.be_private != NULL ) {
3487                 backend_stopdown_one( &cm->db );
3488         }
3489
3490         ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
3491         ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
3492         free( qm );
3493         free( cm );
3494
3495         return 0;
3496 }
3497
3498 #ifdef PCACHE_CONTROL_PRIVDB
3499 /*
3500         Control ::= SEQUENCE {
3501              controlType             LDAPOID,
3502              criticality             BOOLEAN DEFAULT FALSE,
3503              controlValue            OCTET STRING OPTIONAL }
3504
3505         controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
3506
3507  * criticality must be TRUE; controlValue must be absent.
3508  */
3509 static int
3510 parse_privdb_ctrl(
3511         Operation       *op,
3512         SlapReply       *rs,
3513         LDAPControl     *ctrl )
3514 {
3515         if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
3516                 rs->sr_text = "privateDB control specified multiple times";
3517                 return LDAP_PROTOCOL_ERROR;
3518         }
3519
3520         if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
3521                 rs->sr_text = "privateDB control value not absent";
3522                 return LDAP_PROTOCOL_ERROR;
3523         }
3524
3525         if ( !ctrl->ldctl_iscritical ) {
3526                 rs->sr_text = "privateDB control criticality required";
3527                 return LDAP_PROTOCOL_ERROR;
3528         }
3529
3530         op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
3531
3532         return LDAP_SUCCESS;
3533 }
3534
3535 static char *extops[] = {
3536         LDAP_EXOP_MODIFY_PASSWD,
3537         NULL
3538 };
3539 #endif /* PCACHE_CONTROL_PRIVDB */
3540
3541 #ifdef PCACHE_EXOP_QUERY_DELETE
3542 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
3543
3544 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
3545 #define LDAP_TAG_EXOP_QUERY_DELETE_DN   ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
3546 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
3547
3548 /*
3549         ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
3550              requestName      [0] LDAPOID,
3551              requestValue     [1] OCTET STRING OPTIONAL }
3552
3553         requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
3554
3555         requestValue ::= SEQUENCE { CHOICE {
3556                   baseDN           [0] LDAPDN
3557                   entryDN          [1] LDAPDN },
3558              queryID          [2] OCTET STRING (SIZE(16))
3559                   -- constrained to UUID }
3560
3561  * Either baseDN or entryDN must be present, to allow database selection.
3562  *
3563  * 1. if baseDN and queryID are present, then the query corresponding
3564  *    to queryID is deleted;
3565  * 2. if baseDN is present and queryID is absent, then all queries
3566  *    are deleted;
3567  * 3. if entryDN is present and queryID is absent, then all queries
3568  *    corresponding to the queryID values present in entryDN are deleted;
3569  * 4. if entryDN and queryID are present, then all queries
3570  *    corresponding to the queryID values present in entryDN are deleted,
3571  *    but only if the value of queryID is contained in the entry;
3572  *
3573  * Currently, only 1, 3 and 4 are implemented.  2 can be obtained by either
3574  * recursively deleting the database (ldapdelete -r) with PRIVDB control,
3575  * or by removing the database files.
3576
3577         ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
3578              COMPONENTS OF LDAPResult,
3579              responseName     [10] LDAPOID OPTIONAL,
3580              responseValue    [11] OCTET STRING OPTIONAL }
3581
3582  * responseName and responseValue must be absent.
3583  */
3584
3585 /*
3586  * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
3587  *   or LDAP_TAG_EXOP_QUERY_DELETE_DN.
3588  * - if ndn != NULL, it is set to the normalized DN in the request
3589  *   corresponding to either the baseDN or the entryDN, according
3590  *   to *tagp; memory is malloc'ed on the Operation's slab, and must
3591  *   be freed by the caller.
3592  * - if uuid != NULL, it is set to point to the normalized UUID;
3593  *   memory is malloc'ed on the Operation's slab, and must
3594  *   be freed by the caller.
3595  */
3596 static int
3597 pcache_parse_query_delete(
3598         struct berval   *in,
3599         ber_tag_t       *tagp,
3600         struct berval   *ndn,
3601         struct berval   *uuid,
3602         const char      **text,
3603         void            *ctx )
3604 {
3605         int                     rc = LDAP_SUCCESS;
3606         ber_tag_t               tag;
3607         ber_len_t               len = -1;
3608         BerElementBuffer        berbuf;
3609         BerElement              *ber = (BerElement *)&berbuf;
3610         struct berval           reqdata = BER_BVNULL;
3611
3612         *text = NULL;
3613
3614         if ( ndn ) {
3615                 BER_BVZERO( ndn );
3616         }
3617
3618         if ( uuid ) {
3619                 BER_BVZERO( uuid );
3620         }
3621
3622         if ( in == NULL || in->bv_len == 0 ) {
3623                 *text = "empty request data field in queryDelete exop";
3624                 return LDAP_PROTOCOL_ERROR;
3625         }
3626
3627         ber_dupbv_x( &reqdata, in, ctx );
3628
3629         /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
3630         ber_init2( ber, &reqdata, 0 );
3631
3632         tag = ber_scanf( ber, "{" /*}*/ );
3633
3634         if ( tag == LBER_ERROR ) {
3635                 Debug( LDAP_DEBUG_TRACE,
3636                         "pcache_parse_query_delete: decoding error.\n",
3637                         0, 0, 0 );
3638                 goto decoding_error;
3639         }
3640
3641         tag = ber_peek_tag( ber, &len );
3642         if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
3643                 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
3644         {
3645                 *tagp = tag;
3646
3647                 if ( ndn != NULL ) {
3648                         struct berval   dn;
3649
3650                         tag = ber_scanf( ber, "m", &dn );
3651                         if ( tag == LBER_ERROR ) {
3652                                 Debug( LDAP_DEBUG_TRACE,
3653                                         "pcache_parse_query_delete: DN parse failed.\n",
3654                                         0, 0, 0 );
3655                                 goto decoding_error;
3656                         }
3657
3658                         rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
3659                         if ( rc != LDAP_SUCCESS ) {
3660                                 *text = "invalid DN in queryDelete exop request data";
3661                                 goto done;
3662                         }
3663
3664                 } else {
3665                         tag = ber_scanf( ber, "x" /* "m" */ );
3666                         if ( tag == LBER_DEFAULT ) {
3667                                 goto decoding_error;
3668                         }
3669                 }
3670
3671                 tag = ber_peek_tag( ber, &len );
3672         }
3673
3674         if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
3675                 if ( uuid != NULL ) {
3676                         struct berval   bv;
3677                         char            uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
3678
3679                         tag = ber_scanf( ber, "m", &bv );
3680                         if ( tag == LBER_ERROR ) {
3681                                 Debug( LDAP_DEBUG_TRACE,
3682                                         "pcache_parse_query_delete: UUID parse failed.\n",
3683                                         0, 0, 0 );
3684                                 goto decoding_error;
3685                         }
3686
3687                         if ( bv.bv_len != 16 ) {
3688                                 Debug( LDAP_DEBUG_TRACE,
3689                                         "pcache_parse_query_delete: invalid UUID length %lu.\n",
3690                                         (unsigned long)bv.bv_len, 0, 0 );
3691                                 goto decoding_error;
3692                         }
3693
3694                         rc = lutil_uuidstr_from_normalized(
3695                                 bv.bv_val, bv.bv_len,
3696                                 uuidbuf, sizeof( uuidbuf ) );
3697                         if ( rc == -1 ) {
3698                                 goto decoding_error;
3699                         }
3700                         ber_str2bv( uuidbuf, rc, 1, uuid );
3701                         rc = LDAP_SUCCESS;
3702
3703                 } else {
3704                         tag = ber_skip_tag( ber, &len );
3705                         if ( tag == LBER_DEFAULT ) {
3706                                 goto decoding_error;
3707                         }
3708
3709                         if ( len != 16 ) {
3710                                 Debug( LDAP_DEBUG_TRACE,
3711                                         "pcache_parse_query_delete: invalid UUID length %lu.\n",
3712                                         (unsigned long)len, 0, 0 );
3713                                 goto decoding_error;
3714                         }
3715                 }
3716
3717                 tag = ber_peek_tag( ber, &len );
3718         }
3719
3720         if ( tag != LBER_DEFAULT || len != 0 ) {
3721 decoding_error:;
3722                 Debug( LDAP_DEBUG_TRACE,
3723                         "pcache_parse_query_delete: decoding error\n",
3724                         0, 0, 0 );
3725                 rc = LDAP_PROTOCOL_ERROR;
3726                 *text = "queryDelete data decoding error";
3727
3728 done:;
3729                 if ( ndn && !BER_BVISNULL( ndn ) ) {
3730                         slap_sl_free( ndn->bv_val, ctx );
3731                         BER_BVZERO( ndn );
3732                 }
3733
3734                 if ( uuid && !BER_BVISNULL( uuid ) ) {
3735                         slap_sl_free( uuid->bv_val, ctx );
3736                         BER_BVZERO( uuid );
3737                 }
3738         }
3739
3740         if ( !BER_BVISNULL( &reqdata ) ) {
3741                 ber_memfree_x( reqdata.bv_val, ctx );
3742         }
3743
3744         return rc;
3745 }
3746
3747 static int
3748 pcache_exop_query_delete(
3749         Operation       *op,
3750         SlapReply       *rs )
3751 {
3752         BackendDB       *bd = op->o_bd;
3753
3754         struct berval   uuid = BER_BVNULL,
3755                         *uuidp = NULL;
3756         char            buf[ SLAP_TEXT_BUFLEN ] = { '\0' };
3757         int             len = 0;
3758         ber_tag_t       tag = LBER_DEFAULT;
3759
3760         if ( LogTest( LDAP_DEBUG_STATS ) ) {
3761                 uuidp = &uuid;
3762         }
3763
3764         rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
3765                 &tag, &op->o_req_ndn, uuidp,
3766                 &rs->sr_text, op->o_tmpmemctx );
3767         if ( rs->sr_err != LDAP_SUCCESS ) {
3768                 return rs->sr_err;
3769         }
3770
3771         if ( LogTest( LDAP_DEBUG_STATS ) ) {
3772                 assert( !BER_BVISNULL( &op->o_req_ndn ) );
3773                 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
3774
3775                 if ( !BER_BVISNULL( &uuid ) ) {
3776                         snprintf( &buf[ len ], sizeof( buf ) - len, " queryId=\"%s\"", uuid.bv_val );
3777                 }
3778
3779                 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
3780                         op->o_log_prefix, buf, 0 );
3781         }
3782         op->o_req_dn = op->o_req_ndn;
3783
3784         op->o_bd = select_backend( &op->o_req_ndn, 0 );
3785         rs->sr_err = backend_check_restrictions( op, rs,
3786                 (struct berval *)&pcache_exop_QUERY_DELETE );
3787         if ( rs->sr_err != LDAP_SUCCESS ) {
3788                 goto done;
3789         }
3790
3791         if ( op->o_bd->be_extended == NULL ) {
3792                 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
3793                         "backend does not support extended operations" );
3794                 goto done;
3795         }
3796
3797         op->o_bd->be_extended( op, rs );
3798
3799 done:;
3800         if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
3801                 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
3802                 BER_BVZERO( &op->o_req_ndn );
3803                 BER_BVZERO( &op->o_req_dn );
3804         }
3805
3806         if ( !BER_BVISNULL( &uuid ) ) {
3807                 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
3808         }
3809
3810         op->o_bd = bd;
3811
3812         return rs->sr_err;
3813 }
3814
3815 static int
3816 pcache_op_extended( Operation *op, SlapReply *rs )
3817 {
3818         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
3819         cache_manager   *cm = on->on_bi.bi_private;
3820
3821 #ifdef PCACHE_CONTROL_PRIVDB
3822         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
3823                 return pcache_op_privdb( op, rs );
3824         }
3825 #endif /* PCACHE_CONTROL_PRIVDB */
3826
3827         if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
3828                 struct berval   uuid = BER_BVNULL;
3829                 ber_tag_t       tag = LBER_DEFAULT;
3830
3831                 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
3832                         &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
3833                 assert( rs->sr_err == LDAP_SUCCESS );
3834
3835                 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
3836                         /* remove all queries related to the selected entry */
3837                         rs->sr_err = pcache_remove_entry_queries_from_cache( op,
3838                                 cm, &op->o_req_ndn, &uuid );
3839
3840                 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
3841                         if ( !BER_BVISNULL( &uuid ) ) {
3842                                 /* remove the selected query */
3843                                 rs->sr_err = pcache_remove_query_from_cache( op,
3844                                         cm, &uuid );
3845
3846                         } else {
3847                                 /* TODO: remove all queries */
3848                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
3849                                 rs->sr_text = "deletion of all queries not implemented";
3850                         }
3851                 }
3852
3853                 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
3854         }
3855
3856         return rs->sr_err;
3857 }
3858 #endif /* PCACHE_EXOP_QUERY_DELETE */
3859
3860 static slap_overinst pcache;
3861
3862 static char *obsolete_names[] = {
3863         "proxycache",
3864         NULL
3865 };
3866
3867 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
3868 static
3869 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
3870 int
3871 pcache_initialize()
3872 {
3873         int i, code;
3874         struct berval debugbv = BER_BVC("pcache");
3875
3876         code = slap_loglevel_get( &debugbv, &pcache_debug );
3877         if ( code ) {
3878                 return code;
3879         }
3880
3881 #ifdef PCACHE_CONTROL_PRIVDB
3882         code = register_supported_control( PCACHE_CONTROL_PRIVDB,
3883                 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
3884                 parse_privdb_ctrl, &privDB_cid );
3885         if ( code != LDAP_SUCCESS ) {
3886                 Debug( LDAP_DEBUG_ANY,
3887                         "pcache_initialize: failed to register control %s (%d)\n",
3888                         PCACHE_CONTROL_PRIVDB, code, 0 );
3889                 return code;
3890         }
3891 #endif /* PCACHE_CONTROL_PRIVDB */
3892
3893 #ifdef PCACHE_EXOP_QUERY_DELETE
3894         code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
3895                 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
3896                 0 );
3897         if ( code != LDAP_SUCCESS ) {
3898                 Debug( LDAP_DEBUG_ANY,
3899                         "pcache_initialize: unable to register queryDelete exop: %d.\n",
3900                         code, 0, 0 );
3901                 return code;
3902         }
3903 #endif /* PCACHE_EXOP_QUERY_DELETE */
3904
3905         for ( i = 0; as[i].desc != NULL; i++ ) {
3906                 code = register_at( as[i].desc, as[i].adp, 0 );
3907                 if ( code ) {
3908                         Debug( LDAP_DEBUG_ANY,
3909                                 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
3910                         return code;
3911                 }
3912                 (*as[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
3913         }
3914
3915         pcache.on_bi.bi_type = "pcache";
3916         pcache.on_bi.bi_obsolete_names = obsolete_names;
3917         pcache.on_bi.bi_db_init = pcache_db_init;
3918         pcache.on_bi.bi_db_config = pcache_db_config;
3919         pcache.on_bi.bi_db_open = pcache_db_open;
3920         pcache.on_bi.bi_db_close = pcache_db_close;
3921         pcache.on_bi.bi_db_destroy = pcache_db_destroy;
3922
3923         pcache.on_bi.bi_op_search = pcache_op_search;
3924 #ifdef PCACHE_CONTROL_PRIVDB
3925         pcache.on_bi.bi_op_bind = pcache_op_privdb;
3926         pcache.on_bi.bi_op_compare = pcache_op_privdb;
3927         pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
3928         pcache.on_bi.bi_op_modify = pcache_op_privdb;
3929         pcache.on_bi.bi_op_add = pcache_op_privdb;
3930         pcache.on_bi.bi_op_delete = pcache_op_privdb;
3931 #endif /* PCACHE_CONTROL_PRIVDB */
3932 #ifdef PCACHE_EXOP_QUERY_DELETE
3933         pcache.on_bi.bi_extended = pcache_op_extended;
3934 #elif defined( PCACHE_CONTROL_PRIVDB )
3935         pcache.on_bi.bi_extended = pcache_op_privdb;
3936 #endif
3937
3938         pcache.on_bi.bi_chk_controls = pcache_chk_controls;
3939
3940         pcache.on_bi.bi_cf_ocs = pcocs;
3941
3942         code = config_register_schema( pccfg, pcocs );
3943         if ( code ) return code;
3944
3945         {
3946                 const char *text;
3947                 code = slap_str2ad( "olcDatabase", &pcdummy[0].ad, &text );
3948                 if ( code ) return code;
3949         }
3950         return overlay_register( &pcache );
3951 }
3952
3953 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
3954 int init_module(int argc, char *argv[]) {
3955         return pcache_initialize();
3956 }
3957 #endif
3958
3959 #endif  /* defined(SLAPD_OVER_PROXYCACHE) */