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-2014 The OpenLDAP Foundation.
   5  * Portions Copyright 2003 IBM Corporation.
   6  * Portions Copyright 2003-2009 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 "../back-monitor/back-monitor.h"
  37
  38 #include "config.h"
  39
  40 #ifdef LDAP_DEVEL
  41 /*
  42  * Control that allows to access the private DB
  43  * instead of the public one
  44  */
  45 #define PCACHE_CONTROL_PRIVDB           "1.3.6.1.4.1.4203.666.11.9.5.1"
  46
  47 /*
  48  * Extended Operation that allows to remove a query from the cache
  49  */
  50 #define PCACHE_EXOP_QUERY_DELETE        "1.3.6.1.4.1.4203.666.11.9.6.1"
  51
  52 /*
  53  * Monitoring
  54  */
  55 #define PCACHE_MONITOR
  56 #endif
  57
  58 /* query cache structs */
  59 /* query */
  60
  61 typedef struct Query_s {
  62         Filter*         filter;         /* Search Filter */
  63         struct berval   base;           /* Search Base */
  64         int             scope;          /* Search scope */
  65 } Query;
  66
  67 struct query_template_s;
  68
  69 typedef struct Qbase_s {
  70         Avlnode *scopes[4];             /* threaded AVL trees of cached queries */
  71         struct berval base;
  72         int queries;
  73 } Qbase;
  74
  75 /* struct representing a cached query */
  76 typedef struct cached_query_s {
  77         Filter                                  *filter;
  78         Filter                                  *first;
  79         Qbase                                   *qbase;
  80         int                                             scope;
  81         struct berval                   q_uuid;         /* query identifier */
  82         int                                             q_sizelimit;
  83         struct query_template_s         *qtemp; /* template of the query */
  84         time_t                                          expiry_time;    /* time till the query is considered invalid */
  85         time_t                                          refresh_time;   /* time till the query is refreshed */
  86         time_t                                          bindref_time;   /* time till the bind is refreshed */
  87         int                                             bind_refcnt;    /* number of bind operation referencing this query */
  88         unsigned long                   answerable_cnt; /* how many times it was answerable */
  89         int                                             refcnt; /* references since last refresh */
  90         ldap_pvt_thread_mutex_t         answerable_cnt_mutex;
  91         struct cached_query_s           *next;          /* next query in the template */
  92         struct cached_query_s           *prev;          /* previous query in the template */
  93         struct cached_query_s           *lru_up;        /* previous query in the LRU list */
  94         struct cached_query_s           *lru_down;      /* next query in the LRU list */
  95         ldap_pvt_thread_rdwr_t          rwlock;
  96 } CachedQuery;
  97
  98 /*
  99  * URL representation:
 100  *
 101  * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>,x-refresh=<refresh>
 102  *
 103  * <base> ::= CachedQuery.qbase->base
 104  * <scope> ::= CachedQuery.scope
 105  * <filter> ::= filter2bv(CachedQuery.filter)
 106  * <uuid> ::= CachedQuery.q_uuid
 107  * <attrset> ::= CachedQuery.qtemp->attr_set_index
 108  * <expiry> ::= CachedQuery.expiry_time
 109  * <refresh> ::= CachedQuery.refresh_time
 110  *
 111  * quick hack: parse URI, call add_query() and then fix
 112  * CachedQuery.expiry_time and CachedQuery.q_uuid
 113  *
 114  * NOTE: if the <attrset> changes, all stored URLs will be invalidated.
 115  */
 116
 117 /*
 118  * Represents a set of projected attributes.
 119  */
 120
 121 struct attr_set {
 122         struct query_template_s *templates;
 123         AttributeName*  attrs;          /* specifies the set */
 124         unsigned        flags;
 125 #define PC_CONFIGURED   (0x1)
 126 #define PC_REFERENCED   (0x2)
 127 #define PC_GOT_OC               (0x4)
 128         int             count;          /* number of attributes */
 129 };
 130
 131 /* struct representing a query template
 132  * e.g. template string = &(cn=)(mail=)
 133  */
 134 typedef struct query_template_s {
 135         struct query_template_s *qtnext;
 136         struct query_template_s *qmnext;
 137
 138         Avlnode*                qbase;
 139         CachedQuery*    query;          /* most recent query cached for the template */
 140         CachedQuery*    query_last;     /* oldest query cached for the template */
 141         ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
 142         struct berval   querystr;       /* Filter string corresponding to the QT */
 143         struct berval   bindbase;       /* base DN for Bind request */
 144         struct berval   bindfilterstr;  /* Filter string for Bind request */
 145         struct berval   bindftemp;      /* bind filter template */
 146         Filter          *bindfilter;
 147         AttributeDescription **bindfattrs;      /* attrs to substitute in ftemp */
 148
 149         int                     bindnattrs;             /* number of bindfattrs */
 150         int                     bindscope;
 151         int             attr_set_index; /* determines the projected attributes */
 152         int             no_of_queries;  /* Total number of queries in the template */
 153         time_t          ttl;            /* TTL for the queries of this template */
 154         time_t          negttl;         /* TTL for negative results */
 155         time_t          limitttl;       /* TTL for sizelimit exceeding results */
 156         time_t          ttr;    /* time to refresh */
 157         time_t          bindttr;        /* TTR for cached binds */
 158         struct attr_set t_attrs;        /* filter attrs + attr_set */
 159 } QueryTemplate;
 160
 161 typedef enum {
 162         PC_IGNORE = 0,
 163         PC_POSITIVE,
 164         PC_NEGATIVE,
 165         PC_SIZELIMIT
 166 } pc_caching_reason_t;
 167
 168 static const char *pc_caching_reason_str[] = {
 169         "IGNORE",
 170         "POSITIVE",
 171         "NEGATIVE",
 172         "SIZELIMIT",
 173
 174         NULL
 175 };
 176
 177 struct query_manager_s;
 178
 179 /* prototypes for functions for 1) query containment
 180  * 2) query addition, 3) cache replacement
 181  */
 182 typedef CachedQuery *(QCfunc)(Operation *op, struct query_manager_s*,
 183         Query*, QueryTemplate*);
 184 typedef CachedQuery *(AddQueryfunc)(Operation *op, struct query_manager_s*,
 185         Query*, QueryTemplate*, pc_caching_reason_t, int wlock);
 186 typedef void (CRfunc)(struct query_manager_s*, struct berval*);
 187
 188 /* LDAP query cache */
 189 typedef struct query_manager_s {
 190         struct attr_set*        attr_sets;              /* possible sets of projected attributes */
 191         QueryTemplate*          templates;              /* cacheable templates */
 192
 193         CachedQuery*            lru_top;                /* top and bottom of LRU list */
 194         CachedQuery*            lru_bottom;
 195
 196         ldap_pvt_thread_mutex_t         lru_mutex;      /* mutex for accessing LRU list */
 197
 198         /* Query cache methods */
 199         QCfunc                  *qcfunc;                        /* Query containment*/
 200         CRfunc                  *crfunc;                        /* cache replacement */
 201         AddQueryfunc    *addfunc;                       /* add query */
 202 } query_manager;
 203
 204 /* LDAP query cache manager */
 205 typedef struct cache_manager_s {
 206         BackendDB       db;     /* underlying database */
 207         unsigned long   num_cached_queries;             /* total number of cached queries */
 208         unsigned long   max_queries;                    /* upper bound on # of cached queries */
 209         int             save_queries;                   /* save cached queries across restarts */
 210         int     check_cacheability;             /* check whether a query is cacheable */
 211         int     numattrsets;                    /* number of attribute sets */
 212         int     cur_entries;                    /* current number of entries cached */
 213         int     max_entries;                    /* max number of entries cached */
 214         int     num_entries_limit;              /* max # of entries in a cacheable query */
 215
 216         char    response_cb;                    /* install the response callback
 217                                                  * at the tail of the callback list */
 218 #define PCACHE_RESPONSE_CB_HEAD 0
 219 #define PCACHE_RESPONSE_CB_TAIL 1
 220         char    defer_db_open;                  /* defer open for online add */
 221         char    cache_binds;                    /* cache binds or just passthru */
 222
 223         time_t  cc_period;              /* interval between successive consistency checks (sec) */
 224 #define PCACHE_CC_PAUSED        1
 225 #define PCACHE_CC_OFFLINE       2
 226         int     cc_paused;
 227         void    *cc_arg;
 228
 229         ldap_pvt_thread_mutex_t         cache_mutex;
 230
 231         query_manager*   qm;    /* query cache managed by the cache manager */
 232
 233 #ifdef PCACHE_MONITOR
 234         void            *monitor_cb;
 235         struct berval   monitor_ndn;
 236 #endif /* PCACHE_MONITOR */
 237 } cache_manager;
 238
 239 #ifdef PCACHE_MONITOR
 240 static int pcache_monitor_db_init( BackendDB *be );
 241 static int pcache_monitor_db_open( BackendDB *be );
 242 static int pcache_monitor_db_close( BackendDB *be );
 243 static int pcache_monitor_db_destroy( BackendDB *be );
 244 #endif /* PCACHE_MONITOR */
 245
 246 static int pcache_debug;
 247
 248 #ifdef PCACHE_CONTROL_PRIVDB
 249 static int privDB_cid;
 250 #endif /* PCACHE_CONTROL_PRIVDB */
 251
 252 static AttributeDescription     *ad_queryId, *ad_cachedQueryURL;
 253
 254 #ifdef PCACHE_MONITOR
 255 static AttributeDescription     *ad_numQueries, *ad_numEntries;
 256 static ObjectClass              *oc_olmPCache;
 257 #endif /* PCACHE_MONITOR */
 258
 259 static struct {
 260         char                    *name;
 261         char                    *oid;
 262 }               s_oid[] = {
 263         { "PCacheOID",                  "1.3.6.1.4.1.4203.666.11.9.1" },
 264         { "PCacheAttributes",           "PCacheOID:1" },
 265         { "PCacheObjectClasses",        "PCacheOID:2" },
 266
 267         { NULL }
 268 };
 269
 270 static struct {
 271         char    *desc;
 272         AttributeDescription **adp;
 273 } s_ad[] = {
 274         { "( PCacheAttributes:1 "
 275                 "NAME 'pcacheQueryID' "
 276                 "DESC 'ID of query the entry belongs to, formatted as a UUID' "
 277                 "EQUALITY octetStringMatch "
 278                 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
 279                 "NO-USER-MODIFICATION "
 280                 "USAGE directoryOperation )",
 281                 &ad_queryId },
 282         { "( PCacheAttributes:2 "
 283                 "NAME 'pcacheQueryURL' "
 284                 "DESC 'URI describing a cached query' "
 285                 "EQUALITY caseExactMatch "
 286                 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
 287                 "NO-USER-MODIFICATION "
 288                 "USAGE directoryOperation )",
 289                 &ad_cachedQueryURL },
 290 #ifdef PCACHE_MONITOR
 291         { "( PCacheAttributes:3 "
 292                 "NAME 'pcacheNumQueries' "
 293                 "DESC 'Number of cached queries' "
 294                 "EQUALITY integerMatch "
 295                 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
 296                 "NO-USER-MODIFICATION "
 297                 "USAGE directoryOperation )",
 298                 &ad_numQueries },
 299         { "( PCacheAttributes:4 "
 300                 "NAME 'pcacheNumEntries' "
 301                 "DESC 'Number of cached entries' "
 302                 "EQUALITY integerMatch "
 303                 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
 304                 "NO-USER-MODIFICATION "
 305                 "USAGE directoryOperation )",
 306                 &ad_numEntries },
 307 #endif /* PCACHE_MONITOR */
 308
 309         { NULL }
 310 };
 311
 312 static struct {
 313         char            *desc;
 314         ObjectClass     **ocp;
 315 }               s_oc[] = {
 316 #ifdef PCACHE_MONITOR
 317         /* augments an existing object, so it must be AUXILIARY */
 318         { "( PCacheObjectClasses:1 "
 319                 "NAME ( 'olmPCache' ) "
 320                 "SUP top AUXILIARY "
 321                 "MAY ( "
 322                         "pcacheQueryURL "
 323                         "$ pcacheNumQueries "
 324                         "$ pcacheNumEntries "
 325                         " ) )",
 326                 &oc_olmPCache },
 327 #endif /* PCACHE_MONITOR */
 328
 329         { NULL }
 330 };
 331
 332 static int
 333 filter2template(
 334         Operation               *op,
 335         Filter                  *f,
 336         struct                  berval *fstr );
 337
 338 static CachedQuery *
 339 add_query(
 340         Operation *op,
 341         query_manager* qm,
 342         Query* query,
 343         QueryTemplate *templ,
 344         pc_caching_reason_t why,
 345         int wlock);
 346
 347 static int
 348 remove_query_data(
 349         Operation       *op,
 350         struct berval   *query_uuid );
 351
 352 /*
 353  * Turn a cached query into its URL representation
 354  */
 355 static int
 356 query2url( Operation *op, CachedQuery *q, struct berval *urlbv, int dolock )
 357 {
 358         struct berval   bv_scope,
 359                         bv_filter;
 360         char            attrset_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
 361                         expiry_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
 362                         refresh_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
 363                         answerable_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
 364                         *ptr;
 365         ber_len_t       attrset_len,
 366                         expiry_len,
 367                         refresh_len,
 368                         answerable_len;
 369
 370         if ( dolock ) {
 371                 ldap_pvt_thread_rdwr_rlock( &q->rwlock );
 372         }
 373
 374         ldap_pvt_scope2bv( q->scope, &bv_scope );
 375         filter2bv_x( op, q->filter, &bv_filter );
 376         attrset_len = sprintf( attrset_buf,
 377                 "%lu", (unsigned long)q->qtemp->attr_set_index );
 378         expiry_len = sprintf( expiry_buf,
 379                 "%lu", (unsigned long)q->expiry_time );
 380         answerable_len = snprintf( answerable_buf, sizeof( answerable_buf ),
 381                 "%lu", q->answerable_cnt );
 382         if ( q->refresh_time )
 383                 refresh_len = sprintf( refresh_buf,
 384                         "%lu", (unsigned long)q->refresh_time );
 385         else
 386                 refresh_len = 0;
 387
 388         urlbv->bv_len = STRLENOF( "ldap:///" )
 389                 + q->qbase->base.bv_len
 390                 + STRLENOF( "??" )
 391                 + bv_scope.bv_len
 392                 + STRLENOF( "?" )
 393                 + bv_filter.bv_len
 394                 + STRLENOF( "?x-uuid=" )
 395                 + q->q_uuid.bv_len
 396                 + STRLENOF( ",x-attrset=" )
 397                 + attrset_len
 398                 + STRLENOF( ",x-expiry=" )
 399                 + expiry_len
 400                 + STRLENOF( ",x-answerable=" )
 401                 + answerable_len;
 402         if ( refresh_len )
 403                 urlbv->bv_len += STRLENOF( ",x-refresh=" )
 404                 + refresh_len;
 405
 406         ptr = urlbv->bv_val = ber_memalloc_x( urlbv->bv_len + 1, op->o_tmpmemctx );
 407         ptr = lutil_strcopy( ptr, "ldap:///" );
 408         ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
 409         ptr = lutil_strcopy( ptr, "??" );
 410         ptr = lutil_strcopy( ptr, bv_scope.bv_val );
 411         ptr = lutil_strcopy( ptr, "?" );
 412         ptr = lutil_strcopy( ptr, bv_filter.bv_val );
 413         ptr = lutil_strcopy( ptr, "?x-uuid=" );
 414         ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
 415         ptr = lutil_strcopy( ptr, ",x-attrset=" );
 416         ptr = lutil_strcopy( ptr, attrset_buf );
 417         ptr = lutil_strcopy( ptr, ",x-expiry=" );
 418         ptr = lutil_strcopy( ptr, expiry_buf );
 419         ptr = lutil_strcopy( ptr, ",x-answerable=" );
 420         ptr = lutil_strcopy( ptr, answerable_buf );
 421         if ( refresh_len ) {
 422                 ptr = lutil_strcopy( ptr, ",x-refresh=" );
 423                 ptr = lutil_strcopy( ptr, refresh_buf );
 424         }
 425
 426         ber_memfree_x( bv_filter.bv_val, op->o_tmpmemctx );
 427
 428         if ( dolock ) {
 429                 ldap_pvt_thread_rdwr_runlock( &q->rwlock );
 430         }
 431
 432         return 0;
 433 }
 434
 435 /* Find and record the empty filter clauses */
 436
 437 static int
 438 ftemp_attrs( struct berval *ftemp, struct berval *template,
 439         AttributeDescription ***ret, const char **text )
 440 {
 441         int i;
 442         int attr_cnt=0;
 443         struct berval bv;
 444         char *p1, *p2, *t1;
 445         AttributeDescription *ad;
 446         AttributeDescription **descs = NULL;
 447         char *temp2;
 448
 449         temp2 = ch_malloc( ftemp->bv_len + 1 );
 450         p1 = ftemp->bv_val;
 451         t1 = temp2;
 452
 453         *ret = NULL;
 454
 455         for (;;) {
 456                 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' )
 457                         *t1++ = *p1++;
 458
 459                 p2 = strchr( p1, '=' );
 460                 if ( !p2 )
 461                         break;
 462                 i = p2 - p1;
 463                 AC_MEMCPY( t1, p1, i );
 464                 t1 += i;
 465                 *t1++ = '=';
 466
 467                 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
 468                 bv.bv_val = p1;
 469                 bv.bv_len = p2 - p1;
 470                 ad = NULL;
 471                 i = slap_bv2ad( &bv, &ad, text );
 472                 if ( i ) {
 473                         ch_free( descs );
 474                         return -1;
 475                 }
 476                 if ( *p2 == '<' || *p2 == '>' ) p2++;
 477                 if ( p2[1] != ')' ) {
 478                         p2++;
 479                         while ( *p2 != ')' ) p2++;
 480                         p1 = p2;
 481                         continue;
 482                 }
 483
 484                 descs = (AttributeDescription **)ch_realloc(descs,
 485                                 (attr_cnt + 2)*sizeof(AttributeDescription *));
 486
 487                 descs[attr_cnt++] = ad;
 488
 489                 p1 = p2+1;
 490         }
 491         *t1 = '\0';
 492         descs[attr_cnt] = NULL;
 493         *ret = descs;
 494         template->bv_val = temp2;
 495         template->bv_len = t1 - temp2;
 496         return attr_cnt;
 497 }
 498
 499 static int
 500 template_attrs( char *template, struct attr_set *set, AttributeName **ret,
 501         const char **text )
 502 {
 503         int got_oc = 0;
 504         int alluser = 0;
 505         int allop = 0;
 506         int i;
 507         int attr_cnt;
 508         int t_cnt = 0;
 509         struct berval bv;
 510         char *p1, *p2;
 511         AttributeDescription *ad;
 512         AttributeName *attrs;
 513
 514         p1 = template;
 515
 516         *ret = NULL;
 517
 518         attrs = ch_calloc( set->count + 1, sizeof(AttributeName) );
 519         for ( i=0; i < set->count; i++ )
 520                 attrs[i] = set->attrs[i];
 521         attr_cnt = i;
 522         alluser = an_find( attrs, slap_bv_all_user_attrs );
 523         allop = an_find( attrs, slap_bv_all_operational_attrs );
 524
 525         for (;;) {
 526                 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' ) p1++;
 527                 p2 = strchr( p1, '=' );
 528                 if ( !p2 )
 529                         break;
 530                 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
 531                 bv.bv_val = p1;
 532                 bv.bv_len = p2 - p1;
 533                 ad = NULL;
 534                 i = slap_bv2ad( &bv, &ad, text );
 535                 if ( i ) {
 536                         ch_free( attrs );
 537                         return -1;
 538                 }
 539                 t_cnt++;
 540
 541                 if ( ad == slap_schema.si_ad_objectClass )
 542                         got_oc = 1;
 543
 544                 if ( is_at_operational(ad->ad_type)) {
 545                         if ( allop ) {
 546                                 goto bottom;
 547                         }
 548                 } else if ( alluser ) {
 549                         goto bottom;
 550                 }
 551                 if ( !ad_inlist( ad, attrs )) {
 552                         attrs = (AttributeName *)ch_realloc(attrs,
 553                                         (attr_cnt + 2)*sizeof(AttributeName));
 554
 555                         attrs[attr_cnt].an_desc = ad;
 556                         attrs[attr_cnt].an_name = ad->ad_cname;
 557                         attrs[attr_cnt].an_oc = NULL;
 558                         attrs[attr_cnt].an_flags = 0;
 559                         BER_BVZERO( &attrs[attr_cnt+1].an_name );
 560                         attr_cnt++;
 561                 }
 562
 563 bottom:
 564                 p1 = p2+2;
 565         }
 566         if ( !t_cnt ) {
 567                 *text = "couldn't parse template";
 568                 return -1;
 569         }
 570         if ( !got_oc && !( set->flags & PC_GOT_OC )) {
 571                 attrs = (AttributeName *)ch_realloc(attrs,
 572                                 (attr_cnt + 2)*sizeof(AttributeName));
 573
 574                 ad = slap_schema.si_ad_objectClass;
 575                 attrs[attr_cnt].an_desc = ad;
 576                 attrs[attr_cnt].an_name = ad->ad_cname;
 577                 attrs[attr_cnt].an_oc = NULL;
 578                 attrs[attr_cnt].an_flags = 0;
 579                 BER_BVZERO( &attrs[attr_cnt+1].an_name );
 580                 attr_cnt++;
 581         }
 582         *ret = attrs;
 583         return attr_cnt;
 584 }
 585
 586 /*
 587  * Turn an URL representing a formerly cached query into a cached query,
 588  * and try to cache it
 589  */
 590 static int
 591 url2query(
 592         char            *url,
 593         Operation       *op,
 594         query_manager   *qm )
 595 {
 596         Query           query = { 0 };
 597         QueryTemplate   *qt;
 598         CachedQuery     *cq;
 599         LDAPURLDesc     *lud = NULL;
 600         struct berval   base,
 601                         tempstr = BER_BVNULL,
 602                         uuid = BER_BVNULL;
 603         int             attrset;
 604         time_t          expiry_time;
 605         time_t          refresh_time;
 606         unsigned long   answerable_cnt;
 607         int             i,
 608                         got = 0,
 609 #define GOT_UUID        0x1U
 610 #define GOT_ATTRSET     0x2U
 611 #define GOT_EXPIRY      0x4U
 612 #define GOT_ANSWERABLE  0x8U
 613 #define GOT_REFRESH     0x10U
 614 #define GOT_ALL         (GOT_UUID|GOT_ATTRSET|GOT_EXPIRY|GOT_ANSWERABLE)
 615                         rc = 0;
 616
 617         rc = ldap_url_parse( url, &lud );
 618         if ( rc != LDAP_URL_SUCCESS ) {
 619                 return -1;
 620         }
 621
 622         /* non-allowed fields */
 623         if ( lud->lud_host != NULL ) {
 624                 rc = 1;
 625                 goto error;
 626         }
 627
 628         if ( lud->lud_attrs != NULL ) {
 629                 rc = 1;
 630                 goto error;
 631         }
 632
 633         /* be pedantic */
 634         if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
 635                 rc = 1;
 636                 goto error;
 637         }
 638
 639         /* required fields */
 640         if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
 641                 rc = 1;
 642                 goto error;
 643         }
 644
 645         switch ( lud->lud_scope ) {
 646         case LDAP_SCOPE_BASE:
 647         case LDAP_SCOPE_ONELEVEL:
 648         case LDAP_SCOPE_SUBTREE:
 649         case LDAP_SCOPE_SUBORDINATE:
 650                 break;
 651
 652         default:
 653                 rc = 1;
 654                 goto error;
 655         }
 656
 657         if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
 658                 rc = 1;
 659                 goto error;
 660         }
 661
 662         if ( lud->lud_exts == NULL ) {
 663                 rc = 1;
 664                 goto error;
 665         }
 666
 667         for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
 668                 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
 669                         struct berval   tmpUUID;
 670                         Syntax          *syn_UUID = slap_schema.si_ad_entryUUID->ad_type->sat_syntax;
 671
 672                         if ( got & GOT_UUID ) {
 673                                 rc = 1;
 674                                 goto error;
 675                         }
 676
 677                         ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &tmpUUID );
 678                         if ( !BER_BVISEMPTY( &tmpUUID ) ) {
 679                                 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
 680                                 if ( rc != LDAP_SUCCESS ) {
 681                                         goto error;
 682                                 }
 683                         }
 684                         got |= GOT_UUID;
 685
 686                 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
 687                         if ( got & GOT_ATTRSET ) {
 688                                 rc = 1;
 689                                 goto error;
 690                         }
 691
 692                         rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
 693                         if ( rc ) {
 694                                 goto error;
 695                         }
 696                         got |= GOT_ATTRSET;
 697
 698                 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
 699                         unsigned long l;
 700
 701                         if ( got & GOT_EXPIRY ) {
 702                                 rc = 1;
 703                                 goto error;
 704                         }
 705
 706                         rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
 707                         if ( rc ) {
 708                                 goto error;
 709                         }
 710                         expiry_time = (time_t)l;
 711                         got |= GOT_EXPIRY;
 712
 713                 } else if ( strncmp( lud->lud_exts[ i ], "x-answerable=", STRLENOF( "x-answerable=" ) ) == 0 ) {
 714                         if ( got & GOT_ANSWERABLE ) {
 715                                 rc = 1;
 716                                 goto error;
 717                         }
 718
 719                         rc = lutil_atoul( &answerable_cnt, &lud->lud_exts[ i ][ STRLENOF( "x-answerable=" ) ] );
 720                         if ( rc ) {
 721                                 goto error;
 722                         }
 723                         got |= GOT_ANSWERABLE;
 724
 725                 } else if ( strncmp( lud->lud_exts[ i ], "x-refresh=", STRLENOF( "x-refresh=" ) ) == 0 ) {
 726                         unsigned long l;
 727
 728                         if ( got & GOT_REFRESH ) {
 729                                 rc = 1;
 730                                 goto error;
 731                         }
 732
 733                         rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-refresh=" ) ] );
 734                         if ( rc ) {
 735                                 goto error;
 736                         }
 737                         refresh_time = (time_t)l;
 738                         got |= GOT_REFRESH;
 739
 740                 } else {
 741                         rc = -1;
 742                         goto error;
 743                 }
 744         }
 745
 746         if ( got != GOT_ALL ) {
 747                 rc = 1;
 748                 goto error;
 749         }
 750
 751         if ( !(got & GOT_REFRESH ))
 752                 refresh_time = 0;
 753
 754         /* ignore expired queries */
 755         if ( expiry_time <= slap_get_time()) {
 756                 Operation       op2 = *op;
 757
 758                 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
 759
 760                 (void)remove_query_data( &op2, &uuid );
 761
 762                 rc = 0;
 763
 764         } else {
 765                 ber_str2bv( lud->lud_dn, 0, 0, &base );
 766                 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
 767                 if ( rc != LDAP_SUCCESS ) {
 768                         goto error;
 769                 }
 770                 query.scope = lud->lud_scope;
 771                 query.filter = str2filter( lud->lud_filter );
 772                 if ( query.filter == NULL ) {
 773                         rc = -1;
 774                         goto error;
 775                 }
 776
 777                 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
 778                 tempstr.bv_len = 0;
 779                 if ( filter2template( op, query.filter, &tempstr ) ) {
 780                         ch_free( tempstr.bv_val );
 781                         rc = -1;
 782                         goto error;
 783                 }
 784
 785                 /* check for query containment */
 786                 qt = qm->attr_sets[attrset].templates;
 787                 for ( ; qt; qt = qt->qtnext ) {
 788                         /* find if template i can potentially answer tempstr */
 789                         if ( bvmatch( &qt->querystr, &tempstr ) ) {
 790                                 break;
 791                         }
 792                 }
 793
 794                 if ( qt == NULL ) {
 795                         rc = 1;
 796                         goto error;
 797                 }
 798
 799                 cq = add_query( op, qm, &query, qt, PC_POSITIVE, 0 );
 800                 if ( cq != NULL ) {
 801                         cq->expiry_time = expiry_time;
 802                         cq->refresh_time = refresh_time;
 803                         cq->q_uuid = uuid;
 804                         cq->answerable_cnt = answerable_cnt;
 805                         cq->refcnt = 0;
 806
 807                         /* it's now into cq->filter */
 808                         BER_BVZERO( &uuid );
 809                         query.filter = NULL;
 810
 811                 } else {
 812                         rc = 1;
 813                 }
 814         }
 815
 816 error:;
 817         if ( query.filter != NULL ) filter_free( query.filter );
 818         if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
 819         if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
 820         if ( !BER_BVISNULL( &uuid ) ) ch_free( uuid.bv_val );
 821         if ( lud != NULL ) ldap_free_urldesc( lud );
 822
 823         return rc;
 824 }
 825
 826 /* Return 1 for an added entry, else 0 */
 827 static int
 828 merge_entry(
 829         Operation               *op,
 830         Entry                   *e,
 831         int                     dup,
 832         struct berval*          query_uuid )
 833 {
 834         int             rc;
 835         Modifications* modlist = NULL;
 836         const char*     text = NULL;
 837         Attribute               *attr;
 838         char                    textbuf[SLAP_TEXT_BUFLEN];
 839         size_t                  textlen = sizeof(textbuf);
 840
 841         SlapReply sreply = {REP_RESULT};
 842
 843         slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
 844
 845         if ( dup )
 846                 e = entry_dup( e );
 847         attr = e->e_attrs;
 848         e->e_attrs = NULL;
 849
 850         /* add queryId attribute */
 851         attr_merge_one( e, ad_queryId, query_uuid, NULL );
 852
 853         /* append the attribute list from the fetched entry */
 854         e->e_attrs->a_next = attr;
 855
 856         op->o_tag = LDAP_REQ_ADD;
 857         op->o_protocol = LDAP_VERSION3;
 858         op->o_callback = &cb;
 859         op->o_time = slap_get_time();
 860         op->o_do_not_cache = 1;
 861
 862         op->ora_e = e;
 863         op->o_req_dn = e->e_name;
 864         op->o_req_ndn = e->e_nname;
 865         rc = op->o_bd->be_add( op, &sreply );
 866
 867         if ( rc != LDAP_SUCCESS ) {
 868                 if ( rc == LDAP_ALREADY_EXISTS ) {
 869                         rs_reinit( &sreply, REP_RESULT );
 870                         slap_entry2mods( e, &modlist, &text, textbuf, textlen );
 871                         modlist->sml_op = LDAP_MOD_ADD;
 872                         op->o_tag = LDAP_REQ_MODIFY;
 873                         op->orm_modlist = modlist;
 874                         op->o_managedsait = SLAP_CONTROL_CRITICAL;
 875                         op->o_bd->be_modify( op, &sreply );
 876                         slap_mods_free( modlist, 1 );
 877                 } else if ( rc == LDAP_REFERRAL ||
 878                                         rc == LDAP_NO_SUCH_OBJECT ) {
 879                         syncrepl_add_glue( op, e );
 880                         e = NULL;
 881                         rc = 1;
 882                 }
 883                 if ( e ) {
 884                         entry_free( e );
 885                         rc = 0;
 886                 }
 887         } else {
 888                 if ( op->ora_e == e )
 889                         entry_free( e );
 890                 rc = 1;
 891         }
 892
 893         return rc;
 894 }
 895
 896 /* Length-ordered sort on normalized DNs */
 897 static int pcache_dn_cmp( const void *v1, const void *v2 )
 898 {
 899         const Qbase *q1 = v1, *q2 = v2;
 900
 901         int rc = q1->base.bv_len - q2->base.bv_len;
 902         if ( rc == 0 )
 903                 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
 904         return rc;
 905 }
 906
 907 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
 908 {
 909         int len, dif;
 910         dif = bv1->bv_len - bv2->bv_len;
 911         len = bv1->bv_len;
 912         if ( dif > 0 ) len -= dif;
 913         len = memcmp( bv1->bv_val, bv2->bv_val, len );
 914         if ( !len )
 915                 len = dif;
 916         return len;
 917 }
 918
 919 /* compare the current value in each filter */
 920 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
 921 {
 922         int rc, weight1, weight2;
 923
 924         switch( f1->f_choice ) {
 925         case LDAP_FILTER_AND:
 926         case LDAP_FILTER_OR:
 927                 weight1 = 0;
 928                 break;
 929         case LDAP_FILTER_PRESENT:
 930                 weight1 = 1;
 931                 break;
 932         case LDAP_FILTER_EQUALITY:
 933         case LDAP_FILTER_GE:
 934         case LDAP_FILTER_LE:
 935                 weight1 = 2;
 936                 break;
 937         default:
 938                 weight1 = 3;
 939         }
 940         switch( f2->f_choice ) {
 941         case LDAP_FILTER_AND:
 942         case LDAP_FILTER_OR:
 943                 weight2 = 0;
 944                 break;
 945         case LDAP_FILTER_PRESENT:
 946                 weight2 = 1;
 947                 break;
 948         case LDAP_FILTER_EQUALITY:
 949         case LDAP_FILTER_GE:
 950         case LDAP_FILTER_LE:
 951                 weight2 = 2;
 952                 break;
 953         default:
 954                 weight2 = 3;
 955         }
 956         rc = weight1 - weight2;
 957         if ( !rc ) {
 958                 switch( weight1 ) {
 959                 case 0:
 960                         rc = pcache_filter_cmp( f1->f_and, f2->f_and );
 961                         break;
 962                 case 1:
 963                         break;
 964                 case 2:
 965                         rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
 966                         break;
 967                 case 3:
 968                         if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
 969                                 rc = 0;
 970                                 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
 971                                         if ( !BER_BVISNULL( &f2->f_sub_initial )) {
 972                                                 rc = lex_bvcmp( &f1->f_sub_initial,
 973                                                         &f2->f_sub_initial );
 974                                         } else {
 975                                                 rc = 1;
 976                                         }
 977                                 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
 978                                         rc = -1;
 979                                 }
 980                                 if ( rc ) break;
 981                                 if ( f1->f_sub_any ) {
 982                                         if ( f2->f_sub_any ) {
 983                                                 rc = lex_bvcmp( f1->f_sub_any,
 984                                                         f2->f_sub_any );
 985                                         } else {
 986                                                 rc = 1;
 987                                         }
 988                                 } else if ( f2->f_sub_any ) {
 989                                         rc = -1;
 990                                 }
 991                                 if ( rc ) break;
 992                                 if ( !BER_BVISNULL( &f1->f_sub_final )) {
 993                                         if ( !BER_BVISNULL( &f2->f_sub_final )) {
 994                                                 rc = lex_bvcmp( &f1->f_sub_final,
 995                                                         &f2->f_sub_final );
 996                                         } else {
 997                                                 rc = 1;
 998                                         }
 999                                 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
1000                                         rc = -1;
1001                                 }
1002                         } else {
1003                                 rc = lex_bvcmp( &f1->f_mr_value,
1004                                         &f2->f_mr_value );
1005                         }
1006                         break;
1007                 }
1008                 while ( !rc ) {
1009                         f1 = f1->f_next;
1010                         f2 = f2->f_next;
1011                         if ( f1 || f2 ) {
1012                                 if ( !f1 )
1013                                         rc = -1;
1014                                 else if ( !f2 )
1015                                         rc = 1;
1016                                 else {
1017                                         rc = pcache_filter_cmp( f1, f2 );
1018                                 }
1019                         } else {
1020                                 break;
1021                         }
1022                 }
1023         }
1024         return rc;
1025 }
1026
1027 /* compare filters in each query */
1028 static int pcache_query_cmp( const void *v1, const void *v2 )
1029 {
1030         const CachedQuery *q1 = v1, *q2 =v2;
1031         return pcache_filter_cmp( q1->filter, q2->filter );
1032 }
1033
1034 /* add query on top of LRU list */
1035 static void
1036 add_query_on_top (query_manager* qm, CachedQuery* qc)
1037 {
1038         CachedQuery* top = qm->lru_top;
1039
1040         qm->lru_top = qc;
1041
1042         if (top)
1043                 top->lru_up = qc;
1044         else
1045                 qm->lru_bottom = qc;
1046
1047         qc->lru_down = top;
1048         qc->lru_up = NULL;
1049         Debug( pcache_debug, "Base of added query = %s\n",
1050                         qc->qbase->base.bv_val, 0, 0 );
1051 }
1052
1053 /* remove_query from LRU list */
1054
1055 static void
1056 remove_query (query_manager* qm, CachedQuery* qc)
1057 {
1058         CachedQuery* up;
1059         CachedQuery* down;
1060
1061         if (!qc)
1062                 return;
1063
1064         up = qc->lru_up;
1065         down = qc->lru_down;
1066
1067         if (!up)
1068                 qm->lru_top = down;
1069
1070         if (!down)
1071                 qm->lru_bottom = up;
1072
1073         if (down)
1074                 down->lru_up = up;
1075
1076         if (up)
1077                 up->lru_down = down;
1078
1079         qc->lru_up = qc->lru_down = NULL;
1080 }
1081
1082 /* find and remove string2 from string1
1083  * from start if position = 1,
1084  * from end if position = 3,
1085  * from anywhere if position = 2
1086  * string1 is overwritten if position = 2.
1087  */
1088
1089 static int
1090 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1091 {
1092         int ret=0;
1093
1094         if ( !ber2->bv_val )
1095                 return 1;
1096         if ( !ber1->bv_val )
1097                 return 0;
1098
1099         switch( position ) {
1100         case 1:
1101                 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1102                         ber2->bv_val, ber2->bv_len )) {
1103                         ret = 1;
1104                         ber1->bv_val += ber2->bv_len;
1105                         ber1->bv_len -= ber2->bv_len;
1106                 }
1107                 break;
1108         case 2: {
1109                 char *temp;
1110                 ber1->bv_val[ber1->bv_len] = '\0';
1111                 temp = strstr( ber1->bv_val, ber2->bv_val );
1112                 if ( temp ) {
1113                         strcpy( temp, temp+ber2->bv_len );
1114                         ber1->bv_len -= ber2->bv_len;
1115                         ret = 1;
1116                 }
1117                 break;
1118                 }
1119         case 3:
1120                 if ( ber1->bv_len >= ber2->bv_len &&
1121                         !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1122                                 ber2->bv_len )) {
1123                         ret = 1;
1124                         ber1->bv_len -= ber2->bv_len;
1125                 }
1126                 break;
1127         }
1128         return ret;
1129 }
1130
1131
1132 static struct berval*
1133 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1134         struct berval* final)
1135 {
1136         struct berval* merged, *temp;
1137         int i, any_count, count;
1138
1139         for (any_count=0; any && any[any_count].bv_val; any_count++)
1140                 ;
1141
1142         count = any_count;
1143
1144         if (init->bv_val)
1145                 count++;
1146         if (final->bv_val)
1147                 count++;
1148
1149         merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1150                 op->o_tmpmemctx );
1151         temp = merged;
1152
1153         if (init->bv_val) {
1154                 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1155                 temp++;
1156         }
1157
1158         for (i=0; i<any_count; i++) {
1159                 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1160                 temp++; any++;
1161         }
1162
1163         if (final->bv_val){
1164                 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1165                 temp++;
1166         }
1167         BER_BVZERO( temp );
1168         return merged;
1169 }
1170
1171 /* Each element in stored must be found in incoming. Incoming is overwritten.
1172  */
1173 static int
1174 strings_containment(struct berval* stored, struct berval* incoming)
1175 {
1176         struct berval* element;
1177         int k=0;
1178         int j, rc = 0;
1179
1180         for ( element=stored; element->bv_val != NULL; element++ ) {
1181                 for (j = k; incoming[j].bv_val != NULL; j++) {
1182                         if (find_and_remove(&(incoming[j]), element, 2)) {
1183                                 k = j;
1184                                 rc = 1;
1185                                 break;
1186                         }
1187                         rc = 0;
1188                 }
1189                 if ( rc ) {
1190                         continue;
1191                 } else {
1192                         return 0;
1193                 }
1194         }
1195         return 1;
1196 }
1197
1198 static int
1199 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1200 {
1201         int rc = 0;
1202
1203         struct berval init_incoming;
1204         struct berval final_incoming;
1205         struct berval *remaining_incoming = NULL;
1206
1207         if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1208            || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1209                 return 0;
1210
1211         init_incoming = incoming->f_sub_initial;
1212         final_incoming =  incoming->f_sub_final;
1213
1214         if (find_and_remove(&init_incoming,
1215                         &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1216                         &(stored->f_sub_final), 3))
1217         {
1218                 if (stored->f_sub_any == NULL) {
1219                         rc = 1;
1220                         goto final;
1221                 }
1222                 remaining_incoming = merge_init_final(op, &init_incoming,
1223                                                 incoming->f_sub_any, &final_incoming);
1224                 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1225                 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1226         }
1227 final:
1228         return rc;
1229 }
1230
1231 static int
1232 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1233 {
1234         struct berval incoming_val[2];
1235         int rc = 0;
1236
1237         incoming_val[1] = incoming->f_av_value;
1238
1239         if (find_and_remove(incoming_val+1,
1240                         &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1241                         &(stored->f_sub_final), 3)) {
1242                 if (stored->f_sub_any == NULL){
1243                         rc = 1;
1244                         goto final;
1245                 }
1246                 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1247                 BER_BVZERO( incoming_val+1 );
1248                 rc = strings_containment(stored->f_sub_any, incoming_val);
1249                 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1250         }
1251 final:
1252         return rc;
1253 }
1254
1255 static Filter *
1256 filter_first( Filter *f )
1257 {
1258         while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1259                 f = f->f_and;
1260         return f;
1261 }
1262
1263 typedef struct fstack {
1264         struct fstack *fs_next;
1265         Filter *fs_fs;
1266         Filter *fs_fi;
1267 } fstack;
1268
1269 static CachedQuery *
1270 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1271 {
1272         Filter* fs;
1273         Filter* fi;
1274         MatchingRule* mrule = NULL;
1275         int res=0, eqpass= 0;
1276         int ret, rc, dir;
1277         Avlnode *ptr;
1278         CachedQuery cq, *qc;
1279         fstack *stack = NULL, *fsp;
1280
1281         cq.filter = inputf;
1282         cq.first = first;
1283
1284         /* substring matches sort to the end, and we just have to
1285          * walk the entire list.
1286          */
1287         if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1288                 ptr = tavl_end( root, 1 );
1289                 dir = TAVL_DIR_LEFT;
1290         } else {
1291                 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1292                 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1293                         TAVL_DIR_RIGHT;
1294         }
1295
1296         while (ptr) {
1297                 qc = ptr->avl_data;
1298                 fi = inputf;
1299                 fs = qc->filter;
1300
1301                 /* an incoming substr query can only be satisfied by a cached
1302                  * substr query.
1303                  */
1304                 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1305                         qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1306                         break;
1307
1308                 /* an incoming eq query can be satisfied by a cached eq or substr
1309                  * query
1310                  */
1311                 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1312                         if ( eqpass == 0 ) {
1313                                 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1314 nextpass:                       eqpass = 1;
1315                                         ptr = tavl_end( root, 1 );
1316                                         dir = TAVL_DIR_LEFT;
1317                                         continue;
1318                                 }
1319                         } else {
1320                                 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1321                                         break;
1322                         }
1323                 }
1324                 do {
1325                         res=0;
1326                         switch (fs->f_choice) {
1327                         case LDAP_FILTER_EQUALITY:
1328                                 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1329                                         mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1330                                 else
1331                                         ret = 1;
1332                                 break;
1333                         case LDAP_FILTER_GE:
1334                         case LDAP_FILTER_LE:
1335                                 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1336                                 break;
1337                         default:
1338                                 mrule = NULL;
1339                         }
1340                         if (mrule) {
1341                                 const char *text;
1342                                 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1343                                         SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1344                                         &(fi->f_ava->aa_value),
1345                                         &(fs->f_ava->aa_value), &text);
1346                                 if (rc != LDAP_SUCCESS) {
1347                                         return NULL;
1348                                 }
1349                                 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1350                                         goto nextpass;
1351                         }
1352                         switch (fs->f_choice) {
1353                         case LDAP_FILTER_OR:
1354                         case LDAP_FILTER_AND:
1355                                 if ( fs->f_next ) {
1356                                         /* save our stack position */
1357                                         fsp = op->o_tmpalloc(sizeof(fstack), op->o_tmpmemctx);
1358                                         fsp->fs_next = stack;
1359                                         fsp->fs_fs = fs->f_next;
1360                                         fsp->fs_fi = fi->f_next;
1361                                         stack = fsp;
1362                                 }
1363                                 fs = fs->f_and;
1364                                 fi = fi->f_and;
1365                                 res=1;
1366                                 break;
1367                         case LDAP_FILTER_SUBSTRINGS:
1368                                 /* check if the equality query can be
1369                                 * answered with cached substring query */
1370                                 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1371                                         && substr_containment_equality( op,
1372                                         fs, fi))
1373                                         res=1;
1374                                 /* check if the substring query can be
1375                                 * answered with cached substring query */
1376                                 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1377                                         ) && substr_containment_substr( op,
1378                                         fs, fi))
1379                                         res= 1;
1380                                 fs=fs->f_next;
1381                                 fi=fi->f_next;
1382                                 break;
1383                         case LDAP_FILTER_PRESENT:
1384                                 res=1;
1385                                 fs=fs->f_next;
1386                                 fi=fi->f_next;
1387                                 break;
1388                         case LDAP_FILTER_EQUALITY:
1389                                 if (ret == 0)
1390                                         res = 1;
1391                                 fs=fs->f_next;
1392                                 fi=fi->f_next;
1393                                 break;
1394                         case LDAP_FILTER_GE:
1395                                 if (mrule && ret >= 0)
1396                                         res = 1;
1397                                 fs=fs->f_next;
1398                                 fi=fi->f_next;
1399                                 break;
1400                         case LDAP_FILTER_LE:
1401                                 if (mrule && ret <= 0)
1402                                         res = 1;
1403                                 fs=fs->f_next;
1404                                 fi=fi->f_next;
1405                                 break;
1406                         case LDAP_FILTER_NOT:
1407                                 res=0;
1408                                 break;
1409                         default:
1410                                 break;
1411                         }
1412                         if (!fs && !fi && stack) {
1413                                 /* pop the stack */
1414                                 fsp = stack;
1415                                 stack = fsp->fs_next;
1416                                 fs = fsp->fs_fs;
1417                                 fi = fsp->fs_fi;
1418                                 op->o_tmpfree(fsp, op->o_tmpmemctx);
1419                         }
1420                 } while((res) && (fi != NULL) && (fs != NULL));
1421
1422                 if ( res )
1423                         return qc;
1424                 ptr = tavl_next( ptr, dir );
1425         }
1426         return NULL;
1427 }
1428
1429 /* check whether query is contained in any of
1430  * the cached queries in template
1431  */
1432 static CachedQuery *
1433 query_containment(Operation *op, query_manager *qm,
1434                   Query *query,
1435                   QueryTemplate *templa)
1436 {
1437         CachedQuery* qc;
1438         int depth = 0, tscope;
1439         Qbase qbase, *qbptr = NULL;
1440         struct berval pdn;
1441
1442         if (query->filter != NULL) {
1443                 Filter *first;
1444
1445                 Debug( pcache_debug, "Lock QC index = %p\n",
1446                                 (void *) templa, 0, 0 );
1447                 qbase.base = query->base;
1448
1449                 first = filter_first( query->filter );
1450
1451                 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1452                 for( ;; ) {
1453                         /* Find the base */
1454                         qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1455                         if ( qbptr ) {
1456                                 tscope = query->scope;
1457                                 /* Find a matching scope:
1458                                  * match at depth 0 OK
1459                                  * scope is BASE,
1460                                  *      one at depth 1 OK
1461                                  *  subord at depth > 0 OK
1462                                  *      subtree at any depth OK
1463                                  * scope is ONE,
1464                                  *  subtree or subord at any depth OK
1465                                  * scope is SUBORD,
1466                                  *  subtree or subord at any depth OK
1467                                  * scope is SUBTREE,
1468                                  *  subord at depth > 0 OK
1469                                  *  subtree at any depth OK
1470                                  */
1471                                 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1472                                         switch ( query->scope ) {
1473                                         case LDAP_SCOPE_BASE:
1474                                                 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1475                                                 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1476                                                 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1477                                                 break;
1478                                         case LDAP_SCOPE_ONE:
1479                                                 if ( tscope == LDAP_SCOPE_BASE )
1480                                                         tscope = LDAP_SCOPE_ONE;
1481                                                 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1482                                                 if ( !depth ) break;
1483                                                 if ( tscope < LDAP_SCOPE_SUBTREE )
1484                                                         tscope = LDAP_SCOPE_SUBTREE;
1485                                                 break;
1486                                         case LDAP_SCOPE_SUBTREE:
1487                                                 if ( tscope < LDAP_SCOPE_SUBTREE )
1488                                                         tscope = LDAP_SCOPE_SUBTREE;
1489                                                 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1490                                                 break;
1491                                         case LDAP_SCOPE_CHILDREN:
1492                                                 if ( tscope < LDAP_SCOPE_SUBTREE )
1493                                                         tscope = LDAP_SCOPE_SUBTREE;
1494                                                 break;
1495                                         }
1496                                         if ( !qbptr->scopes[tscope] ) continue;
1497
1498                                         /* Find filter */
1499                                         qc = find_filter( op, qbptr->scopes[tscope],
1500                                                         query->filter, first );
1501                                         if ( qc ) {
1502                                                 if ( qc->q_sizelimit ) {
1503                                                         ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1504                                                         return NULL;
1505                                                 }
1506                                                 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1507                                                 if (qm->lru_top != qc) {
1508                                                         remove_query(qm, qc);
1509                                                         add_query_on_top(qm, qc);
1510                                                 }
1511                                                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1512                                                 return qc;
1513                                         }
1514                                 }
1515                         }
1516                         if ( be_issuffix( op->o_bd, &qbase.base ))
1517                                 break;
1518                         /* Up a level */
1519                         dnParent( &qbase.base, &pdn );
1520                         qbase.base = pdn;
1521                         depth++;
1522                 }
1523
1524                 Debug( pcache_debug,
1525                         "Not answerable: Unlock QC index=%p\n",
1526                         (void *) templa, 0, 0 );
1527                 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1528         }
1529         return NULL;
1530 }
1531
1532 static void
1533 free_query (CachedQuery* qc)
1534 {
1535         free(qc->q_uuid.bv_val);
1536         filter_free(qc->filter);
1537         ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1538         ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1539         memset(qc, 0, sizeof(*qc));
1540         free(qc);
1541 }
1542
1543
1544 /* Add query to query cache, the returned Query is locked for writing */
1545 static CachedQuery *
1546 add_query(
1547         Operation *op,
1548         query_manager* qm,
1549         Query* query,
1550         QueryTemplate *templ,
1551         pc_caching_reason_t why,
1552         int wlock)
1553 {
1554         CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1555         Qbase *qbase, qb;
1556         Filter *first;
1557         int rc;
1558         time_t ttl = 0, ttr = 0;
1559         time_t now;
1560
1561         new_cached_query->qtemp = templ;
1562         BER_BVZERO( &new_cached_query->q_uuid );
1563         new_cached_query->q_sizelimit = 0;
1564
1565         now = slap_get_time();
1566         switch ( why ) {
1567         case PC_POSITIVE:
1568                 ttl = templ->ttl;
1569                 if ( templ->ttr )
1570                         ttr = now + templ->ttr;
1571                 break;
1572
1573         case PC_NEGATIVE:
1574                 ttl = templ->negttl;
1575                 break;
1576
1577         case PC_SIZELIMIT:
1578                 ttl = templ->limitttl;
1579                 break;
1580
1581         default:
1582                 assert( 0 );
1583                 break;
1584         }
1585         new_cached_query->expiry_time = now + ttl;
1586         new_cached_query->refresh_time = ttr;
1587         new_cached_query->bindref_time = 0;
1588
1589         new_cached_query->bind_refcnt = 0;
1590         new_cached_query->answerable_cnt = 0;
1591         new_cached_query->refcnt = 1;
1592         ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1593
1594         new_cached_query->lru_up = NULL;
1595         new_cached_query->lru_down = NULL;
1596         Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1597                         (long) new_cached_query->expiry_time,
1598                         pc_caching_reason_str[ why ], 0 );
1599
1600         new_cached_query->scope = query->scope;
1601         new_cached_query->filter = query->filter;
1602         new_cached_query->first = first = filter_first( query->filter );
1603
1604         ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1605         if (wlock)
1606                 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1607
1608         qb.base = query->base;
1609
1610         /* Adding a query    */
1611         Debug( pcache_debug, "Lock AQ index = %p\n",
1612                         (void *) templ, 0, 0 );
1613         ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1614         qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1615         if ( !qbase ) {
1616                 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1617                 qbase->base.bv_len = qb.base.bv_len;
1618                 qbase->base.bv_val = (char *)(qbase+1);
1619                 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1620                 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1621                 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1622         }
1623         new_cached_query->next = templ->query;
1624         new_cached_query->prev = NULL;
1625         new_cached_query->qbase = qbase;
1626         rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1627                 pcache_query_cmp, avl_dup_error );
1628         if ( rc == 0 ) {
1629                 qbase->queries++;
1630                 if (templ->query == NULL)
1631                         templ->query_last = new_cached_query;
1632                 else
1633                         templ->query->prev = new_cached_query;
1634                 templ->query = new_cached_query;
1635                 templ->no_of_queries++;
1636         } else {
1637                 ldap_pvt_thread_mutex_destroy(&new_cached_query->answerable_cnt_mutex);
1638                 if (wlock)
1639                         ldap_pvt_thread_rdwr_wunlock(&new_cached_query->rwlock);
1640                 ldap_pvt_thread_rdwr_destroy( &new_cached_query->rwlock );
1641                 ch_free( new_cached_query );
1642                 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1643                                                         query->filter, first );
1644                 filter_free( query->filter );
1645                 query->filter = NULL;
1646         }
1647         Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1648                         (void *) templ, templ->no_of_queries, 0 );
1649
1650         /* Adding on top of LRU list  */
1651         if ( rc == 0 ) {
1652                 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1653                 add_query_on_top(qm, new_cached_query);
1654                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1655         }
1656         Debug( pcache_debug, "Unlock AQ index = %p \n",
1657                         (void *) templ, 0, 0 );
1658         ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1659
1660         return rc == 0 ? new_cached_query : NULL;
1661 }
1662
1663 static void
1664 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1665 {
1666         if (!qc->prev && !qc->next) {
1667                 template->query_last = template->query = NULL;
1668         } else if (qc->prev == NULL) {
1669                 qc->next->prev = NULL;
1670                 template->query = qc->next;
1671         } else if (qc->next == NULL) {
1672                 qc->prev->next = NULL;
1673                 template->query_last = qc->prev;
1674         } else {
1675                 qc->next->prev = qc->prev;
1676                 qc->prev->next = qc->next;
1677         }
1678         tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1679         qc->qbase->queries--;
1680         if ( qc->qbase->queries == 0 ) {
1681                 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1682                 ch_free( qc->qbase );
1683                 qc->qbase = NULL;
1684         }
1685
1686         template->no_of_queries--;
1687 }
1688
1689 /* remove bottom query of LRU list from the query cache */
1690 /*
1691  * NOTE: slight change in functionality.
1692  *
1693  * - if result->bv_val is NULL, the query at the bottom of the LRU
1694  *   is removed
1695  * - otherwise, the query whose UUID is *result is removed
1696  *      - if not found, result->bv_val is zeroed
1697  */
1698 static void
1699 cache_replacement(query_manager* qm, struct berval *result)
1700 {
1701         CachedQuery* bottom;
1702         QueryTemplate *temp;
1703
1704         ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1705         if ( BER_BVISNULL( result ) ) {
1706                 bottom = qm->lru_bottom;
1707
1708                 if (!bottom) {
1709                         Debug ( pcache_debug,
1710                                 "Cache replacement invoked without "
1711                                 "any query in LRU list\n", 0, 0, 0 );
1712                         ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1713                         return;
1714                 }
1715
1716         } else {
1717                 for ( bottom = qm->lru_bottom;
1718                         bottom != NULL;
1719                         bottom = bottom->lru_up )
1720                 {
1721                         if ( bvmatch( result, &bottom->q_uuid ) ) {
1722                                 break;
1723                         }
1724                 }
1725
1726                 if ( !bottom ) {
1727                         Debug ( pcache_debug,
1728                                 "Could not find query with uuid=\"%s\""
1729                                 "in LRU list\n", result->bv_val, 0, 0 );
1730                         ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1731                         BER_BVZERO( result );
1732                         return;
1733                 }
1734         }
1735
1736         temp = bottom->qtemp;
1737         remove_query(qm, bottom);
1738         ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1739
1740         *result = bottom->q_uuid;
1741         BER_BVZERO( &bottom->q_uuid );
1742
1743         Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1744         ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1745         remove_from_template(bottom, temp);
1746         Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1747                 (void *) temp, temp->no_of_queries, 0 );
1748         Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1749         ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1750         free_query(bottom);
1751 }
1752
1753 struct query_info {
1754         struct query_info *next;
1755         struct berval xdn;
1756         int del;
1757 };
1758
1759 static int
1760 remove_func (
1761         Operation       *op,
1762         SlapReply       *rs
1763 )
1764 {
1765         Attribute *attr;
1766         struct query_info *qi;
1767         int count = 0;
1768
1769         if ( rs->sr_type != REP_SEARCH ) return 0;
1770
1771         attr = attr_find( rs->sr_entry->e_attrs,  ad_queryId );
1772         if ( attr == NULL ) return 0;
1773
1774         count = attr->a_numvals;
1775         assert( count > 0 );
1776         qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1777         qi->next = op->o_callback->sc_private;
1778         op->o_callback->sc_private = qi;
1779         ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1780         qi->del = ( count == 1 );
1781
1782         return 0;
1783 }
1784
1785 static int
1786 remove_query_data(
1787         Operation       *op,
1788         struct berval   *query_uuid )
1789 {
1790         struct query_info       *qi, *qnext;
1791         char                    filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1792         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
1793         Filter                  filter = {LDAP_FILTER_EQUALITY};
1794         SlapReply               sreply = {REP_RESULT};
1795         slap_callback cb = { NULL, remove_func, NULL, NULL };
1796         int deleted = 0;
1797
1798         op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1799                 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1800         filter.f_ava = &ava;
1801         filter.f_av_desc = ad_queryId;
1802         filter.f_av_value = *query_uuid;
1803
1804         op->o_tag = LDAP_REQ_SEARCH;
1805         op->o_protocol = LDAP_VERSION3;
1806         op->o_callback = &cb;
1807         op->o_time = slap_get_time();
1808         op->o_do_not_cache = 1;
1809
1810         op->o_req_dn = op->o_bd->be_suffix[0];
1811         op->o_req_ndn = op->o_bd->be_nsuffix[0];
1812         op->ors_scope = LDAP_SCOPE_SUBTREE;
1813         op->ors_deref = LDAP_DEREF_NEVER;
1814         op->ors_slimit = SLAP_NO_LIMIT;
1815         op->ors_tlimit = SLAP_NO_LIMIT;
1816         op->ors_limit = NULL;
1817         op->ors_filter = &filter;
1818         op->ors_filterstr.bv_val = filter_str;
1819         op->ors_filterstr.bv_len = strlen(filter_str);
1820         op->ors_attrs = NULL;
1821         op->ors_attrsonly = 0;
1822
1823         op->o_bd->be_search( op, &sreply );
1824
1825         for ( qi=cb.sc_private; qi; qi=qnext ) {
1826                 qnext = qi->next;
1827
1828                 op->o_req_dn = qi->xdn;
1829                 op->o_req_ndn = qi->xdn;
1830                 rs_reinit( &sreply, REP_RESULT );
1831
1832                 if ( qi->del ) {
1833                         Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1834                                 query_uuid->bv_val, 0, 0 );
1835
1836                         op->o_tag = LDAP_REQ_DELETE;
1837
1838                         if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1839                                 deleted++;
1840                         }
1841
1842                 } else {
1843                         Modifications mod;
1844                         struct berval vals[2];
1845
1846                         vals[0] = *query_uuid;
1847                         vals[1].bv_val = NULL;
1848                         vals[1].bv_len = 0;
1849                         mod.sml_op = LDAP_MOD_DELETE;
1850                         mod.sml_flags = 0;
1851                         mod.sml_desc = ad_queryId;
1852                         mod.sml_type = ad_queryId->ad_cname;
1853                         mod.sml_values = vals;
1854                         mod.sml_nvalues = NULL;
1855                         mod.sml_numvals = 1;
1856                         mod.sml_next = NULL;
1857                         Debug( pcache_debug,
1858                                 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1859                                 query_uuid->bv_val, 0, 0 );
1860
1861                         op->orm_modlist = &mod;
1862
1863                         op->o_bd->be_modify( op, &sreply );
1864                 }
1865                 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1866                 op->o_tmpfree( qi, op->o_tmpmemctx );
1867         }
1868         return deleted;
1869 }
1870
1871 static int
1872 get_attr_set(
1873         AttributeName* attrs,
1874         query_manager* qm,
1875         int num
1876 );
1877
1878 static int
1879 filter2template(
1880         Operation               *op,
1881         Filter                  *f,
1882         struct                  berval *fstr )
1883 {
1884         AttributeDescription *ad;
1885         int len, ret;
1886
1887         switch ( f->f_choice ) {
1888         case LDAP_FILTER_EQUALITY:
1889                 ad = f->f_av_desc;
1890                 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1891                 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1892                 assert( ret == len );
1893                 fstr->bv_len += len;
1894                 break;
1895
1896         case LDAP_FILTER_GE:
1897                 ad = f->f_av_desc;
1898                 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1899                 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1900                 assert( ret == len );
1901                 fstr->bv_len += len;
1902                 break;
1903
1904         case LDAP_FILTER_LE:
1905                 ad = f->f_av_desc;
1906                 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1907                 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1908                 assert( ret == len );
1909                 fstr->bv_len += len;
1910                 break;
1911
1912         case LDAP_FILTER_APPROX:
1913                 ad = f->f_av_desc;
1914                 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1915                 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1916                 assert( ret == len );
1917                 fstr->bv_len += len;
1918                 break;
1919
1920         case LDAP_FILTER_SUBSTRINGS:
1921                 ad = f->f_sub_desc;
1922                 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1923                 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1924                 assert( ret == len );
1925                 fstr->bv_len += len;
1926                 break;
1927
1928         case LDAP_FILTER_PRESENT:
1929                 ad = f->f_desc;
1930                 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1931                 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1932                 assert( ret == len );
1933                 fstr->bv_len += len;
1934                 break;
1935
1936         case LDAP_FILTER_AND:
1937         case LDAP_FILTER_OR:
1938         case LDAP_FILTER_NOT: {
1939                 int rc = 0;
1940                 fstr->bv_val[fstr->bv_len++] = '(';
1941                 switch ( f->f_choice ) {
1942                 case LDAP_FILTER_AND:
1943                         fstr->bv_val[fstr->bv_len] = '&';
1944                         break;
1945                 case LDAP_FILTER_OR:
1946                         fstr->bv_val[fstr->bv_len] = '|';
1947                         break;
1948                 case LDAP_FILTER_NOT:
1949                         fstr->bv_val[fstr->bv_len] = '!';
1950                         break;
1951                 }
1952                 fstr->bv_len++;
1953
1954                 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1955                         rc = filter2template( op, f, fstr );
1956                         if ( rc ) break;
1957                 }
1958                 fstr->bv_val[fstr->bv_len++] = ')';
1959                 fstr->bv_val[fstr->bv_len] = '\0';
1960
1961                 return rc;
1962                 }
1963
1964         default:
1965                 /* a filter should at least have room for "()",
1966                  * an "=" and for a 1-char attr */
1967                 strcpy( fstr->bv_val, "(?=)" );
1968                 fstr->bv_len += STRLENOF("(?=)");
1969                 return -1;
1970         }
1971
1972         return 0;
1973 }
1974
1975 #define BI_HASHED       0x01
1976 #define BI_DIDCB        0x02
1977 #define BI_LOOKUP       0x04
1978
1979 struct search_info;
1980
1981 typedef struct bindinfo {
1982         cache_manager *bi_cm;
1983         CachedQuery *bi_cq;
1984         QueryTemplate *bi_templ;
1985         struct search_info *bi_si;
1986         int bi_flags;
1987         slap_callback bi_cb;
1988 } bindinfo;
1989
1990 struct search_info {
1991         slap_overinst *on;
1992         Query query;
1993         QueryTemplate *qtemp;
1994         AttributeName*  save_attrs;     /* original attributes, saved for response */
1995         int swap_saved_attrs;
1996         int max;
1997         int over;
1998         int count;
1999         int slimit;
2000         int slimit_exceeded;
2001         pc_caching_reason_t caching_reason;
2002         Entry *head, *tail;
2003         bindinfo *pbi;
2004 };
2005
2006 static void
2007 remove_query_and_data(
2008         Operation       *op,
2009         cache_manager   *cm,
2010         struct berval   *uuid )
2011 {
2012         query_manager*          qm = cm->qm;
2013
2014         qm->crfunc( qm, uuid );
2015         if ( !BER_BVISNULL( uuid ) ) {
2016                 int     return_val;
2017
2018                 Debug( pcache_debug,
2019                         "Removing query UUID %s\n",
2020                         uuid->bv_val, 0, 0 );
2021                 return_val = remove_query_data( op, uuid );
2022                 Debug( pcache_debug,
2023                         "QUERY REMOVED, SIZE=%d\n",
2024                         return_val, 0, 0);
2025                 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
2026                 cm->cur_entries -= return_val;
2027                 cm->num_cached_queries--;
2028                 Debug( pcache_debug,
2029                         "STORED QUERIES = %lu\n",
2030                         cm->num_cached_queries, 0, 0 );
2031                 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
2032                 Debug( pcache_debug,
2033                         "QUERY REMOVED, CACHE ="
2034                         "%d entries\n",
2035                         cm->cur_entries, 0, 0 );
2036         }
2037 }
2038
2039 /*
2040  * Callback used to fetch queryId values based on entryUUID;
2041  * used by pcache_remove_entries_from_cache()
2042  */
2043 static int
2044 fetch_queryId_cb( Operation *op, SlapReply *rs )
2045 {
2046         int             rc = 0;
2047
2048         /* only care about searchEntry responses */
2049         if ( rs->sr_type != REP_SEARCH ) {
2050                 return 0;
2051         }
2052
2053         /* allow only one response per entryUUID */
2054         if ( op->o_callback->sc_private != NULL ) {
2055                 rc = 1;
2056
2057         } else {
2058                 Attribute       *a;
2059
2060                 /* copy all queryId values into callback's private data */
2061                 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2062                 if ( a != NULL ) {
2063                         BerVarray       vals = NULL;
2064
2065                         ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2066                         op->o_callback->sc_private = (void *)vals;
2067                 }
2068         }
2069
2070         /* clear entry if required */
2071         rs_flush_entry( op, rs, (slap_overinst *) op->o_bd->bd_info );
2072
2073         return rc;
2074 }
2075
2076 /*
2077  * Call that allows to remove a set of entries from the cache,
2078  * by forcing the removal of all the related queries.
2079  */
2080 int
2081 pcache_remove_entries_from_cache(
2082         Operation       *op,
2083         cache_manager   *cm,
2084         BerVarray       entryUUIDs )
2085 {
2086         Connection      conn = { 0 };
2087         OperationBuffer opbuf;
2088         Operation       op2;
2089         slap_callback   sc = { 0 };
2090         Filter          f = { 0 };
2091         char            filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2092         AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2093         AttributeName   attrs[ 2 ] = {{{ 0 }}};
2094         int             s, rc;
2095
2096         if ( op == NULL ) {
2097                 void    *thrctx = ldap_pvt_thread_pool_context();
2098
2099                 connection_fake_init( &conn, &opbuf, thrctx );
2100                 op = &opbuf.ob_op;
2101
2102         } else {
2103                 op2 = *op;
2104                 op = &op2;
2105         }
2106
2107         memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2108         op->ors_scope = LDAP_SCOPE_SUBTREE;
2109         op->ors_deref = LDAP_DEREF_NEVER;
2110         f.f_choice = LDAP_FILTER_EQUALITY;
2111         f.f_ava = &ava;
2112         ava.aa_desc = slap_schema.si_ad_entryUUID;
2113         op->ors_filter = &f;
2114         op->ors_slimit = 1;
2115         op->ors_tlimit = SLAP_NO_LIMIT;
2116         op->ors_limit = NULL;
2117         attrs[ 0 ].an_desc = ad_queryId;
2118         attrs[ 0 ].an_name = ad_queryId->ad_cname;
2119         op->ors_attrs = attrs;
2120         op->ors_attrsonly = 0;
2121
2122         op->o_req_dn = cm->db.be_suffix[ 0 ];
2123         op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2124
2125         op->o_tag = LDAP_REQ_SEARCH;
2126         op->o_protocol = LDAP_VERSION3;
2127         op->o_managedsait = SLAP_CONTROL_CRITICAL;
2128         op->o_bd = &cm->db;
2129         op->o_dn = op->o_bd->be_rootdn;
2130         op->o_ndn = op->o_bd->be_rootndn;
2131         sc.sc_response = fetch_queryId_cb;
2132         op->o_callback = &sc;
2133
2134         for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2135                 BerVarray       vals = NULL;
2136                 SlapReply       rs = { REP_RESULT };
2137
2138                 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2139                         "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2140                 op->ors_filterstr.bv_val = filtbuf;
2141                 ava.aa_value = entryUUIDs[ s ];
2142
2143                 rc = op->o_bd->be_search( op, &rs );
2144                 if ( rc != LDAP_SUCCESS ) {
2145                         continue;
2146                 }
2147
2148                 vals = (BerVarray)op->o_callback->sc_private;
2149                 if ( vals != NULL ) {
2150                         int             i;
2151
2152                         for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2153                                 struct berval   val = vals[ i ];
2154
2155                                 remove_query_and_data( op, cm, &val );
2156
2157                                 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2158                                         ch_free( val.bv_val );
2159                                 }
2160                         }
2161
2162                         ber_bvarray_free_x( vals, op->o_tmpmemctx );
2163                         op->o_callback->sc_private = NULL;
2164                 }
2165         }
2166
2167         return 0;
2168 }
2169
2170 /*
2171  * Call that allows to remove a query from the cache.
2172  */
2173 int
2174 pcache_remove_query_from_cache(
2175         Operation       *op,
2176         cache_manager   *cm,
2177         struct berval   *queryid )
2178 {
2179         Operation       op2 = *op;
2180
2181         op2.o_bd = &cm->db;
2182
2183         /* remove the selected query */
2184         remove_query_and_data( &op2, cm, queryid );
2185
2186         return LDAP_SUCCESS;
2187 }
2188
2189 /*
2190  * Call that allows to remove a set of queries related to an entry
2191  * from the cache; if queryid is not null, the entry must belong to
2192  * the query indicated by queryid.
2193  */
2194 int
2195 pcache_remove_entry_queries_from_cache(
2196         Operation       *op,
2197         cache_manager   *cm,
2198         struct berval   *ndn,
2199         struct berval   *queryid )
2200 {
2201         Connection              conn = { 0 };
2202         OperationBuffer         opbuf;
2203         Operation               op2;
2204         slap_callback           sc = { 0 };
2205         SlapReply               rs = { REP_RESULT };
2206         Filter                  f = { 0 };
2207         char                    filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2208         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
2209         AttributeName           attrs[ 2 ] = {{{ 0 }}};
2210         int                     rc;
2211
2212         BerVarray               vals = NULL;
2213
2214         if ( op == NULL ) {
2215                 void    *thrctx = ldap_pvt_thread_pool_context();
2216
2217                 connection_fake_init( &conn, &opbuf, thrctx );
2218                 op = &opbuf.ob_op;
2219
2220         } else {
2221                 op2 = *op;
2222                 op = &op2;
2223         }
2224
2225         memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2226         op->ors_scope = LDAP_SCOPE_BASE;
2227         op->ors_deref = LDAP_DEREF_NEVER;
2228         if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2229                 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2230                 f.f_choice = LDAP_FILTER_PRESENT;
2231                 f.f_desc = slap_schema.si_ad_objectClass;
2232
2233         } else {
2234                 op->ors_filterstr.bv_len = snprintf( filter_str,
2235                         sizeof( filter_str ), "(%s=%s)",
2236                         ad_queryId->ad_cname.bv_val, queryid->bv_val );
2237                 f.f_choice = LDAP_FILTER_EQUALITY;
2238                 f.f_ava = &ava;
2239                 f.f_av_desc = ad_queryId;
2240                 f.f_av_value = *queryid;
2241         }
2242         op->ors_filter = &f;
2243         op->ors_slimit = 1;
2244         op->ors_tlimit = SLAP_NO_LIMIT;
2245         op->ors_limit = NULL;
2246         attrs[ 0 ].an_desc = ad_queryId;
2247         attrs[ 0 ].an_name = ad_queryId->ad_cname;
2248         op->ors_attrs = attrs;
2249         op->ors_attrsonly = 0;
2250
2251         op->o_req_dn = *ndn;
2252         op->o_req_ndn = *ndn;
2253
2254         op->o_tag = LDAP_REQ_SEARCH;
2255         op->o_protocol = LDAP_VERSION3;
2256         op->o_managedsait = SLAP_CONTROL_CRITICAL;
2257         op->o_bd = &cm->db;
2258         op->o_dn = op->o_bd->be_rootdn;
2259         op->o_ndn = op->o_bd->be_rootndn;
2260         sc.sc_response = fetch_queryId_cb;
2261         op->o_callback = &sc;
2262
2263         rc = op->o_bd->be_search( op, &rs );
2264         if ( rc != LDAP_SUCCESS ) {
2265                 return rc;
2266         }
2267
2268         vals = (BerVarray)op->o_callback->sc_private;
2269         if ( vals != NULL ) {
2270                 int             i;
2271
2272                 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2273                         struct berval   val = vals[ i ];
2274
2275                         remove_query_and_data( op, cm, &val );
2276
2277                         if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2278                                 ch_free( val.bv_val );
2279                         }
2280                 }
2281
2282                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2283         }
2284
2285         return LDAP_SUCCESS;
2286 }
2287
2288 static int
2289 cache_entries(
2290         Operation       *op,
2291         struct berval *query_uuid )
2292 {
2293         struct search_info *si = op->o_callback->sc_private;
2294         slap_overinst *on = si->on;
2295         cache_manager *cm = on->on_bi.bi_private;
2296         int             return_val = 0;
2297         Entry           *e;
2298         struct berval   crp_uuid;
2299         char            uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2300         Operation       *op_tmp;
2301         Connection      conn = {0};
2302         OperationBuffer opbuf;
2303         void            *thrctx = ldap_pvt_thread_pool_context();
2304
2305         query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2306         ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2307
2308         connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2309         op_tmp = &opbuf.ob_op;
2310         op_tmp->o_bd = &cm->db;
2311         op_tmp->o_dn = cm->db.be_rootdn;
2312         op_tmp->o_ndn = cm->db.be_rootndn;
2313
2314         Debug( pcache_debug, "UUID for query being added = %s\n",
2315                         uuidbuf, 0, 0 );
2316
2317         for ( e=si->head; e; e=si->head ) {
2318                 si->head = e->e_private;
2319                 e->e_private = NULL;
2320                 while ( cm->cur_entries > (cm->max_entries) ) {
2321                         BER_BVZERO( &crp_uuid );
2322                         remove_query_and_data( op_tmp, cm, &crp_uuid );
2323                 }
2324
2325                 return_val = merge_entry(op_tmp, e, 0, query_uuid);
2326                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2327                 cm->cur_entries += return_val;
2328                 Debug( pcache_debug,
2329                         "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2330                         cm->cur_entries, 0, 0 );
2331                 return_val = 0;
2332                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2333         }
2334
2335         return return_val;
2336 }
2337
2338 static int
2339 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2340         slap_callback   *cb = op->o_callback;
2341         struct search_info *si = cb->sc_private;
2342         slap_overinst *on = si->on;
2343         cache_manager *cm = on->on_bi.bi_private;
2344         query_manager*          qm = cm->qm;
2345
2346         if ( rs->sr_type == REP_RESULT ||
2347                 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2348         {
2349                 if ( si->swap_saved_attrs ) {
2350                         rs->sr_attrs = si->save_attrs;
2351                         op->ors_attrs = si->save_attrs;
2352                 }
2353                 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2354                                 si->caching_reason == PC_IGNORE )
2355                 {
2356                         filter_free( si->query.filter );
2357                         if ( si->count ) {
2358                                 /* duplicate query, free it */
2359                                 Entry *e;
2360                                 for (;si->head; si->head=e) {
2361                                         e = si->head->e_private;
2362                                         si->head->e_private = NULL;
2363                                         entry_free(si->head);
2364                                 }
2365                         }
2366
2367                 } else if ( si->caching_reason != PC_IGNORE ) {
2368                         CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2369                                 si->qtemp, si->caching_reason, 1 );
2370
2371                         if ( qc != NULL ) {
2372                                 switch ( si->caching_reason ) {
2373                                 case PC_POSITIVE:
2374                                         cache_entries( op, &qc->q_uuid );
2375                                         if ( si->pbi ) {
2376                                                 qc->bind_refcnt++;
2377                                                 si->pbi->bi_cq = qc;
2378                                         }
2379                                         break;
2380
2381                                 case PC_SIZELIMIT:
2382                                         qc->q_sizelimit = rs->sr_nentries;
2383                                         break;
2384
2385                                 case PC_NEGATIVE:
2386                                         break;
2387
2388                                 default:
2389                                         assert( 0 );
2390                                         break;
2391                                 }
2392                                 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2393                                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2394                                 cm->num_cached_queries++;
2395                                 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2396                                                 cm->num_cached_queries, 0, 0 );
2397                                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2398
2399                                 /* If the consistency checker suspended itself,
2400                                  * wake it back up
2401                                  */
2402                                 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2403                                         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2404                                         if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2405                                                 cm->cc_paused = 0;
2406                                                 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2407                                         }
2408                                         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2409                                 }
2410
2411                         } else if ( si->count ) {
2412                                 /* duplicate query, free it */
2413                                 Entry *e;
2414                                 for (;si->head; si->head=e) {
2415                                         e = si->head->e_private;
2416                                         si->head->e_private = NULL;
2417                                         entry_free(si->head);
2418                                 }
2419                         }
2420
2421                 } else {
2422                         filter_free( si->query.filter );
2423                 }
2424
2425                 op->o_callback = op->o_callback->sc_next;
2426                 op->o_tmpfree( cb, op->o_tmpmemctx );
2427         }
2428
2429         return SLAP_CB_CONTINUE;
2430 }
2431
2432 static int
2433 pcache_response(
2434         Operation       *op,
2435         SlapReply       *rs )
2436 {
2437         struct search_info *si = op->o_callback->sc_private;
2438
2439         if ( si->swap_saved_attrs ) {
2440                 rs->sr_attrs = si->save_attrs;
2441                 rs->sr_attr_flags = slap_attr_flags( si->save_attrs );
2442                 op->ors_attrs = si->save_attrs;
2443         }
2444
2445         if ( rs->sr_type == REP_SEARCH ) {
2446                 Entry *e;
2447
2448                 /* don't return more entries than requested by the client */
2449                 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2450                         si->slimit_exceeded = 1;
2451                 }
2452
2453                 /* If we haven't exceeded the limit for this query,
2454                  * build a chain of answers to store. If we hit the
2455                  * limit, empty the chain and ignore the rest.
2456                  */
2457                 if ( !si->over ) {
2458                         slap_overinst *on = si->on;
2459                         cache_manager *cm = on->on_bi.bi_private;
2460
2461                         /* check if the entry contains undefined
2462                          * attributes/objectClasses (ITS#5680) */
2463                         if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2464                                 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2465                                         op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2466                                 goto over;
2467                         }
2468
2469                         /* check for malformed entries: attrs with no values */
2470                         {
2471                                 Attribute *a = rs->sr_entry->e_attrs;
2472                                 for (; a; a=a->a_next) {
2473                                         if ( !a->a_numvals ) {
2474                                                 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2475                                                 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2476                                                 a->a_desc->ad_cname.bv_val );
2477                                                 goto over;
2478                                         }
2479                                 }
2480                         }
2481
2482                         if ( si->count < si->max ) {
2483                                 si->count++;
2484                                 e = entry_dup( rs->sr_entry );
2485                                 if ( !si->head ) si->head = e;
2486                                 if ( si->tail ) si->tail->e_private = e;
2487                                 si->tail = e;
2488
2489                         } else {
2490 over:;
2491                                 si->over = 1;
2492                                 si->count = 0;
2493                                 for (;si->head; si->head=e) {
2494                                         e = si->head->e_private;
2495                                         si->head->e_private = NULL;
2496                                         entry_free(si->head);
2497                                 }
2498                                 si->tail = NULL;
2499                         }
2500                 }
2501                 if ( si->slimit_exceeded ) {
2502                         return 0;
2503                 }
2504         } else if ( rs->sr_type == REP_RESULT ) {
2505
2506                 if ( si->count ) {
2507                         if ( rs->sr_err == LDAP_SUCCESS ) {
2508                                 si->caching_reason = PC_POSITIVE;
2509
2510                         } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2511                                 && si->qtemp->limitttl )
2512                         {
2513                                 Entry *e;
2514
2515                                 si->caching_reason = PC_SIZELIMIT;
2516                                 for (;si->head; si->head=e) {
2517                                         e = si->head->e_private;
2518                                         si->head->e_private = NULL;
2519                                         entry_free(si->head);
2520                                 }
2521                         }
2522
2523                 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2524                                 rs->sr_err == LDAP_SUCCESS )
2525                 {
2526                         si->caching_reason = PC_NEGATIVE;
2527                 }
2528
2529
2530                 if ( si->slimit_exceeded ) {
2531                         rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2532                 }
2533         }
2534
2535         return SLAP_CB_CONTINUE;
2536 }
2537
2538 /* NOTE: this is a quick workaround to let pcache minimally interact
2539  * with pagedResults.  A more articulated solutions would be to
2540  * perform the remote query without control and cache all results,
2541  * performing the pagedResults search only within the client
2542  * and the proxy.  This requires pcache to understand pagedResults. */
2543 static int
2544 pcache_chk_controls(
2545         Operation       *op,
2546         SlapReply       *rs )
2547 {
2548         const char      *non = "";
2549         const char      *stripped = "";
2550
2551         switch( op->o_pagedresults ) {
2552         case SLAP_CONTROL_NONCRITICAL:
2553                 non = "non-";
2554                 stripped = "; stripped";
2555                 /* fallthru */
2556
2557         case SLAP_CONTROL_CRITICAL:
2558                 Debug( pcache_debug, "%s: "
2559                         "%scritical pagedResults control "
2560                         "disabled with proxy cache%s.\n",
2561                         op->o_log_prefix, non, stripped );
2562
2563                 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2564                 break;
2565
2566         default:
2567                 rs->sr_err = SLAP_CB_CONTINUE;
2568                 break;
2569         }
2570
2571         return rs->sr_err;
2572 }
2573
2574 static int
2575 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2576 {
2577         struct berval vals[2];
2578
2579         {
2580                 const char *text = NULL;
2581                 BER_BVZERO( &vals[0] );
2582                 slap_passwd_hash( pwd, &vals[0], &text );
2583                 if ( BER_BVISEMPTY( &vals[0] )) {
2584                         Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2585                                 text, 0, 0 );
2586                         return LDAP_OTHER;
2587                 }
2588         }
2589
2590         BER_BVZERO( &vals[1] );
2591
2592         {
2593                 Modifications mod;
2594                 SlapReply sr = { REP_RESULT };
2595                 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2596                 int rc;
2597
2598                 mod.sml_op = LDAP_MOD_REPLACE;
2599                 mod.sml_flags = 0;
2600                 mod.sml_desc = slap_schema.si_ad_userPassword;
2601                 mod.sml_type = mod.sml_desc->ad_cname;
2602                 mod.sml_values = vals;
2603                 mod.sml_nvalues = NULL;
2604                 mod.sml_numvals = 1;
2605                 mod.sml_next = NULL;
2606
2607                 op->o_tag = LDAP_REQ_MODIFY;
2608                 op->orm_modlist = &mod;
2609                 op->o_bd = &cm->db;
2610                 op->o_dn = op->o_bd->be_rootdn;
2611                 op->o_ndn = op->o_bd->be_rootndn;
2612                 op->o_callback = &cb;
2613                 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2614                         op->o_req_dn.bv_val, 0, 0 );
2615                 rc = op->o_bd->be_modify( op, &sr );
2616                 ch_free( vals[0].bv_val );
2617                 return rc;
2618         }
2619 }
2620
2621 typedef struct bindcacheinfo {
2622         slap_overinst *on;
2623         CachedQuery *qc;
2624 } bindcacheinfo;
2625
2626 static int
2627 pc_bind_save( Operation *op, SlapReply *rs )
2628 {
2629         if ( rs->sr_err == LDAP_SUCCESS ) {
2630                 bindcacheinfo *bci = op->o_callback->sc_private;
2631                 slap_overinst *on = bci->on;
2632                 cache_manager *cm = on->on_bi.bi_private;
2633                 CachedQuery *qc = bci->qc;
2634                 int delete = 0;
2635
2636                 ldap_pvt_thread_rdwr_wlock( &qc->rwlock );
2637                 if ( qc->bind_refcnt-- ) {
2638                         Operation op2 = *op;
2639                         if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2640                                 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2641                 } else {
2642                         bci->qc = NULL;
2643                         delete = 1;
2644                 }
2645                 ldap_pvt_thread_rdwr_wunlock( &qc->rwlock );
2646                 if ( delete ) free_query(qc);
2647         }
2648         return SLAP_CB_CONTINUE;
2649 }
2650
2651 static Filter *
2652 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2653         struct berval *fbv )
2654 {
2655         int i, len = 0;
2656         struct berval *vals, pres = BER_BVC("*");
2657         char *p1, *p2;
2658         Attribute *a;
2659
2660         vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2661                 op->o_tmpmemctx );
2662
2663         for ( i=0; i<temp->bindnattrs; i++ ) {
2664                 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2665                 if ( a && a->a_vals ) {
2666                         vals[i] = a->a_vals[0];
2667                         len += a->a_vals[0].bv_len;
2668                 } else {
2669                         vals[i] = pres;
2670                 }
2671         }
2672         fbv->bv_len = len + temp->bindftemp.bv_len;
2673         fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2674
2675         p1 = temp->bindftemp.bv_val;
2676         p2 = fbv->bv_val;
2677         i = 0;
2678         while ( *p1 ) {
2679                 *p2++ = *p1;
2680                 if ( p1[0] == '=' && p1[1] == ')' ) {
2681                         AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2682                         p2 += vals[i].bv_len;
2683                         i++;
2684                 }
2685                 p1++;
2686         }
2687         *p2 = '\0';
2688         op->o_tmpfree( vals, op->o_tmpmemctx );
2689
2690         /* FIXME: are we sure str2filter_x can't fail?
2691          * caller needs to check */
2692         {
2693                 Filter *f = str2filter_x( op, fbv->bv_val );
2694                 assert( f != NULL );
2695                 return f;
2696         }
2697 }
2698
2699 /* Check if the requested entry is from the cache and has a valid
2700  * ttr and password hash
2701  */
2702 static int
2703 pc_bind_search( Operation *op, SlapReply *rs )
2704 {
2705         if ( rs->sr_type == REP_SEARCH ) {
2706                 bindinfo *pbi = op->o_callback->sc_private;
2707
2708                 /* We only care if this is an already cached result and we're
2709                  * below the refresh time, or we're offline.
2710                  */
2711                 if ( pbi->bi_cq ) {
2712                         if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2713                                 op->o_time < pbi->bi_cq->bindref_time ) {
2714                                 Attribute *a;
2715
2716                                 /* See if a recognized password is hashed here */
2717                                 a = attr_find( rs->sr_entry->e_attrs,
2718                                         slap_schema.si_ad_userPassword );
2719                                 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2720                                         lutil_passwd_scheme( a->a_vals[0].bv_val ))
2721                                         pbi->bi_flags |= BI_HASHED;
2722                         } else {
2723                                 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2724                                         "reftime: %ld, current time: %ld\n",
2725                                         pbi->bi_cq->bindref_time, op->o_time, 0 );
2726                         }
2727                 } else if ( pbi->bi_si ) {
2728                         /* This search result is going into the cache */
2729                         struct berval fbv;
2730                         Filter *f;
2731
2732                         filter_free( pbi->bi_si->query.filter );
2733                         f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2734                         op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2735                         pbi->bi_si->query.filter = filter_dup( f, NULL );
2736                         filter_free_x( op, f, 1 );
2737                 }
2738         }
2739         return 0;
2740 }
2741
2742 /* We always want pc_bind_search to run after the search handlers */
2743 static int
2744 pc_bind_resp( Operation *op, SlapReply *rs )
2745 {
2746         bindinfo *pbi = op->o_callback->sc_private;
2747         if ( !( pbi->bi_flags & BI_DIDCB )) {
2748                 slap_callback *sc = op->o_callback;
2749                 while ( sc && sc->sc_response != pcache_response )
2750                         sc = sc->sc_next;
2751                 if ( !sc )
2752                         sc = op->o_callback;
2753                 pbi->bi_cb.sc_next = sc->sc_next;
2754                 sc->sc_next = &pbi->bi_cb;
2755                 pbi->bi_flags |= BI_DIDCB;
2756         }
2757         return SLAP_CB_CONTINUE;
2758 }
2759
2760 #ifdef PCACHE_CONTROL_PRIVDB
2761 static int
2762 pcache_op_privdb(
2763         Operation               *op,
2764         SlapReply               *rs )
2765 {
2766         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
2767         cache_manager   *cm = on->on_bi.bi_private;
2768         slap_callback   *save_cb;
2769         slap_op_t       type;
2770
2771         /* skip if control is unset */
2772         if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2773                 return SLAP_CB_CONTINUE;
2774         }
2775
2776         /* The cache DB isn't open yet */
2777         if ( cm->defer_db_open ) {
2778                 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2779                         "pcachePrivDB: cacheDB not available" );
2780                 return rs->sr_err;
2781         }
2782
2783         /* FIXME: might be a little bit exaggerated... */
2784         if ( !be_isroot( op ) ) {
2785                 save_cb = op->o_callback;
2786                 op->o_callback = NULL;
2787                 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2788                         "pcachePrivDB: operation not allowed" );
2789                 op->o_callback = save_cb;
2790
2791                 return rs->sr_err;
2792         }
2793
2794         /* map tag to operation */
2795         type = slap_req2op( op->o_tag );
2796         if ( type != SLAP_OP_LAST ) {
2797                 BI_op_func      **func;
2798                 int             rc;
2799
2800                 /* execute, if possible */
2801                 func = &cm->db.be_bind;
2802                 if ( func[ type ] != NULL ) {
2803                         Operation       op2 = *op;
2804
2805                         op2.o_bd = &cm->db;
2806
2807                         rc = func[ type ]( &op2, rs );
2808                         if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2809                                 op->o_conn->c_authz_cookie = cm->db.be_private;
2810                         }
2811
2812                         return rs->sr_err;
2813                 }
2814         }
2815
2816         /* otherwise fall back to error */
2817         save_cb = op->o_callback;
2818         op->o_callback = NULL;
2819         send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2820                 "operation not supported with pcachePrivDB control" );
2821         op->o_callback = save_cb;
2822
2823         return rs->sr_err;
2824 }
2825 #endif /* PCACHE_CONTROL_PRIVDB */
2826
2827 static int
2828 pcache_op_bind(
2829         Operation               *op,
2830         SlapReply               *rs )
2831 {
2832         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
2833         cache_manager   *cm = on->on_bi.bi_private;
2834         QueryTemplate *temp;
2835         Entry *e;
2836         slap_callback   cb = { 0 }, *sc;
2837         bindinfo bi;
2838         bindcacheinfo *bci;
2839         Operation op2;
2840         int rc;
2841
2842 #ifdef PCACHE_CONTROL_PRIVDB
2843         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2844                 return pcache_op_privdb( op, rs );
2845 #endif /* PCACHE_CONTROL_PRIVDB */
2846
2847         /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2848         if ( !cm->cache_binds || cm->defer_db_open )
2849                 return SLAP_CB_CONTINUE;
2850
2851         /* First find a matching template with Bind info */
2852         for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2853                 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2854                         break;
2855         }
2856         /* Didn't find a suitable template, just passthru */
2857         if ( !temp )
2858                 return SLAP_CB_CONTINUE;
2859
2860         /* See if the entry is already locally cached. If so, we can
2861          * populate the query filter to retrieve the cached query. We
2862          * need to check the bindrefresh time in the query.
2863          */
2864         op2 = *op;
2865         op2.o_dn = op->o_bd->be_rootdn;
2866         op2.o_ndn = op->o_bd->be_rootndn;
2867         bi.bi_flags = 0;
2868
2869         op2.o_bd = &cm->db;
2870         e = NULL;
2871         rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2872         if ( rc == LDAP_SUCCESS && e ) {
2873                 bi.bi_flags |= BI_LOOKUP;
2874                 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2875                 be_entry_release_r( &op2, e );
2876         } else {
2877                 op2.ors_filter = temp->bindfilter;
2878                 op2.ors_filterstr = temp->bindfilterstr;
2879         }
2880
2881         op2.o_bd = op->o_bd;
2882         op2.o_tag = LDAP_REQ_SEARCH;
2883         op2.ors_scope = LDAP_SCOPE_BASE;
2884         op2.ors_deref = LDAP_DEREF_NEVER;
2885         op2.ors_slimit = 1;
2886         op2.ors_tlimit = SLAP_NO_LIMIT;
2887         op2.ors_limit = NULL;
2888         op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2889         op2.ors_attrsonly = 0;
2890
2891         /* We want to invoke search at the same level of the stack
2892          * as we're already at...
2893          */
2894         bi.bi_cm = cm;
2895         bi.bi_templ = temp;
2896         bi.bi_cq = NULL;
2897         bi.bi_si = NULL;
2898
2899         bi.bi_cb.sc_response = pc_bind_search;
2900         bi.bi_cb.sc_cleanup = NULL;
2901         bi.bi_cb.sc_private = &bi;
2902         cb.sc_private = &bi;
2903         cb.sc_response = pc_bind_resp;
2904         op2.o_callback = &cb;
2905         overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2906
2907         /* OK, just bind locally */
2908         if ( bi.bi_flags & BI_HASHED ) {
2909                 int delete = 0;
2910                 BackendDB *be = op->o_bd;
2911                 op->o_bd = &cm->db;
2912
2913                 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2914                         op->o_req_dn.bv_val, 0, 0 );
2915
2916                 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2917                         op->o_conn->c_authz_cookie = cm->db.be_private;
2918                 }
2919                 op->o_bd = be;
2920                 ldap_pvt_thread_rdwr_wlock( &bi.bi_cq->rwlock );
2921                 if ( !bi.bi_cq->bind_refcnt-- ) {
2922                         delete = 1;
2923                 }
2924                 ldap_pvt_thread_rdwr_wunlock( &bi.bi_cq->rwlock );
2925                 if ( delete ) free_query( bi.bi_cq );
2926                 return rs->sr_err;
2927         }
2928
2929         /* We have a cached query to work with */
2930         if ( bi.bi_cq ) {
2931                 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2932                         op->o_tmpmemctx );
2933                 sc->sc_response = pc_bind_save;
2934                 sc->sc_cleanup = NULL;
2935                 sc->sc_private = sc+1;
2936                 bci = sc->sc_private;
2937                 sc->sc_next = op->o_callback;
2938                 op->o_callback = sc;
2939                 bci->on = on;
2940                 bci->qc = bi.bi_cq;
2941         }
2942         return SLAP_CB_CONTINUE;
2943 }
2944
2945 static slap_response refresh_merge;
2946
2947 static int
2948 pcache_op_search(
2949         Operation       *op,
2950         SlapReply       *rs )
2951 {
2952         slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2953         cache_manager *cm = on->on_bi.bi_private;
2954         query_manager*          qm = cm->qm;
2955
2956         int i = -1;
2957
2958         Query           query;
2959         QueryTemplate   *qtemp = NULL;
2960         bindinfo *pbi = NULL;
2961
2962         int             attr_set = -1;
2963         CachedQuery     *answerable = NULL;
2964         int             cacheable = 0;
2965
2966         struct berval   tempstr;
2967
2968 #ifdef PCACHE_CONTROL_PRIVDB
2969         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2970                 return pcache_op_privdb( op, rs );
2971         }
2972 #endif /* PCACHE_CONTROL_PRIVDB */
2973
2974         /* The cache DB isn't open yet */
2975         if ( cm->defer_db_open ) {
2976                 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2977                         "pcachePrivDB: cacheDB not available" );
2978                 return rs->sr_err;
2979         }
2980
2981         /* pickup runtime ACL changes */
2982         cm->db.be_acl = op->o_bd->be_acl;
2983
2984         {
2985                 /* See if we're processing a Bind request
2986                  * or a cache refresh */
2987                 slap_callback *cb = op->o_callback;
2988
2989                 for ( ; cb; cb=cb->sc_next ) {
2990                         if ( cb->sc_response == pc_bind_resp ) {
2991                                 pbi = cb->sc_private;
2992                                 break;
2993                         }
2994                         if ( cb->sc_response == refresh_merge ) {
2995                                 /* This is a refresh, do not search the cache */
2996                                 return SLAP_CB_CONTINUE;
2997                         }
2998                 }
2999         }
3000
3001         /* FIXME: cannot cache/answer requests with pagedResults control */
3002
3003         query.filter = op->ors_filter;
3004
3005         if ( pbi ) {
3006                 query.base = pbi->bi_templ->bindbase;
3007                 query.scope = pbi->bi_templ->bindscope;
3008                 attr_set = pbi->bi_templ->attr_set_index;
3009                 cacheable = 1;
3010                 qtemp = pbi->bi_templ;
3011                 if ( pbi->bi_flags & BI_LOOKUP )
3012                         answerable = qm->qcfunc(op, qm, &query, qtemp);
3013
3014         } else {
3015                 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
3016                         op->o_tmpmemctx );
3017                 tempstr.bv_len = 0;
3018                 if ( filter2template( op, op->ors_filter, &tempstr ))
3019                 {
3020                         op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
3021                         return SLAP_CB_CONTINUE;
3022                 }
3023
3024                 Debug( pcache_debug, "query template of incoming query = %s\n",
3025                                                 tempstr.bv_val, 0, 0 );
3026
3027                 /* find attr set */
3028                 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
3029
3030                 query.base = op->o_req_ndn;
3031                 query.scope = op->ors_scope;
3032
3033                 /* check for query containment */
3034                 if (attr_set > -1) {
3035                         QueryTemplate *qt = qm->attr_sets[attr_set].templates;
3036                         for (; qt; qt = qt->qtnext ) {
3037                                 /* find if template i can potentially answer tempstr */
3038                                 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
3039                                         continue;
3040                                 cacheable = 1;
3041                                 qtemp = qt;
3042                                 Debug( pcache_debug, "Entering QC, querystr = %s\n",
3043                                                 op->ors_filterstr.bv_val, 0, 0 );
3044                                 answerable = qm->qcfunc(op, qm, &query, qt);
3045
3046                                 /* if != NULL, rlocks qtemp->t_rwlock */
3047                                 if (answerable)
3048                                         break;
3049                         }
3050                 }
3051                 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
3052         }
3053
3054         if (answerable) {
3055                 BackendDB       *save_bd = op->o_bd;
3056
3057                 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
3058                 answerable->answerable_cnt++;
3059                 /* we only care about refcnts if we're refreshing */
3060                 if ( answerable->refresh_time )
3061                         answerable->refcnt++;
3062                 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3063                         answerable->answerable_cnt, 0, 0 );
3064                 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3065
3066                 ldap_pvt_thread_rdwr_wlock(&answerable->rwlock);
3067                 if ( BER_BVISNULL( &answerable->q_uuid )) {
3068                         /* No entries cached, just an empty result set */
3069                         i = rs->sr_err = 0;
3070                         send_ldap_result( op, rs );
3071                 } else {
3072                         /* Let Bind know we used a cached query */
3073                         if ( pbi ) {
3074                                 answerable->bind_refcnt++;
3075                                 pbi->bi_cq = answerable;
3076                         }
3077
3078                         op->o_bd = &cm->db;
3079                         if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3080                                 slap_callback cb;
3081                                 /* The cached entry was already processed by any
3082                                  * other overlays, so don't let it get processed again.
3083                                  *
3084                                  * This loop removes over_back_response from the stack.
3085                                  */
3086                                 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3087                                         slap_callback **scp;
3088                                         for ( scp = &op->o_callback; *scp != NULL;
3089                                                 scp = &(*scp)->sc_next ) {
3090                                                 if ( (*scp)->sc_next == &cb ) {
3091                                                         *scp = cb.sc_next;
3092                                                         break;
3093                                                 }
3094                                         }
3095                                 }
3096                         }
3097                         i = cm->db.bd_info->bi_op_search( op, rs );
3098                 }
3099                 ldap_pvt_thread_rdwr_wunlock(&answerable->rwlock);
3100                 /* locked by qtemp->qcfunc (query_containment) */
3101                 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3102                 op->o_bd = save_bd;
3103                 return i;
3104         }
3105
3106         Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3107
3108         ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3109         if (cm->num_cached_queries >= cm->max_queries) {
3110                 cacheable = 0;
3111         }
3112         ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3113
3114         if (op->ors_attrsonly)
3115                 cacheable = 0;
3116
3117         if (cacheable) {
3118                 slap_callback           *cb;
3119                 struct search_info      *si;
3120
3121                 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3122                 query.filter = filter_dup(op->ors_filter, NULL);
3123
3124                 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3125                 cb->sc_response = pcache_response;
3126                 cb->sc_cleanup = pcache_op_cleanup;
3127                 cb->sc_private = (cb+1);
3128                 si = cb->sc_private;
3129                 si->on = on;
3130                 si->query = query;
3131                 si->qtemp = qtemp;
3132                 si->max = cm->num_entries_limit ;
3133                 si->over = 0;
3134                 si->count = 0;
3135                 si->slimit = 0;
3136                 si->slimit_exceeded = 0;
3137                 si->caching_reason = PC_IGNORE;
3138                 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3139                         si->slimit = op->ors_slimit;
3140                         op->ors_slimit = cm->num_entries_limit;
3141                 }
3142                 si->head = NULL;
3143                 si->tail = NULL;
3144                 si->swap_saved_attrs = 1;
3145                 si->save_attrs = op->ors_attrs;
3146                 si->pbi = pbi;
3147                 if ( pbi )
3148                         pbi->bi_si = si;
3149
3150                 op->ors_attrs = qtemp->t_attrs.attrs;
3151
3152                 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3153                         cb->sc_next = op->o_callback;
3154                         op->o_callback = cb;
3155
3156                 } else {
3157                         slap_callback           **pcb;
3158
3159                         /* need to move the callback at the end, in case other
3160                          * overlays are present, so that the final entry is
3161                          * actually cached */
3162                         cb->sc_next = NULL;
3163                         for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3164                         *pcb = cb;
3165                 }
3166
3167         } else {
3168                 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3169                                         0, 0, 0);
3170         }
3171
3172         return SLAP_CB_CONTINUE;
3173 }
3174
3175 static int
3176 get_attr_set(
3177         AttributeName* attrs,
3178         query_manager* qm,
3179         int num )
3180 {
3181         int i = 0;
3182         int count = 0;
3183
3184         if ( attrs ) {
3185                 for ( ; attrs[i].an_name.bv_val; i++ ) {
3186                         /* only count valid attribute names
3187                          * (searches ignore others, this overlay does the same) */
3188                         if ( attrs[i].an_desc ) {
3189                                 count++;
3190                         }
3191                 }
3192         }
3193
3194         /* recognize default or explicit single "*" */
3195         if ( ! attrs ||
3196                 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_all_user_attrs ) ) )
3197         {
3198                 count = 1;
3199                 attrs = slap_anlist_all_user_attributes;
3200
3201         /* recognize implicit (no valid attributes) or explicit single "1.1" */
3202         } else if ( count == 0 ||
3203                 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) )
3204         {
3205                 count = 0;
3206                 attrs = NULL;
3207         }
3208
3209         for ( i = 0; i < num; i++ ) {
3210                 AttributeName *a2;
3211                 int found = 1;
3212
3213                 if ( count > qm->attr_sets[i].count ) {
3214                         if ( qm->attr_sets[i].count &&
3215                                 bvmatch( &qm->attr_sets[i].attrs[0].an_name, slap_bv_all_user_attrs )) {
3216                                 break;
3217                         }
3218                         continue;
3219                 }
3220
3221                 if ( !count ) {
3222                         if ( !qm->attr_sets[i].count ) {
3223                                 break;
3224                         }
3225                         continue;
3226                 }
3227
3228                 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3229                         if ( !a2->an_desc && !bvmatch( &a2->an_name, slap_bv_all_user_attrs ) ) continue;
3230
3231                         if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3232                                 found = 0;
3233                                 break;
3234                         }
3235                 }
3236
3237                 if ( found ) {
3238                         break;
3239                 }
3240         }
3241
3242         if ( i == num ) {
3243                 i = -1;
3244         }
3245
3246         return i;
3247 }
3248
3249 /* Refresh a cached query:
3250  * 1: Replay the query on the remote DB and merge each entry into
3251  * the local DB. Remember the DNs of each remote entry.
3252  * 2: Search the local DB for all entries matching this queryID.
3253  * Delete any entry whose DN is not in the list from (1).
3254  */
3255 typedef struct dnlist {
3256         struct dnlist *next;
3257         struct berval dn;
3258         char delete;
3259 } dnlist;
3260
3261 typedef struct refresh_info {
3262         dnlist *ri_dns;
3263         dnlist *ri_tail;
3264         dnlist *ri_dels;
3265         BackendDB *ri_be;
3266         CachedQuery *ri_q;
3267 } refresh_info;
3268
3269 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3270 {
3271         dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3272                         op->o_tmpmemctx );
3273         dn->dn.bv_len = bvdn->bv_len;
3274         dn->dn.bv_val = (char *)(dn+1);
3275         AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3276         dn->dn.bv_val[dn->dn.bv_len] = '\0';
3277         return dn;
3278 }
3279
3280 static int
3281 refresh_merge( Operation *op, SlapReply *rs )
3282 {
3283         if ( rs->sr_type == REP_SEARCH ) {
3284                 refresh_info *ri = op->o_callback->sc_private;
3285                 Entry *e;
3286                 dnlist *dnl;
3287                 slap_callback *ocb;
3288                 int rc;
3289
3290                 ocb = op->o_callback;
3291                 /* Find local entry, merge */
3292                 op->o_bd = ri->ri_be;
3293                 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3294                 if ( rc != LDAP_SUCCESS || e == NULL ) {
3295                         /* No local entry, just add it. FIXME: we are not checking
3296                          * the cache entry limit here
3297                          */
3298                          merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3299                 } else {
3300                         /* Entry exists, update it */
3301                         Entry ne;
3302                         Attribute *a, **b;
3303                         Modifications *modlist, *mods = NULL;
3304                         const char*     text = NULL;
3305                         char                    textbuf[SLAP_TEXT_BUFLEN];
3306                         size_t                  textlen = sizeof(textbuf);
3307                         slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3308
3309                         ne = *e;
3310                         b = &ne.e_attrs;
3311                         /* Get a copy of only the attrs we requested */
3312                         for ( a=e->e_attrs; a; a=a->a_next ) {
3313                                 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3314                                         *b = attr_alloc( a->a_desc );
3315                                         *(*b) = *a;
3316                                         /* The actual values still belong to e */
3317                                         (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3318                                                 SLAP_ATTR_DONT_FREE_DATA;
3319                                         b = &((*b)->a_next);
3320                                 }
3321                         }
3322                         *b = NULL;
3323                         slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3324                         syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3325                                 &mods, &modlist, 0 );
3326                         be_entry_release_r( op, e );
3327                         attrs_free( ne.e_attrs );
3328                         slap_mods_free( modlist, 1 );
3329                         /* mods is NULL if there are no changes */
3330                         if ( mods ) {
3331                                 SlapReply rs2 = { REP_RESULT };
3332                                 struct berval dn = op->o_req_dn;
3333                                 struct berval ndn = op->o_req_ndn;
3334                                 op->o_tag = LDAP_REQ_MODIFY;
3335                                 op->orm_modlist = mods;
3336                                 op->o_req_dn = rs->sr_entry->e_name;
3337                                 op->o_req_ndn = rs->sr_entry->e_nname;
3338                                 op->o_callback = &cb;
3339                                 op->o_bd->be_modify( op, &rs2 );
3340                                 rs->sr_err = rs2.sr_err;
3341                                 rs_assert_done( &rs2 );
3342                                 slap_mods_free( mods, 1 );
3343                                 op->o_req_dn = dn;
3344                                 op->o_req_ndn = ndn;
3345                         }
3346                 }
3347
3348                 /* Add DN to list */
3349                 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3350                 dnl->next = NULL;
3351                 if ( ri->ri_tail ) {
3352                         ri->ri_tail->next = dnl;
3353                 } else {
3354                         ri->ri_dns = dnl;
3355                 }
3356                 ri->ri_tail = dnl;
3357                 op->o_callback = ocb;
3358         }
3359         return 0;
3360 }
3361
3362 static int
3363 refresh_purge( Operation *op, SlapReply *rs )
3364 {
3365         if ( rs->sr_type == REP_SEARCH ) {
3366                 refresh_info *ri = op->o_callback->sc_private;
3367                 dnlist **dn;
3368                 int del = 1;
3369
3370                 /* Did the entry exist on the remote? */
3371                 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3372                         if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3373                                 dnlist *dnext = (*dn)->next;
3374                                 op->o_tmpfree( *dn, op->o_tmpmemctx );
3375                                 *dn = dnext;
3376                                 del = 0;
3377                                 break;
3378                         }
3379                 }
3380                 /* No, so put it on the list to delete */
3381                 if ( del ) {
3382                         Attribute *a;
3383                         dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3384                         dnl->next = ri->ri_dels;
3385                         ri->ri_dels = dnl;
3386                         a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3387                         /* If ours is the only queryId, delete entry */
3388                         dnl->delete = ( a->a_numvals == 1 );
3389                 }
3390         }
3391         return 0;
3392 }
3393
3394 static int
3395 refresh_query( Operation *op, CachedQuery *query, slap_overinst *on )
3396 {
3397         SlapReply rs = {REP_RESULT};
3398         slap_callback cb = { 0 };
3399         refresh_info ri = { 0 };
3400         char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3401         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
3402         Filter filter = {LDAP_FILTER_EQUALITY};
3403         AttributeName attrs[ 2 ] = {{{ 0 }}};
3404         dnlist *dn;
3405         int rc;
3406
3407         ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3408         query->refcnt = 0;
3409         ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3410
3411         cb.sc_response = refresh_merge;
3412         cb.sc_private = &ri;
3413
3414         /* cache DB */
3415         ri.ri_be = op->o_bd;
3416         ri.ri_q = query;
3417
3418         op->o_tag = LDAP_REQ_SEARCH;
3419         op->o_protocol = LDAP_VERSION3;
3420         op->o_callback = &cb;
3421         op->o_do_not_cache = 1;
3422
3423         op->o_req_dn = query->qbase->base;
3424         op->o_req_ndn = query->qbase->base;
3425         op->ors_scope = query->scope;
3426         op->ors_deref = LDAP_DEREF_NEVER;
3427         op->ors_slimit = SLAP_NO_LIMIT;
3428         op->ors_tlimit = SLAP_NO_LIMIT;
3429         op->ors_limit = NULL;
3430         op->ors_filter = query->filter;
3431         filter2bv_x( op, query->filter, &op->ors_filterstr );
3432         op->ors_attrs = query->qtemp->t_attrs.attrs;
3433         op->ors_attrsonly = 0;
3434
3435         op->o_bd = on->on_info->oi_origdb;
3436         rc = op->o_bd->be_search( op, &rs );
3437         if ( rc ) {
3438                 op->o_bd = ri.ri_be;
3439                 goto leave;
3440         }
3441
3442         /* Get the DNs of all entries matching this query */
3443         cb.sc_response = refresh_purge;
3444
3445         op->o_bd = ri.ri_be;
3446         op->o_req_dn = op->o_bd->be_suffix[0];
3447         op->o_req_ndn = op->o_bd->be_nsuffix[0];
3448         op->ors_scope = LDAP_SCOPE_SUBTREE;
3449         op->ors_deref = LDAP_DEREF_NEVER;
3450         op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3451                 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3452         filter.f_ava = &ava;
3453         filter.f_av_desc = ad_queryId;
3454         filter.f_av_value = query->q_uuid;
3455         attrs[ 0 ].an_desc = ad_queryId;
3456         attrs[ 0 ].an_name = ad_queryId->ad_cname;
3457         op->ors_attrs = attrs;
3458         op->ors_attrsonly = 0;
3459         rs_reinit( &rs, REP_RESULT );
3460         rc = op->o_bd->be_search( op, &rs );
3461         if ( rc ) goto leave;
3462
3463         while (( dn = ri.ri_dels )) {
3464                 op->o_req_dn = dn->dn;
3465                 op->o_req_ndn = dn->dn;
3466                 rs_reinit( &rs, REP_RESULT );
3467                 if ( dn->delete ) {
3468                         op->o_tag = LDAP_REQ_DELETE;
3469                         op->o_bd->be_delete( op, &rs );
3470                 } else {
3471                         Modifications mod;
3472                         struct berval vals[2];
3473
3474                         vals[0] = query->q_uuid;
3475                         BER_BVZERO( &vals[1] );
3476                         mod.sml_op = LDAP_MOD_DELETE;
3477                         mod.sml_flags = 0;
3478                         mod.sml_desc = ad_queryId;
3479                         mod.sml_type = ad_queryId->ad_cname;
3480                         mod.sml_values = vals;
3481                         mod.sml_nvalues = NULL;
3482                         mod.sml_numvals = 1;
3483                         mod.sml_next = NULL;
3484
3485                         op->o_tag = LDAP_REQ_MODIFY;
3486                         op->orm_modlist = &mod;
3487                         op->o_bd->be_modify( op, &rs );
3488                 }
3489                 ri.ri_dels = dn->next;
3490                 op->o_tmpfree( dn, op->o_tmpmemctx );
3491         }
3492
3493 leave:
3494         /* reset our local heap, we're done with it */
3495         slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3496         return rc;
3497 }
3498
3499 static void*
3500 consistency_check(
3501         void *ctx,
3502         void *arg )
3503 {
3504         struct re_s *rtask = arg;
3505         slap_overinst *on = rtask->arg;
3506         cache_manager *cm = on->on_bi.bi_private;
3507         query_manager *qm = cm->qm;
3508         Connection conn = {0};
3509         OperationBuffer opbuf;
3510         Operation *op;
3511
3512         CachedQuery *query, *qprev;
3513         int return_val, pause = PCACHE_CC_PAUSED;
3514         QueryTemplate *templ;
3515
3516         /* Don't expire anything when we're offline */
3517         if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3518                 pause = PCACHE_CC_OFFLINE;
3519                 goto leave;
3520         }
3521
3522         connection_fake_init( &conn, &opbuf, ctx );
3523         op = &opbuf.ob_op;
3524
3525         op->o_bd = &cm->db;
3526         op->o_dn = cm->db.be_rootdn;
3527         op->o_ndn = cm->db.be_rootndn;
3528
3529         cm->cc_arg = arg;
3530
3531         for (templ = qm->templates; templ; templ=templ->qmnext) {
3532                 time_t ttl;
3533                 if ( !templ->query_last ) continue;
3534                 pause = 0;
3535                 op->o_time = slap_get_time();
3536                 if ( !templ->ttr ) {
3537                         ttl = templ->ttl;
3538                         if ( templ->negttl && templ->negttl < ttl )
3539                                 ttl = templ->negttl;
3540                         if ( templ->limitttl && templ->limitttl < ttl )
3541                                 ttl = templ->limitttl;
3542                         /* The oldest timestamp that needs expiration checking */
3543                         ttl += op->o_time;
3544                 }
3545
3546                 for ( query=templ->query_last; query; query=qprev ) {
3547                         qprev = query->prev;
3548                         if ( query->refresh_time && query->refresh_time < op->o_time ) {
3549                                 /* A refresh will extend the expiry if the query has been
3550                                  * referenced, but not if it's unreferenced. If the
3551                                  * expiration has been hit, then skip the refresh since
3552                                  * we're just going to discard the result anyway.
3553                                  */
3554                                 if ( query->refcnt )
3555                                         query->expiry_time = op->o_time + templ->ttl;
3556                                 if ( query->expiry_time > op->o_time ) {
3557                                         refresh_query( op, query, on );
3558                                         continue;
3559                                 }
3560                         }
3561
3562                         if (query->expiry_time < op->o_time) {
3563                                 int rem = 0;
3564                                 Debug( pcache_debug, "Lock CR index = %p\n",
3565                                                 (void *) templ, 0, 0 );
3566                                 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3567                                 if ( query == templ->query_last ) {
3568                                         rem = 1;
3569                                         remove_from_template(query, templ);
3570                                         Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3571                                                         (void *) templ, templ->no_of_queries, 0 );
3572                                         Debug( pcache_debug, "Unlock CR index = %p\n",
3573                                                         (void *) templ, 0, 0 );
3574                                 }
3575                                 if ( !rem ) {
3576                                         ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3577                                         continue;
3578                                 }
3579                                 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3580                                 remove_query(qm, query);
3581                                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3582                                 if ( BER_BVISNULL( &query->q_uuid ))
3583                                         return_val = 0;
3584                                 else
3585                                         return_val = remove_query_data(op, &query->q_uuid);
3586                                 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3587                                                         return_val, 0, 0 );
3588                                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3589                                 cm->cur_entries -= return_val;
3590                                 cm->num_cached_queries--;
3591                                 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3592                                                 cm->num_cached_queries, 0, 0 );
3593                                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3594                                 Debug( pcache_debug,
3595                                         "STALE QUERY REMOVED, CACHE ="
3596                                         "%d entries\n",
3597                                         cm->cur_entries, 0, 0 );
3598                                 ldap_pvt_thread_rdwr_wlock( &query->rwlock );
3599                                 if ( query->bind_refcnt-- ) {
3600                                         rem = 0;
3601                                 } else {
3602                                         rem = 1;
3603                                 }
3604                                 ldap_pvt_thread_rdwr_wunlock( &query->rwlock );
3605                                 if ( rem ) free_query(query);
3606                                 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3607                         } else if ( !templ->ttr && query->expiry_time > ttl ) {
3608                                 /* We don't need to check for refreshes, and this
3609                                  * query's expiry is too new, and all subsequent queries
3610                                  * will be newer yet. So stop looking.
3611                                  *
3612                                  * If we have refreshes, then we always have to walk the
3613                                  * entire query list.
3614                                  */
3615                                 break;
3616                         }
3617                 }
3618         }
3619
3620 leave:
3621         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3622         if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3623                 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3624         }
3625         /* If there were no queries, defer processing for a while */
3626         if ( cm->cc_paused != pause )
3627                 cm->cc_paused = pause;
3628         ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3629
3630         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3631         return NULL;
3632 }
3633
3634
3635 #define MAX_ATTR_SETS 500
3636
3637 enum {
3638         PC_MAIN = 1,
3639         PC_ATTR,
3640         PC_TEMP,
3641         PC_RESP,
3642         PC_QUERIES,
3643         PC_OFFLINE,
3644         PC_BIND,
3645         PC_PRIVATE_DB
3646 };
3647
3648 static ConfigDriver pc_cf_gen;
3649 static ConfigLDAPadd pc_ldadd;
3650 static ConfigCfAdd pc_cfadd;
3651
3652 static ConfigTable pccfg[] = {
3653         { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3654                                 "<cycle_time",
3655                 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3656                 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3657                         "DESC 'Proxy Cache basic parameters' "
3658                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3659         { "pcacheAttrset", "index> <attributes...",
3660                 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3661                 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3662                         "DESC 'A set of attributes to cache' "
3663                         "EQUALITY caseIgnoreMatch "
3664                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3665         { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3666                         "<limitTTL> <TTR",
3667                 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3668                 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3669                         "DESC 'Filter template, attrset, cache TTL, "
3670                                 "optional negative TTL, optional sizelimit TTL, "
3671                                 "optional TTR' "
3672                         "EQUALITY caseIgnoreMatch "
3673                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3674         { "pcachePosition", "head|tail(default)",
3675                 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3676                 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3677                         "DESC 'Response callback position in overlay stack' "
3678                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3679         { "pcacheMaxQueries", "queries",
3680                 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3681                 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3682                         "DESC 'Maximum number of queries to cache' "
3683                         "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
3684         { "pcachePersist", "TRUE|FALSE",
3685                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3686                 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3687                         "DESC 'Save cached queries for hot restart' "
3688                         "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
3689         { "pcacheValidate", "TRUE|FALSE",
3690                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3691                 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3692                         "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3693                         "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
3694         { "pcacheOffline", "TRUE|FALSE",
3695                 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3696                 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3697                         "DESC 'Set cache to offline mode and disable expiration' "
3698                         "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
3699         { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3700                 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3701                 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3702                         "DESC 'Parameters for caching Binds' "
3703                         "EQUALITY caseIgnoreMatch "
3704                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3705         { "pcache-", "private database args",
3706                 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3707                 NULL, NULL, NULL },
3708
3709         /* Legacy keywords */
3710         { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3711                                 "<cycle_time",
3712                 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3713                 NULL, NULL, NULL },
3714         { "proxyattrset", "index> <attributes...",
3715                 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3716                 NULL, NULL, NULL },
3717         { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3718                 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3719                 NULL, NULL, NULL },
3720         { "response-callback", "head|tail(default)",
3721                 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3722                 NULL, NULL, NULL },
3723         { "proxyCacheQueries", "queries",
3724                 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3725                 NULL, NULL, NULL },
3726         { "proxySaveQueries", "TRUE|FALSE",
3727                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3728                 NULL, NULL, NULL },
3729         { "proxyCheckCacheability", "TRUE|FALSE",
3730                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3731                 NULL, NULL, NULL },
3732
3733         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3734 };
3735
3736 static ConfigOCs pcocs[] = {
3737         { "( OLcfgOvOc:2.1 "
3738                 "NAME 'olcPcacheConfig' "
3739                 "DESC 'ProxyCache configuration' "
3740                 "SUP olcOverlayConfig "
3741                 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3742                 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3743                         "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3744                 Cft_Overlay, pccfg, NULL, pc_cfadd },
3745         { "( OLcfgOvOc:2.2 "
3746                 "NAME 'olcPcacheDatabase' "
3747                 "DESC 'Cache database configuration' "
3748                 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3749         { NULL, 0, NULL }
3750 };
3751
3752 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3753
3754 static int
3755 pc_ldadd_cleanup( ConfigArgs *c )
3756 {
3757         slap_overinst *on = c->ca_private;
3758         return pcache_db_open2( on, &c->reply );
3759 }
3760
3761 static int
3762 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3763 {
3764         slap_overinst *on;
3765         cache_manager *cm;
3766
3767         if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3768                 p->ce_bi->bi_cf_ocs != pcocs )
3769                 return LDAP_CONSTRAINT_VIOLATION;
3770
3771         on = (slap_overinst *)p->ce_bi;
3772         cm = on->on_bi.bi_private;
3773         ca->be = &cm->db;
3774         /* Defer open if this is an LDAPadd */
3775         if ( CONFIG_ONLINE_ADD( ca ))
3776                 ca->cleanup = pc_ldadd_cleanup;
3777         else
3778                 cm->defer_db_open = 0;
3779         ca->ca_private = on;
3780         return LDAP_SUCCESS;
3781 }
3782
3783 static int
3784 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3785 {
3786         CfEntryInfo *pe = p->e_private;
3787         slap_overinst *on = (slap_overinst *)pe->ce_bi;
3788         cache_manager *cm = on->on_bi.bi_private;
3789         struct berval bv;
3790
3791         /* FIXME: should not hardcode "olcDatabase" here */
3792         bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3793                 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3794                 0, cm->db.bd_info->bi_type );
3795         if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3796                 return -1;
3797         }
3798         bv.bv_val = ca->cr_msg;
3799         ca->be = &cm->db;
3800         cm->defer_db_open = 0;
3801
3802         /* We can only create this entry if the database is table-driven
3803          */
3804         if ( cm->db.bd_info->bi_cf_ocs )
3805                 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3806                         &pcocs[1] );
3807
3808         return 0;
3809 }
3810
3811 static int
3812 pc_cf_gen( ConfigArgs *c )
3813 {
3814         slap_overinst   *on = (slap_overinst *)c->bi;
3815         cache_manager*  cm = on->on_bi.bi_private;
3816         query_manager*  qm = cm->qm;
3817         QueryTemplate*  temp;
3818         AttributeName*  attr_name;
3819         AttributeName*  attrarray;
3820         const char*     text=NULL;
3821         int             i, num, rc = 0;
3822         char            *ptr;
3823         unsigned long   t;
3824
3825         if ( c->op == SLAP_CONFIG_EMIT ) {
3826                 struct berval bv;
3827                 switch( c->type ) {
3828                 case PC_MAIN:
3829                         bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3830                                 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3831                                 cm->num_entries_limit, cm->cc_period );
3832                         bv.bv_val = c->cr_msg;
3833                         value_add_one( &c->rvalue_vals, &bv );
3834                         break;
3835                 case PC_ATTR:
3836                         for (i=0; i<cm->numattrsets; i++) {
3837                                 if ( !qm->attr_sets[i].count ) continue;
3838
3839                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3840
3841                                 /* count the attr length */
3842                                 for ( attr_name = qm->attr_sets[i].attrs;
3843                                         attr_name->an_name.bv_val; attr_name++ )
3844                                 {
3845                                         bv.bv_len += attr_name->an_name.bv_len + 1;
3846                                         if ( attr_name->an_desc &&
3847                                                         ( attr_name->an_desc->ad_flags & SLAP_DESC_TEMPORARY ) ) {
3848                                                 bv.bv_len += STRLENOF("undef:");
3849                                         }
3850                                 }
3851
3852                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
3853                                 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3854                                 for ( attr_name = qm->attr_sets[i].attrs;
3855                                         attr_name->an_name.bv_val; attr_name++ ) {
3856                                         *ptr++ = ' ';
3857                                         if ( attr_name->an_desc &&
3858                                                         ( attr_name->an_desc->ad_flags & SLAP_DESC_TEMPORARY ) ) {
3859                                                 ptr = lutil_strcopy( ptr, "undef:" );
3860                                         }
3861                                         ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3862                                 }
3863                                 ber_bvarray_add( &c->rvalue_vals, &bv );
3864                         }
3865                         if ( !c->rvalue_vals )
3866                                 rc = 1;
3867                         break;
3868                 case PC_TEMP:
3869                         for (temp=qm->templates; temp; temp=temp->qmnext) {
3870                                 /* HEADS-UP: always print all;
3871                                  * if optional == 0, ignore */
3872                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3873                                         " %d %ld %ld %ld %ld",
3874                                         temp->attr_set_index,
3875                                         temp->ttl,
3876                                         temp->negttl,
3877                                         temp->limitttl,
3878                                         temp->ttr );
3879                                 bv.bv_len += temp->querystr.bv_len + 2;
3880                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
3881                                 ptr = bv.bv_val;
3882                                 *ptr++ = '"';
3883                                 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3884                                 *ptr++ = '"';
3885                                 strcpy( ptr, c->cr_msg );
3886                                 ber_bvarray_add( &c->rvalue_vals, &bv );
3887                         }
3888                         if ( !c->rvalue_vals )
3889                                 rc = 1;
3890                         break;
3891                 case PC_BIND:
3892                         for (temp=qm->templates; temp; temp=temp->qmnext) {
3893                                 if ( !temp->bindttr ) continue;
3894                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3895                                         " %d %ld %s ",
3896                                         temp->attr_set_index,
3897                                         temp->bindttr,
3898                                         ldap_pvt_scope2str( temp->bindscope ));
3899                                 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3900                                 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3901                                 ptr = bv.bv_val;
3902                                 *ptr++ = '"';
3903                                 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3904                                 *ptr++ = '"';
3905                                 ptr = lutil_strcopy( ptr, c->cr_msg );
3906                                 *ptr++ = '"';
3907                                 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3908                                 *ptr++ = '"';
3909                                 *ptr = '\0';
3910                                 ber_bvarray_add( &c->rvalue_vals, &bv );
3911                         }
3912                         if ( !c->rvalue_vals )
3913                                 rc = 1;
3914                         break;
3915                 case PC_RESP:
3916                         if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3917                                 BER_BVSTR( &bv, "head" );
3918                         } else {
3919                                 BER_BVSTR( &bv, "tail" );
3920                         }
3921                         value_add_one( &c->rvalue_vals, &bv );
3922                         break;
3923                 case PC_QUERIES:
3924                         c->value_int = cm->max_queries;
3925                         break;
3926                 case PC_OFFLINE:
3927                         c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3928                         break;
3929                 }
3930                 return rc;
3931         } else if ( c->op == LDAP_MOD_DELETE ) {
3932                 rc = 1;
3933                 switch( c->type ) {
3934                 case PC_ATTR: /* FIXME */
3935                 case PC_TEMP:
3936                 case PC_BIND:
3937                         break;
3938                 case PC_OFFLINE:
3939                         cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3940                         /* If there were cached queries when we went offline,
3941                          * restart the checker now.
3942                          */
3943                         if ( cm->num_cached_queries ) {
3944                                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3945                                 cm->cc_paused = 0;
3946                                 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3947                                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3948                         }
3949                         rc = 0;
3950                         break;
3951                 }
3952                 return rc;
3953         }
3954
3955         switch( c->type ) {
3956         case PC_MAIN:
3957                 if ( cm->numattrsets > 0 ) {
3958                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3959                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3960                         return( 1 );
3961                 }
3962
3963                 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3964                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3965                                 c->argv[3] );
3966                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3967                         return( 1 );
3968                 }
3969                 if ( cm->numattrsets <= 0 ) {
3970                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3971                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3972                         return( 1 );
3973                 }
3974                 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3975                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3976                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3977                         return( 1 );
3978                 }
3979
3980                 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3981                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3982                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3983                         return( 1 );
3984                 }
3985
3986                 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3987                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3988                                 c->argv[2] );
3989                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3990                         return( 1 );
3991                 }
3992                 if ( cm->max_entries <= 0 ) {
3993                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3994                         Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3995                         return( 1 );
3996                 }
3997
3998                 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3999                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
4000                                 c->argv[4] );
4001                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4002                         return( 1 );
4003                 }
4004                 if ( cm->num_entries_limit <= 0 ) {
4005                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
4006                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4007                         return( 1 );
4008                 }
4009                 if ( cm->num_entries_limit > cm->max_entries ) {
4010                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
4011                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4012                         return( 1 );
4013                 }
4014
4015                 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4016                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
4017                                 c->argv[5] );
4018                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4019                         return( 1 );
4020                 }
4021
4022                 cm->cc_period = (time_t)t;
4023                 Debug( pcache_debug,
4024                                 "Total # of attribute sets to be cached = %d.\n",
4025                                 cm->numattrsets, 0, 0 );
4026                 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
4027                                                 sizeof( struct attr_set ) );
4028                 break;
4029         case PC_ATTR:
4030                 if ( cm->numattrsets == 0 ) {
4031                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4032                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4033                         return( 1 );
4034                 }
4035                 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
4036                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
4037                                 c->argv[1] );
4038                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4039                         return( 1 );
4040                 }
4041
4042                 if ( num < 0 || num >= cm->numattrsets ) {
4043                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
4044                                 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4045                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4046                         return 1;
4047                 }
4048                 qm->attr_sets[num].flags |= PC_CONFIGURED;
4049                 if ( c->argc == 2 ) {
4050                         /* assume "1.1" */
4051                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4052                                 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
4053                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4054                         return 1;
4055
4056                 } else if ( c->argc == 3 ) {
4057                         if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4058                                 qm->attr_sets[num].count = 1;
4059                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
4060                                         sizeof( AttributeName ) );
4061                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4062                                 break;
4063
4064                         } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4065                                 qm->attr_sets[num].count = 1;
4066                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
4067                                         sizeof( AttributeName ) );
4068                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4069                                 break;
4070
4071                         } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
4072                                 break;
4073                         }
4074                         /* else: fallthru */
4075
4076                 } else if ( c->argc == 4 ) {
4077                         if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
4078                                 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
4079                         {
4080                                 qm->attr_sets[num].count = 2;
4081                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
4082                                         sizeof( AttributeName ) );
4083                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4084                                 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4085                                 break;
4086                         }
4087                         /* else: fallthru */
4088                 }
4089
4090                 if ( c->argc > 2 ) {
4091                         int all_user = 0, all_op = 0;
4092
4093                         qm->attr_sets[num].count = c->argc - 2;
4094                         qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
4095                                 sizeof( AttributeName ) );
4096                         attr_name = qm->attr_sets[num].attrs;
4097                         for ( i = 2; i < c->argc; i++ ) {
4098                                 attr_name->an_desc = NULL;
4099                                 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4100                                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4101                                                 "invalid attr #%d \"%s\" in attrlist",
4102                                                 i - 2, c->argv[i] );
4103                                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4104                                         ch_free( qm->attr_sets[num].attrs );
4105                                         qm->attr_sets[num].attrs = NULL;
4106                                         qm->attr_sets[num].count = 0;
4107                                         return 1;
4108                                 }
4109                                 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4110                                         all_user = 1;
4111                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4112                                 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4113                                         all_op = 1;
4114                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4115                                 } else {
4116                                         if ( strncasecmp( c->argv[i], "undef:", STRLENOF("undef:") ) == 0 ) {
4117                                                 struct berval bv;
4118                                                 ber_str2bv( c->argv[i] + STRLENOF("undef:"), 0, 0, &bv );
4119                                                 attr_name->an_desc = slap_bv2tmp_ad( &bv, NULL );
4120
4121                                         } else if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4122                                                 strcpy( c->cr_msg, text );
4123                                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4124                                                 ch_free( qm->attr_sets[num].attrs );
4125                                                 qm->attr_sets[num].attrs = NULL;
4126                                                 qm->attr_sets[num].count = 0;
4127                                                 return 1;
4128                                         }
4129                                         attr_name->an_name = attr_name->an_desc->ad_cname;
4130                                 }
4131                                 attr_name->an_oc = NULL;
4132                                 attr_name->an_flags = 0;
4133                                 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4134                                         qm->attr_sets[num].flags |= PC_GOT_OC;
4135                                 attr_name++;
4136                                 BER_BVZERO( &attr_name->an_name );
4137                         }
4138
4139                         /* warn if list contains both "*" and "+" */
4140                         if ( i > 4 && all_user && all_op ) {
4141                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4142                                         "warning: attribute list contains \"*\" and \"+\"" );
4143                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4144                         }
4145                 }
4146                 break;
4147         case PC_TEMP:
4148                 if ( cm->numattrsets == 0 ) {
4149                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4150                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4151                         return( 1 );
4152                 }
4153                 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4154                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4155                                 c->argv[2] );
4156                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4157                         return( 1 );
4158                 }
4159
4160                 if ( i < 0 || i >= cm->numattrsets ||
4161                         !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4162                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4163                                 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4164                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4165                         return 1;
4166                 }
4167                 {
4168                         AttributeName *attrs;
4169                         int cnt;
4170                         cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4171                         if ( cnt < 0 ) {
4172                                 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4173                                         text );
4174                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4175                                 return 1;
4176                         }
4177                         temp = ch_calloc( 1, sizeof( QueryTemplate ));
4178                         temp->qmnext = qm->templates;
4179                         qm->templates = temp;
4180                         temp->t_attrs.attrs = attrs;
4181                         temp->t_attrs.count = cnt;
4182                 }
4183                 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4184                 temp->query = temp->query_last = NULL;
4185                 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4186                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4187                                 "unable to parse template ttl=\"%s\"",
4188                                 c->argv[3] );
4189                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4190 pc_temp_fail:
4191                         ch_free( temp->t_attrs.attrs );
4192                         ch_free( temp );
4193                         return( 1 );
4194                 }
4195                 temp->ttl = (time_t)t;
4196                 temp->negttl = (time_t)0;
4197                 temp->limitttl = (time_t)0;
4198                 temp->ttr = (time_t)0;
4199                 switch ( c->argc ) {
4200                 case 7:
4201                         if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4202                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4203                                         "unable to parse template ttr=\"%s\"",
4204                                         c->argv[6] );
4205                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4206                                 goto pc_temp_fail;
4207                         }
4208                         temp->ttr = (time_t)t;
4209                         /* fallthru */
4210
4211                 case 6:
4212                         if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4213                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4214                                         "unable to parse template sizelimit ttl=\"%s\"",
4215                                         c->argv[5] );
4216                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4217                                 goto pc_temp_fail;
4218                         }
4219                         temp->limitttl = (time_t)t;
4220                         /* fallthru */
4221
4222                 case 5:
4223                         if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4224                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4225                                         "unable to parse template negative ttl=\"%s\"",
4226                                         c->argv[4] );
4227                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4228                                 goto pc_temp_fail;
4229                         }
4230                         temp->negttl = (time_t)t;
4231                         break;
4232                 }
4233
4234                 temp->no_of_queries = 0;
4235
4236                 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4237                 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4238                 Debug( pcache_debug, "  query template: %s\n",
4239                                 temp->querystr.bv_val, 0, 0 );
4240                 temp->attr_set_index = i;
4241                 qm->attr_sets[i].flags |= PC_REFERENCED;
4242                 temp->qtnext = qm->attr_sets[i].templates;
4243                 qm->attr_sets[i].templates = temp;
4244                 Debug( pcache_debug, "  attributes: \n", 0, 0, 0 );
4245                 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4246                         for ( i=0; attrarray[i].an_name.bv_val; i++ )
4247                                 Debug( pcache_debug, "\t%s\n",
4248                                         attrarray[i].an_name.bv_val, 0, 0 );
4249                 }
4250                 break;
4251         case PC_BIND:
4252                 if ( !qm->templates ) {
4253                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4254                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4255                         return( 1 );
4256                 }
4257                 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4258                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4259                                 c->argv[2] );
4260                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4261                         return( 1 );
4262                 }
4263
4264                 if ( i < 0 || i >= cm->numattrsets ||
4265                         !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4266                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4267                                 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4268                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4269                         return 1;
4270                 }
4271                 {       struct berval bv, tempbv;
4272                         AttributeDescription **descs;
4273                         int ndescs;
4274                         ber_str2bv( c->argv[1], 0, 0, &bv );
4275                         ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4276                         if ( ndescs < 0 ) {
4277                                 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4278                                         text );
4279                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4280                                 return 1;
4281                         }
4282                         for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4283                                 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4284                                         &temp->querystr ))
4285                                         break;
4286                         }
4287                         ch_free( tempbv.bv_val );
4288                         if ( !temp ) {
4289                                 ch_free( descs );
4290                                 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4291                                         c->argv[1], i );
4292                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4293                                 return 1;
4294                         }
4295                         ber_dupbv( &temp->bindftemp, &bv );
4296                         temp->bindfattrs = descs;
4297                         temp->bindnattrs = ndescs;
4298                 }
4299                 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4300                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4301                                 "unable to parse bind ttr=\"%s\"",
4302                                 c->argv[3] );
4303                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4304 pc_bind_fail:
4305                         ch_free( temp->bindfattrs );
4306                         temp->bindfattrs = NULL;
4307                         ch_free( temp->bindftemp.bv_val );
4308                         BER_BVZERO( &temp->bindftemp );
4309                         return( 1 );
4310                 }
4311                 num = ldap_pvt_str2scope( c->argv[4] );
4312                 if ( num < 0 ) {
4313                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4314                                 "unable to parse bind scope=\"%s\"",
4315                                 c->argv[4] );
4316                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4317                         goto pc_bind_fail;
4318                 }
4319                 {
4320                         struct berval dn, ndn;
4321                         ber_str2bv( c->argv[5], 0, 0, &dn );
4322                         rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4323                         if ( rc ) {
4324                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4325                                         "invalid bind baseDN=\"%s\"",
4326                                         c->argv[5] );
4327                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4328                                 goto pc_bind_fail;
4329                         }
4330                         if ( temp->bindbase.bv_val )
4331                                 ch_free( temp->bindbase.bv_val );
4332                         temp->bindbase = ndn;
4333                 }
4334                 {
4335                         /* convert the template into dummy filter */
4336                         struct berval bv;
4337                         char *eq = temp->bindftemp.bv_val, *e2;
4338                         Filter *f;
4339                         i = 0;
4340                         while ((eq = strchr(eq, '=' ))) {
4341                                 eq++;
4342                                 if ( eq[0] == ')' )
4343                                         i++;
4344                         }
4345                         bv.bv_len = temp->bindftemp.bv_len + i;
4346                         bv.bv_val = ch_malloc( bv.bv_len + 1 );
4347                         for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4348                                 *eq; eq++ ) {
4349                                 if ( *eq == '=' ) {
4350                                         *e2++ = '=';
4351                                         if ( eq[1] == ')' )
4352                                                 *e2++ = '*';
4353                                 } else {
4354                                         *e2++ = *eq;
4355                                 }
4356                         }
4357                         *e2 = '\0';
4358                         f = str2filter( bv.bv_val );
4359                         if ( !f ) {
4360                                 ch_free( bv.bv_val );
4361                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4362                                         "unable to parse bindfilter=\"%s\"", bv.bv_val );
4363                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4364                                 ch_free( temp->bindbase.bv_val );
4365                                 BER_BVZERO( &temp->bindbase );
4366                                 goto pc_bind_fail;
4367                         }
4368                         if ( temp->bindfilter )
4369                                 filter_free( temp->bindfilter );
4370                         if ( temp->bindfilterstr.bv_val )
4371                                 ch_free( temp->bindfilterstr.bv_val );
4372                         temp->bindfilterstr = bv;
4373                         temp->bindfilter = f;
4374                 }
4375                 temp->bindttr = (time_t)t;
4376                 temp->bindscope = num;
4377                 cm->cache_binds = 1;
4378                 break;
4379
4380         case PC_RESP:
4381                 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4382                         cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4383
4384                 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4385                         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4386
4387                 } else {
4388                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4389                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4390                         return 1;
4391                 }
4392                 break;
4393         case PC_QUERIES:
4394                 if ( c->value_int <= 0 ) {
4395                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4396                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4397                         return( 1 );
4398                 }
4399                 cm->max_queries = c->value_int;
4400                 break;
4401         case PC_OFFLINE:
4402                 if ( c->value_int )
4403                         cm->cc_paused |= PCACHE_CC_OFFLINE;
4404                 else
4405                         cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4406                 break;
4407         case PC_PRIVATE_DB:
4408                 if ( cm->db.be_private == NULL ) {
4409                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4410                                 "private database must be defined before setting database specific options" );
4411                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4412                         return( 1 );
4413                 }
4414
4415                 if ( cm->db.bd_info->bi_cf_ocs ) {
4416                         ConfigTable     *ct;
4417                         ConfigArgs      c2 = *c;
4418                         char            *argv0 = c->argv[ 0 ];
4419
4420                         c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4421
4422                         ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4423                         if ( ct == NULL ) {
4424                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4425                                         "private database does not recognize specific option '%s'",
4426                                         c->argv[ 0 ] );
4427                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4428                                 rc = 1;
4429
4430                         } else {
4431                                 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4432                                 c->be = &cm->db;
4433                                 c->bi = c->be->bd_info;
4434
4435                                 rc = config_add_vals( ct, c );
4436
4437                                 c->bi = c2.bi;
4438                                 c->be = c2.be;
4439                                 c->table = c2.table;
4440                         }
4441
4442                         c->argv[ 0 ] = argv0;
4443
4444                 } else if ( cm->db.be_config != NULL ) {
4445                         char    *argv0 = c->argv[ 0 ];
4446
4447                         c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4448                         rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4449                         c->argv[ 0 ] = argv0;
4450
4451                 } else {
4452                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4453                                 "no means to set private database specific options" );
4454                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4455                         return 1;
4456                 }
4457                 break;
4458         default:
4459                 rc = SLAP_CONF_UNKNOWN;
4460                 break;
4461         }
4462
4463         return rc;
4464 }
4465
4466 static int
4467 pcache_db_config(
4468         BackendDB       *be,
4469         const char      *fname,
4470         int             lineno,
4471         int             argc,
4472         char            **argv
4473 )
4474 {
4475         slap_overinst   *on = (slap_overinst *)be->bd_info;
4476         cache_manager*  cm = on->on_bi.bi_private;
4477
4478         /* Something for the cache database? */
4479         if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4480                 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4481                         argc, argv );
4482         return SLAP_CONF_UNKNOWN;
4483 }
4484
4485 static int
4486 pcache_db_init(
4487         BackendDB *be,
4488         ConfigReply *cr)
4489 {
4490         slap_overinst *on = (slap_overinst *)be->bd_info;
4491         cache_manager *cm;
4492         query_manager *qm;
4493
4494         cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4495         on->on_bi.bi_private = cm;
4496
4497         qm = (query_manager*)ch_malloc(sizeof(query_manager));
4498
4499         cm->db = *be;
4500         cm->db.bd_info = NULL;
4501         SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4502         cm->db.be_private = NULL;
4503         cm->db.bd_self = &cm->db;
4504         cm->qm = qm;
4505         cm->numattrsets = 0;
4506         cm->num_entries_limit = 5;
4507         cm->num_cached_queries = 0;
4508         cm->max_entries = 0;
4509         cm->cur_entries = 0;
4510         cm->max_queries = 10000;
4511         cm->save_queries = 0;
4512         cm->check_cacheability = 0;
4513         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4514         cm->defer_db_open = 1;
4515         cm->cache_binds = 0;
4516         cm->cc_period = 1000;
4517         cm->cc_paused = 0;
4518         cm->cc_arg = NULL;
4519 #ifdef PCACHE_MONITOR
4520         cm->monitor_cb = NULL;
4521 #endif /* PCACHE_MONITOR */
4522
4523         qm->attr_sets = NULL;
4524         qm->templates = NULL;
4525         qm->lru_top = NULL;
4526         qm->lru_bottom = NULL;
4527
4528         qm->qcfunc = query_containment;
4529         qm->crfunc = cache_replacement;
4530         qm->addfunc = add_query;
4531         ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4532
4533         ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4534
4535 #ifndef PCACHE_MONITOR
4536         return 0;
4537 #else /* PCACHE_MONITOR */
4538         return pcache_monitor_db_init( be );
4539 #endif /* PCACHE_MONITOR */
4540 }
4541
4542 static int
4543 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4544 {
4545         assert( op->o_tag == LDAP_REQ_SEARCH );
4546
4547         if ( rs->sr_type == REP_SEARCH ) {
4548                 Attribute       *a;
4549
4550                 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4551                 if ( a != NULL ) {
4552                         BerVarray       *valsp;
4553
4554                         assert( a->a_nvals != NULL );
4555
4556                         valsp = op->o_callback->sc_private;
4557                         assert( *valsp == NULL );
4558
4559                         ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4560                 }
4561         }
4562
4563         return 0;
4564 }
4565
4566 static int
4567 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4568 {
4569         assert( op->o_tag == LDAP_REQ_SEARCH );
4570
4571         if ( rs->sr_type == REP_SEARCH ) {
4572                 int     *countp = (int *)op->o_callback->sc_private;
4573
4574                 (*countp)++;
4575         }
4576
4577         return 0;
4578 }
4579
4580 static int
4581 pcache_db_open2(
4582         slap_overinst *on,
4583         ConfigReply *cr )
4584 {
4585         cache_manager   *cm = on->on_bi.bi_private;
4586         query_manager*  qm = cm->qm;
4587         int rc;
4588
4589         rc = backend_startup_one( &cm->db, cr );
4590         if ( rc == 0 ) {
4591                 cm->defer_db_open = 0;
4592         }
4593
4594         /* There is no runqueue in TOOL mode */
4595         if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4596                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4597                 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4598                         consistency_check, on,
4599                         "pcache_consistency", cm->db.be_suffix[0].bv_val );
4600                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4601
4602                 /* Cached database must have the rootdn */
4603                 if ( BER_BVISNULL( &cm->db.be_rootndn )
4604                                 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4605                 {
4606                         Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4607                                 "underlying database of type \"%s\"\n"
4608                                 "    serving naming context \"%s\"\n"
4609                                 "    has no \"rootdn\", required by \"pcache\".\n",
4610                                 on->on_info->oi_orig->bi_type,
4611                                 cm->db.be_suffix[0].bv_val, 0 );
4612                         return 1;
4613                 }
4614
4615                 if ( cm->save_queries ) {
4616                         void            *thrctx = ldap_pvt_thread_pool_context();
4617                         Connection      conn = { 0 };
4618                         OperationBuffer opbuf;
4619                         Operation       *op;
4620                         slap_callback   cb = { 0 };
4621                         SlapReply       rs = { REP_RESULT };
4622                         BerVarray       vals = NULL;
4623                         Filter          f = { 0 }, f2 = { 0 };
4624                         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
4625                         AttributeName   attrs[ 2 ] = {{{ 0 }}};
4626
4627                         connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4628                         op = &opbuf.ob_op;
4629
4630                         op->o_bd = &cm->db;
4631
4632                         op->o_tag = LDAP_REQ_SEARCH;
4633                         op->o_protocol = LDAP_VERSION3;
4634                         cb.sc_response = pcache_cachedquery_open_cb;
4635                         cb.sc_private = &vals;
4636                         op->o_callback = &cb;
4637                         op->o_time = slap_get_time();
4638                         op->o_do_not_cache = 1;
4639                         op->o_managedsait = SLAP_CONTROL_CRITICAL;
4640
4641                         op->o_dn = cm->db.be_rootdn;
4642                         op->o_ndn = cm->db.be_rootndn;
4643                         op->o_req_dn = cm->db.be_suffix[ 0 ];
4644                         op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4645
4646                         op->ors_scope = LDAP_SCOPE_BASE;
4647                         op->ors_deref = LDAP_DEREF_NEVER;
4648                         op->ors_slimit = 1;
4649                         op->ors_tlimit = SLAP_NO_LIMIT;
4650                         op->ors_limit = NULL;
4651                         ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4652                         f.f_choice = LDAP_FILTER_PRESENT;
4653                         f.f_desc = ad_cachedQueryURL;
4654                         op->ors_filter = &f;
4655                         attrs[ 0 ].an_desc = ad_cachedQueryURL;
4656                         attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4657                         op->ors_attrs = attrs;
4658                         op->ors_attrsonly = 0;
4659
4660                         rc = op->o_bd->be_search( op, &rs );
4661                         if ( rc == LDAP_SUCCESS && vals != NULL ) {
4662                                 int     i;
4663
4664                                 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4665                                         if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4666                                                 cm->num_cached_queries++;
4667                                         }
4668                                 }
4669
4670                                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4671                         }
4672
4673                         /* count cached entries */
4674                         f.f_choice = LDAP_FILTER_NOT;
4675                         f.f_not = &f2;
4676                         f2.f_choice = LDAP_FILTER_EQUALITY;
4677                         f2.f_ava = &ava;
4678                         f2.f_av_desc = slap_schema.si_ad_objectClass;
4679                         BER_BVSTR( &f2.f_av_value, "glue" );
4680                         ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4681
4682                         op->ors_slimit = SLAP_NO_LIMIT;
4683                         op->ors_scope = LDAP_SCOPE_SUBTREE;
4684                         op->ors_attrs = slap_anlist_no_attrs;
4685
4686                         rs_reinit( &rs, REP_RESULT );
4687                         op->o_callback->sc_response = pcache_cachedquery_count_cb;
4688                         op->o_callback->sc_private = &rs.sr_nentries;
4689
4690                         rc = op->o_bd->be_search( op, &rs );
4691
4692                         cm->cur_entries = rs.sr_nentries;
4693
4694                         /* ignore errors */
4695                         rc = 0;
4696                 }
4697         }
4698         return rc;
4699 }
4700
4701 static int
4702 pcache_db_open(
4703         BackendDB *be,
4704         ConfigReply *cr )
4705 {
4706         slap_overinst   *on = (slap_overinst *)be->bd_info;
4707         cache_manager   *cm = on->on_bi.bi_private;
4708         query_manager*  qm = cm->qm;
4709         int             i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4710
4711         /* check attr sets */
4712         for ( i = 0; i < cm->numattrsets; i++) {
4713                 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4714                         if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4715                                 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4716                                 rf++;
4717
4718                         } else {
4719                                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4720                         }
4721                         ncf++;
4722
4723                 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4724                         Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4725                         nrf++;
4726                 }
4727         }
4728
4729         if ( ncf || rf || nrf ) {
4730                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4731                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4732                 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4733
4734                 if ( rf > 0 ) {
4735                         return 1;
4736                 }
4737         }
4738
4739         /* need to inherit something from the original database... */
4740         cm->db.be_def_limit = be->be_def_limit;
4741         cm->db.be_limits = be->be_limits;
4742         cm->db.be_acl = be->be_acl;
4743         cm->db.be_dfltaccess = be->be_dfltaccess;
4744
4745         if ( SLAP_DBMONITORING( be ) ) {
4746                 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4747
4748         } else {
4749                 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4750         }
4751
4752         if ( !cm->defer_db_open ) {
4753                 rc = pcache_db_open2( on, cr );
4754         }
4755
4756 #ifdef PCACHE_MONITOR
4757         if ( rc == LDAP_SUCCESS ) {
4758                 rc = pcache_monitor_db_open( be );
4759         }
4760 #endif /* PCACHE_MONITOR */
4761
4762         return rc;
4763 }
4764
4765 static void
4766 pcache_free_qbase( void *v )
4767 {
4768         Qbase *qb = v;
4769         int i;
4770
4771         for (i=0; i<3; i++)
4772                 tavl_free( qb->scopes[i], NULL );
4773         ch_free( qb );
4774 }
4775
4776 static int
4777 pcache_db_close(
4778         BackendDB *be,
4779         ConfigReply *cr
4780 )
4781 {
4782         slap_overinst *on = (slap_overinst *)be->bd_info;
4783         cache_manager *cm = on->on_bi.bi_private;
4784         query_manager *qm = cm->qm;
4785         QueryTemplate *tm;
4786         int i, rc = 0;
4787
4788         /* stop the thread ... */
4789         if ( cm->cc_arg ) {
4790                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4791                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4792                         ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4793                 }
4794                 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4795                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4796         }
4797
4798         if ( cm->save_queries ) {
4799                 CachedQuery     *qc;
4800                 BerVarray       vals = NULL;
4801
4802                 void            *thrctx;
4803                 Connection      conn = { 0 };
4804                 OperationBuffer opbuf;
4805                 Operation       *op;
4806                 slap_callback   cb = { 0 };
4807
4808                 SlapReply       rs = { REP_RESULT };
4809                 Modifications   mod = {{ 0 }};
4810
4811                 thrctx = ldap_pvt_thread_pool_context();
4812
4813                 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4814                 op = &opbuf.ob_op;
4815
4816                 mod.sml_numvals = 0;
4817                 if ( qm->templates != NULL ) {
4818                         for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4819                                 for ( qc = tm->query; qc; qc = qc->next ) {
4820                                         struct berval   bv;
4821
4822                                         if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4823                                                 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4824                                                 mod.sml_numvals++;
4825                                         }
4826                                 }
4827                         }
4828                 }
4829
4830                 op->o_bd = &cm->db;
4831                 op->o_dn = cm->db.be_rootdn;
4832                 op->o_ndn = cm->db.be_rootndn;
4833
4834                 op->o_tag = LDAP_REQ_MODIFY;
4835                 op->o_protocol = LDAP_VERSION3;
4836                 cb.sc_response = slap_null_cb;
4837                 op->o_callback = &cb;
4838                 op->o_time = slap_get_time();
4839                 op->o_do_not_cache = 1;
4840                 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4841
4842                 op->o_req_dn = op->o_bd->be_suffix[0];
4843                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4844
4845                 mod.sml_op = LDAP_MOD_REPLACE;
4846                 mod.sml_flags = 0;
4847                 mod.sml_desc = ad_cachedQueryURL;
4848                 mod.sml_type = ad_cachedQueryURL->ad_cname;
4849                 mod.sml_values = vals;
4850                 mod.sml_nvalues = NULL;
4851                 mod.sml_next = NULL;
4852                 Debug( pcache_debug,
4853                         "%sSETTING CACHED QUERY URLS\n",
4854                         vals == NULL ? "RE" : "", 0, 0 );
4855
4856                 op->orm_modlist = &mod;
4857
4858                 op->o_bd->be_modify( op, &rs );
4859
4860                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4861         }
4862
4863         /* cleanup stuff inherited from the original database... */
4864         cm->db.be_limits = NULL;
4865         cm->db.be_acl = NULL;
4866
4867
4868         if ( cm->db.bd_info->bi_db_close ) {
4869                 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4870         }
4871         while ( (tm = qm->templates) != NULL ) {
4872                 CachedQuery *qc, *qn;
4873                 qm->templates = tm->qmnext;
4874                 for ( qc = tm->query; qc; qc = qn ) {
4875                         qn = qc->next;
4876                         free_query( qc );
4877                 }
4878                 avl_free( tm->qbase, pcache_free_qbase );
4879                 free( tm->querystr.bv_val );
4880                 free( tm->bindfattrs );
4881                 free( tm->bindftemp.bv_val );
4882                 free( tm->bindfilterstr.bv_val );
4883                 free( tm->bindbase.bv_val );
4884                 filter_free( tm->bindfilter );
4885                 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4886                 free( tm->t_attrs.attrs );
4887                 free( tm );
4888         }
4889
4890         for ( i = 0; i < cm->numattrsets; i++ ) {
4891                 int j;
4892
4893                 /* Account of LDAP_NO_ATTRS */
4894                 if ( !qm->attr_sets[i].count ) continue;
4895
4896                 for ( j = 0; !BER_BVISNULL( &qm->attr_sets[i].attrs[j].an_name ); j++ ) {
4897                         if ( qm->attr_sets[i].attrs[j].an_desc &&
4898                                         ( qm->attr_sets[i].attrs[j].an_desc->ad_flags &
4899                                           SLAP_DESC_TEMPORARY ) ) {
4900                                 slap_sl_mfuncs.bmf_free( qm->attr_sets[i].attrs[j].an_desc, NULL );
4901                         }
4902                 }
4903                 free( qm->attr_sets[i].attrs );
4904         }
4905         free( qm->attr_sets );
4906         qm->attr_sets = NULL;
4907
4908 #ifdef PCACHE_MONITOR
4909         if ( rc == LDAP_SUCCESS ) {
4910                 rc = pcache_monitor_db_close( be );
4911         }
4912 #endif /* PCACHE_MONITOR */
4913
4914         return rc;
4915 }
4916
4917 static int
4918 pcache_db_destroy(
4919         BackendDB *be,
4920         ConfigReply *cr
4921 )
4922 {
4923         slap_overinst *on = (slap_overinst *)be->bd_info;
4924         cache_manager *cm = on->on_bi.bi_private;
4925         query_manager *qm = cm->qm;
4926
4927         if ( cm->db.be_private != NULL ) {
4928                 backend_stopdown_one( &cm->db );
4929         }
4930
4931         ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4932         ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4933         free( qm );
4934         free( cm );
4935
4936 #ifdef PCACHE_MONITOR
4937         pcache_monitor_db_destroy( be );
4938 #endif /* PCACHE_MONITOR */
4939
4940         return 0;
4941 }
4942
4943 #ifdef PCACHE_CONTROL_PRIVDB
4944 /*
4945         Control ::= SEQUENCE {
4946              controlType             LDAPOID,
4947              criticality             BOOLEAN DEFAULT FALSE,
4948              controlValue            OCTET STRING OPTIONAL }
4949
4950         controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4951
4952  * criticality must be TRUE; controlValue must be absent.
4953  */
4954 static int
4955 parse_privdb_ctrl(
4956         Operation       *op,
4957         SlapReply       *rs,
4958         LDAPControl     *ctrl )
4959 {
4960         if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4961                 rs->sr_text = "privateDB control specified multiple times";
4962                 return LDAP_PROTOCOL_ERROR;
4963         }
4964
4965         if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4966                 rs->sr_text = "privateDB control value not absent";
4967                 return LDAP_PROTOCOL_ERROR;
4968         }
4969
4970         if ( !ctrl->ldctl_iscritical ) {
4971                 rs->sr_text = "privateDB control criticality required";
4972                 return LDAP_PROTOCOL_ERROR;
4973         }
4974
4975         op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4976
4977         return LDAP_SUCCESS;
4978 }
4979
4980 static char *extops[] = {
4981         LDAP_EXOP_MODIFY_PASSWD,
4982         NULL
4983 };
4984 #endif /* PCACHE_CONTROL_PRIVDB */
4985
4986 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4987 #ifdef PCACHE_EXOP_QUERY_DELETE
4988 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4989
4990 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4991 #define LDAP_TAG_EXOP_QUERY_DELETE_DN   ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4992 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4993
4994 /*
4995         ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4996              requestName      [0] LDAPOID,
4997              requestValue     [1] OCTET STRING OPTIONAL }
4998
4999         requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
5000
5001         requestValue ::= SEQUENCE { CHOICE {
5002                   baseDN           [0] LDAPDN
5003                   entryDN          [1] LDAPDN },
5004              queryID          [2] OCTET STRING (SIZE(16))
5005                   -- constrained to UUID }
5006
5007  * Either baseDN or entryDN must be present, to allow database selection.
5008  *
5009  * 1. if baseDN and queryID are present, then the query corresponding
5010  *    to queryID is deleted;
5011  * 2. if baseDN is present and queryID is absent, then all queries
5012  *    are deleted;
5013  * 3. if entryDN is present and queryID is absent, then all queries
5014  *    corresponding to the queryID values present in entryDN are deleted;
5015  * 4. if entryDN and queryID are present, then all queries
5016  *    corresponding to the queryID values present in entryDN are deleted,
5017  *    but only if the value of queryID is contained in the entry;
5018  *
5019  * Currently, only 1, 3 and 4 are implemented.  2 can be obtained by either
5020  * recursively deleting the database (ldapdelete -r) with PRIVDB control,
5021  * or by removing the database files.
5022
5023         ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
5024              COMPONENTS OF LDAPResult,
5025              responseName     [10] LDAPOID OPTIONAL,
5026              responseValue    [11] OCTET STRING OPTIONAL }
5027
5028  * responseName and responseValue must be absent.
5029  */
5030
5031 /*
5032  * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
5033  *   or LDAP_TAG_EXOP_QUERY_DELETE_DN.
5034  * - if ndn != NULL, it is set to the normalized DN in the request
5035  *   corresponding to either the baseDN or the entryDN, according
5036  *   to *tagp; memory is malloc'ed on the Operation's slab, and must
5037  *   be freed by the caller.
5038  * - if uuid != NULL, it is set to point to the normalized UUID;
5039  *   memory is malloc'ed on the Operation's slab, and must
5040  *   be freed by the caller.
5041  */
5042 static int
5043 pcache_parse_query_delete(
5044         struct berval   *in,
5045         ber_tag_t       *tagp,
5046         struct berval   *ndn,
5047         struct berval   *uuid,
5048         const char      **text,
5049         void            *ctx )
5050 {
5051         int                     rc = LDAP_SUCCESS;
5052         ber_tag_t               tag;
5053         ber_len_t               len = -1;
5054         BerElementBuffer        berbuf;
5055         BerElement              *ber = (BerElement *)&berbuf;
5056         struct berval           reqdata = BER_BVNULL;
5057
5058         *text = NULL;
5059
5060         if ( ndn ) {
5061                 BER_BVZERO( ndn );
5062         }
5063
5064         if ( uuid ) {
5065                 BER_BVZERO( uuid );
5066         }
5067
5068         if ( in == NULL || in->bv_len == 0 ) {
5069                 *text = "empty request data field in queryDelete exop";
5070                 return LDAP_PROTOCOL_ERROR;
5071         }
5072
5073         ber_dupbv_x( &reqdata, in, ctx );
5074
5075         /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
5076         ber_init2( ber, &reqdata, 0 );
5077
5078         tag = ber_scanf( ber, "{" /*}*/ );
5079
5080         if ( tag == LBER_ERROR ) {
5081                 Debug( LDAP_DEBUG_TRACE,
5082                         "pcache_parse_query_delete: decoding error.\n",
5083                         0, 0, 0 );
5084                 goto decoding_error;
5085         }
5086
5087         tag = ber_peek_tag( ber, &len );
5088         if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
5089                 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
5090         {
5091                 *tagp = tag;
5092
5093                 if ( ndn != NULL ) {
5094                         struct berval   dn;
5095
5096                         tag = ber_scanf( ber, "m", &dn );
5097                         if ( tag == LBER_ERROR ) {
5098                                 Debug( LDAP_DEBUG_TRACE,
5099                                         "pcache_parse_query_delete: DN parse failed.\n",
5100                                         0, 0, 0 );
5101                                 goto decoding_error;
5102                         }
5103
5104                         rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
5105                         if ( rc != LDAP_SUCCESS ) {
5106                                 *text = "invalid DN in queryDelete exop request data";
5107                                 goto done;
5108                         }
5109
5110                 } else {
5111                         tag = ber_scanf( ber, "x" /* "m" */ );
5112                         if ( tag == LBER_DEFAULT ) {
5113                                 goto decoding_error;
5114                         }
5115                 }
5116
5117                 tag = ber_peek_tag( ber, &len );
5118         }
5119
5120         if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5121                 if ( uuid != NULL ) {
5122                         struct berval   bv;
5123                         char            uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5124
5125                         tag = ber_scanf( ber, "m", &bv );
5126                         if ( tag == LBER_ERROR ) {
5127                                 Debug( LDAP_DEBUG_TRACE,
5128                                         "pcache_parse_query_delete: UUID parse failed.\n",
5129                                         0, 0, 0 );
5130                                 goto decoding_error;
5131                         }
5132
5133                         if ( bv.bv_len != 16 ) {
5134                                 Debug( LDAP_DEBUG_TRACE,
5135                                         "pcache_parse_query_delete: invalid UUID length %lu.\n",
5136                                         (unsigned long)bv.bv_len, 0, 0 );
5137                                 goto decoding_error;
5138                         }
5139
5140                         rc = lutil_uuidstr_from_normalized(
5141                                 bv.bv_val, bv.bv_len,
5142                                 uuidbuf, sizeof( uuidbuf ) );
5143                         if ( rc == -1 ) {
5144                                 goto decoding_error;
5145                         }
5146                         ber_str2bv( uuidbuf, rc, 1, uuid );
5147                         rc = LDAP_SUCCESS;
5148
5149                 } else {
5150                         tag = ber_skip_tag( ber, &len );
5151                         if ( tag == LBER_DEFAULT ) {
5152                                 goto decoding_error;
5153                         }
5154
5155                         if ( len != 16 ) {
5156                                 Debug( LDAP_DEBUG_TRACE,
5157                                         "pcache_parse_query_delete: invalid UUID length %lu.\n",
5158                                         (unsigned long)len, 0, 0 );
5159                                 goto decoding_error;
5160                         }
5161                 }
5162
5163                 tag = ber_peek_tag( ber, &len );
5164         }
5165
5166         if ( tag != LBER_DEFAULT || len != 0 ) {
5167 decoding_error:;
5168                 Debug( LDAP_DEBUG_TRACE,
5169                         "pcache_parse_query_delete: decoding error\n",
5170                         0, 0, 0 );
5171                 rc = LDAP_PROTOCOL_ERROR;
5172                 *text = "queryDelete data decoding error";
5173
5174 done:;
5175                 if ( ndn && !BER_BVISNULL( ndn ) ) {
5176                         slap_sl_free( ndn->bv_val, ctx );
5177                         BER_BVZERO( ndn );
5178                 }
5179
5180                 if ( uuid && !BER_BVISNULL( uuid ) ) {
5181                         slap_sl_free( uuid->bv_val, ctx );
5182                         BER_BVZERO( uuid );
5183                 }
5184         }
5185
5186         if ( !BER_BVISNULL( &reqdata ) ) {
5187                 ber_memfree_x( reqdata.bv_val, ctx );
5188         }
5189
5190         return rc;
5191 }
5192
5193 static int
5194 pcache_exop_query_delete(
5195         Operation       *op,
5196         SlapReply       *rs )
5197 {
5198         BackendDB       *bd = op->o_bd;
5199
5200         struct berval   uuid = BER_BVNULL,
5201                         *uuidp = NULL;
5202         char            buf[ SLAP_TEXT_BUFLEN ];
5203         unsigned        len;
5204         ber_tag_t       tag = LBER_DEFAULT;
5205
5206         if ( LogTest( LDAP_DEBUG_STATS ) ) {
5207                 uuidp = &uuid;
5208         }
5209
5210         rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5211                 &tag, &op->o_req_ndn, uuidp,
5212                 &rs->sr_text, op->o_tmpmemctx );
5213         if ( rs->sr_err != LDAP_SUCCESS ) {
5214                 return rs->sr_err;
5215         }
5216
5217         if ( LogTest( LDAP_DEBUG_STATS ) ) {
5218                 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5219                 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5220
5221                 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5222                         snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5223                 }
5224
5225                 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5226                         op->o_log_prefix, buf, 0 );
5227         }
5228         op->o_req_dn = op->o_req_ndn;
5229
5230         op->o_bd = select_backend( &op->o_req_ndn, 0 );
5231         if ( op->o_bd == NULL ) {
5232                 send_ldap_error( op, rs, LDAP_NO_SUCH_OBJECT,
5233                         "no global superior knowledge" );
5234         }
5235         rs->sr_err = backend_check_restrictions( op, rs,
5236                 (struct berval *)&pcache_exop_QUERY_DELETE );
5237         if ( rs->sr_err != LDAP_SUCCESS ) {
5238                 goto done;
5239         }
5240
5241         if ( op->o_bd->be_extended == NULL ) {
5242                 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5243                         "backend does not support extended operations" );
5244                 goto done;
5245         }
5246
5247         op->o_bd->be_extended( op, rs );
5248
5249 done:;
5250         if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5251                 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5252                 BER_BVZERO( &op->o_req_ndn );
5253                 BER_BVZERO( &op->o_req_dn );
5254         }
5255
5256         if ( !BER_BVISNULL( &uuid ) ) {
5257                 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5258         }
5259
5260         op->o_bd = bd;
5261
5262         return rs->sr_err;
5263 }
5264 #endif /* PCACHE_EXOP_QUERY_DELETE */
5265
5266 static int
5267 pcache_op_extended( Operation *op, SlapReply *rs )
5268 {
5269         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
5270         cache_manager   *cm = on->on_bi.bi_private;
5271
5272 #ifdef PCACHE_CONTROL_PRIVDB
5273         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5274                 return pcache_op_privdb( op, rs );
5275         }
5276 #endif /* PCACHE_CONTROL_PRIVDB */
5277
5278 #ifdef PCACHE_EXOP_QUERY_DELETE
5279         if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5280                 struct berval   uuid = BER_BVNULL;
5281                 ber_tag_t       tag = LBER_DEFAULT;
5282
5283                 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5284                         &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5285                 assert( rs->sr_err == LDAP_SUCCESS );
5286
5287                 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5288                         /* remove all queries related to the selected entry */
5289                         rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5290                                 cm, &op->o_req_ndn, &uuid );
5291
5292                 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5293                         if ( !BER_BVISNULL( &uuid ) ) {
5294                                 /* remove the selected query */
5295                                 rs->sr_err = pcache_remove_query_from_cache( op,
5296                                         cm, &uuid );
5297
5298                         } else {
5299                                 /* TODO: remove all queries */
5300                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5301                                 rs->sr_text = "deletion of all queries not implemented";
5302                         }
5303                 }
5304
5305                 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5306                 return rs->sr_err;
5307         }
5308 #endif /* PCACHE_EXOP_QUERY_DELETE */
5309
5310         /* We only care if we're configured for Bind caching */
5311         if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5312                 cm->cache_binds ) {
5313                 /* See if the local entry exists and has a password.
5314                  * It's too much work to find the matching query, so
5315                  * we just see if there's a hashed password to update.
5316                  */
5317                 Operation op2 = *op;
5318                 Entry *e = NULL;
5319                 int rc;
5320                 int doit = 0;
5321
5322                 op2.o_bd = &cm->db;
5323                 op2.o_dn = op->o_bd->be_rootdn;
5324                 op2.o_ndn = op->o_bd->be_rootndn;
5325                 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5326                         slap_schema.si_ad_userPassword, 0, &e );
5327                 if ( rc == LDAP_SUCCESS && e ) {
5328                         /* See if a recognized password is hashed here */
5329                         Attribute *a = attr_find( e->e_attrs,
5330                                 slap_schema.si_ad_userPassword );
5331                         if ( a && a->a_vals[0].bv_val[0] == '{' &&
5332                                 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5333                                 doit = 1;
5334                         }
5335                         be_entry_release_r( &op2, e );
5336                 }
5337
5338                 if ( doit ) {
5339                         rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5340                                 on->on_next );
5341                         if ( rc == LDAP_SUCCESS ) {
5342                                 req_pwdexop_s *qpw = &op->oq_pwdexop;
5343
5344                                 /* We don't care if it succeeds or not */
5345                                 pc_setpw( &op2, &qpw->rs_new, cm );
5346                         }
5347                         return rc;
5348                 }
5349         }
5350         return SLAP_CB_CONTINUE;
5351 }
5352
5353 static int
5354 pcache_entry_release( Operation  *op, Entry *e, int rw )
5355 {
5356         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
5357         cache_manager   *cm = on->on_bi.bi_private;
5358         BackendDB *db = op->o_bd;
5359         int rc;
5360
5361         op->o_bd = &cm->db;
5362         rc = be_entry_release_rw( op, e, rw );
5363         op->o_bd = db;
5364         return rc;
5365 }
5366
5367 #ifdef PCACHE_MONITOR
5368
5369 static int
5370 pcache_monitor_update(
5371         Operation       *op,
5372         SlapReply       *rs,
5373         Entry           *e,
5374         void            *priv )
5375 {
5376         cache_manager   *cm = (cache_manager *) priv;
5377         query_manager   *qm = cm->qm;
5378
5379         CachedQuery     *qc;
5380         BerVarray       vals = NULL;
5381
5382         attr_delete( &e->e_attrs, ad_cachedQueryURL );
5383         if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5384                 && qm->templates != NULL )
5385         {
5386                 QueryTemplate *tm;
5387
5388                 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5389                         for ( qc = tm->query; qc; qc = qc->next ) {
5390                                 struct berval   bv;
5391
5392                                 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5393                                         ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5394                                 }
5395                         }
5396                 }
5397
5398
5399                 if ( vals != NULL ) {
5400                         attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5401                         ber_bvarray_free_x( vals, op->o_tmpmemctx );
5402                 }
5403         }
5404
5405         {
5406                 Attribute       *a;
5407                 char            buf[ SLAP_TEXT_BUFLEN ];
5408                 struct berval   bv;
5409
5410                 /* number of cached queries */
5411                 a = attr_find( e->e_attrs, ad_numQueries );
5412                 assert( a != NULL );
5413
5414                 bv.bv_val = buf;
5415                 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5416
5417                 if ( a->a_nvals != a->a_vals ) {
5418                         ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5419                 }
5420                 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5421
5422                 /* number of cached entries */
5423                 a = attr_find( e->e_attrs, ad_numEntries );
5424                 assert( a != NULL );
5425
5426                 bv.bv_val = buf;
5427                 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5428
5429                 if ( a->a_nvals != a->a_vals ) {
5430                         ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5431                 }
5432                 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5433         }
5434
5435         return SLAP_CB_CONTINUE;
5436 }
5437
5438 static int
5439 pcache_monitor_free(
5440         Entry           *e,
5441         void            **priv )
5442 {
5443         struct berval   values[ 2 ];
5444         Modification    mod = { 0 };
5445
5446         const char      *text;
5447         char            textbuf[ SLAP_TEXT_BUFLEN ];
5448
5449         int             rc;
5450
5451         /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5452         *priv = NULL;
5453
5454         /* Remove objectClass */
5455         mod.sm_op = LDAP_MOD_DELETE;
5456         mod.sm_desc = slap_schema.si_ad_objectClass;
5457         mod.sm_values = values;
5458         mod.sm_numvals = 1;
5459         values[ 0 ] = oc_olmPCache->soc_cname;
5460         BER_BVZERO( &values[ 1 ] );
5461
5462         rc = modify_delete_values( e, &mod, 1, &text,
5463                 textbuf, sizeof( textbuf ) );
5464         /* don't care too much about return code... */
5465
5466         /* remove attrs */
5467         mod.sm_values = NULL;
5468         mod.sm_desc = ad_cachedQueryURL;
5469         mod.sm_numvals = 0;
5470         rc = modify_delete_values( e, &mod, 1, &text,
5471                 textbuf, sizeof( textbuf ) );
5472         /* don't care too much about return code... */
5473
5474         /* remove attrs */
5475         mod.sm_values = NULL;
5476         mod.sm_desc = ad_numQueries;
5477         mod.sm_numvals = 0;
5478         rc = modify_delete_values( e, &mod, 1, &text,
5479                 textbuf, sizeof( textbuf ) );
5480         /* don't care too much about return code... */
5481
5482         /* remove attrs */
5483         mod.sm_values = NULL;
5484         mod.sm_desc = ad_numEntries;
5485         mod.sm_numvals = 0;
5486         rc = modify_delete_values( e, &mod, 1, &text,
5487                 textbuf, sizeof( textbuf ) );
5488         /* don't care too much about return code... */
5489
5490         return SLAP_CB_CONTINUE;
5491 }
5492
5493 /*
5494  * call from within pcache_initialize()
5495  */
5496 static int
5497 pcache_monitor_initialize( void )
5498 {
5499         static int      pcache_monitor_initialized = 0;
5500
5501         if ( backend_info( "monitor" ) == NULL ) {
5502                 return -1;
5503         }
5504
5505         if ( pcache_monitor_initialized++ ) {
5506                 return 0;
5507         }
5508
5509         return 0;
5510 }
5511
5512 static int
5513 pcache_monitor_db_init( BackendDB *be )
5514 {
5515         if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5516                 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5517         }
5518
5519         return 0;
5520 }
5521
5522 static int
5523 pcache_monitor_db_open( BackendDB *be )
5524 {
5525         slap_overinst           *on = (slap_overinst *)be->bd_info;
5526         cache_manager           *cm = on->on_bi.bi_private;
5527         Attribute               *a, *next;
5528         monitor_callback_t      *cb = NULL;
5529         int                     rc = 0;
5530         BackendInfo             *mi;
5531         monitor_extra_t         *mbe;
5532
5533         if ( !SLAP_DBMONITORING( be ) ) {
5534                 return 0;
5535         }
5536
5537         mi = backend_info( "monitor" );
5538         if ( !mi || !mi->bi_extra ) {
5539                 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5540                 return 0;
5541         }
5542         mbe = mi->bi_extra;
5543
5544         /* don't bother if monitor is not configured */
5545         if ( !mbe->is_configured() ) {
5546                 static int warning = 0;
5547
5548                 if ( warning++ == 0 ) {
5549                         Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5550                                 "monitoring disabled; "
5551                                 "configure monitor database to enable\n",
5552                                 0, 0, 0 );
5553                 }
5554
5555                 return 0;
5556         }
5557
5558         /* alloc as many as required (plus 1 for objectClass) */
5559         a = attrs_alloc( 1 + 2 );
5560         if ( a == NULL ) {
5561                 rc = 1;
5562                 goto cleanup;
5563         }
5564
5565         a->a_desc = slap_schema.si_ad_objectClass;
5566         attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5567         next = a->a_next;
5568
5569         {
5570                 struct berval   bv = BER_BVC( "0" );
5571
5572                 next->a_desc = ad_numQueries;
5573                 attr_valadd( next, &bv, NULL, 1 );
5574                 next = next->a_next;
5575
5576                 next->a_desc = ad_numEntries;
5577                 attr_valadd( next, &bv, NULL, 1 );
5578                 next = next->a_next;
5579         }
5580
5581         cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5582         cb->mc_update = pcache_monitor_update;
5583         cb->mc_free = pcache_monitor_free;
5584         cb->mc_private = (void *)cm;
5585
5586         /* make sure the database is registered; then add monitor attributes */
5587         BER_BVZERO( &cm->monitor_ndn );
5588         rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5589         if ( rc == 0 ) {
5590                 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5591                         NULL, -1, NULL);
5592         }
5593
5594 cleanup:;
5595         if ( rc != 0 ) {
5596                 if ( cb != NULL ) {
5597                         ch_free( cb );
5598                         cb = NULL;
5599                 }
5600
5601                 if ( a != NULL ) {
5602                         attrs_free( a );
5603                         a = NULL;
5604                 }
5605         }
5606
5607         /* store for cleanup */
5608         cm->monitor_cb = (void *)cb;
5609
5610         /* we don't need to keep track of the attributes, because
5611          * bdb_monitor_free() takes care of everything */
5612         if ( a != NULL ) {
5613                 attrs_free( a );
5614         }
5615
5616         return rc;
5617 }
5618
5619 static int
5620 pcache_monitor_db_close( BackendDB *be )
5621 {
5622         slap_overinst *on = (slap_overinst *)be->bd_info;
5623         cache_manager *cm = on->on_bi.bi_private;
5624
5625         if ( cm->monitor_cb != NULL ) {
5626                 BackendInfo             *mi = backend_info( "monitor" );
5627                 monitor_extra_t         *mbe;
5628
5629                 if ( mi && &mi->bi_extra ) {
5630                         mbe = mi->bi_extra;
5631                         mbe->unregister_entry_callback( &cm->monitor_ndn,
5632                                 (monitor_callback_t *)cm->monitor_cb,
5633                                 NULL, 0, NULL );
5634                 }
5635         }
5636
5637         return 0;
5638 }
5639
5640 static int
5641 pcache_monitor_db_destroy( BackendDB *be )
5642 {
5643         return 0;
5644 }
5645
5646 #endif /* PCACHE_MONITOR */
5647
5648 static slap_overinst pcache;
5649
5650 static char *obsolete_names[] = {
5651         "proxycache",
5652         NULL
5653 };
5654
5655 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5656 static
5657 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5658 int
5659 pcache_initialize()
5660 {
5661         int i, code;
5662         struct berval debugbv = BER_BVC("pcache");
5663         ConfigArgs c;
5664         char *argv[ 4 ];
5665
5666         code = slap_loglevel_get( &debugbv, &pcache_debug );
5667         if ( code ) {
5668                 return code;
5669         }
5670
5671 #ifdef PCACHE_CONTROL_PRIVDB
5672         code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5673                 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5674                 parse_privdb_ctrl, &privDB_cid );
5675         if ( code != LDAP_SUCCESS ) {
5676                 Debug( LDAP_DEBUG_ANY,
5677                         "pcache_initialize: failed to register control %s (%d)\n",
5678                         PCACHE_CONTROL_PRIVDB, code, 0 );
5679                 return code;
5680         }
5681 #endif /* PCACHE_CONTROL_PRIVDB */
5682
5683 #ifdef PCACHE_EXOP_QUERY_DELETE
5684         code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5685                 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5686                 0 );
5687         if ( code != LDAP_SUCCESS ) {
5688                 Debug( LDAP_DEBUG_ANY,
5689                         "pcache_initialize: unable to register queryDelete exop: %d.\n",
5690                         code, 0, 0 );
5691                 return code;
5692         }
5693 #endif /* PCACHE_EXOP_QUERY_DELETE */
5694
5695         argv[ 0 ] = "back-bdb/back-hdb monitor";
5696         c.argv = argv;
5697         c.argc = 3;
5698         c.fname = argv[0];
5699
5700         for ( i = 0; s_oid[ i ].name; i++ ) {
5701                 c.lineno = i;
5702                 argv[ 1 ] = s_oid[ i ].name;
5703                 argv[ 2 ] = s_oid[ i ].oid;
5704
5705                 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5706                         Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5707                                 "unable to add objectIdentifier \"%s=%s\"\n",
5708                                 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5709                         return 1;
5710                 }
5711         }
5712
5713         for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5714                 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5715                 if ( code ) {
5716                         Debug( LDAP_DEBUG_ANY,
5717                                 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5718                         return code;
5719                 }
5720                 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5721         }
5722
5723         for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5724                 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5725                 if ( code ) {
5726                         Debug( LDAP_DEBUG_ANY,
5727                                 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5728                         return code;
5729                 }
5730                 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5731         }
5732
5733         pcache.on_bi.bi_type = "pcache";
5734         pcache.on_bi.bi_obsolete_names = obsolete_names;
5735         pcache.on_bi.bi_db_init = pcache_db_init;
5736         pcache.on_bi.bi_db_config = pcache_db_config;
5737         pcache.on_bi.bi_db_open = pcache_db_open;
5738         pcache.on_bi.bi_db_close = pcache_db_close;
5739         pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5740
5741         pcache.on_bi.bi_op_search = pcache_op_search;
5742         pcache.on_bi.bi_op_bind = pcache_op_bind;
5743 #ifdef PCACHE_CONTROL_PRIVDB
5744         pcache.on_bi.bi_op_compare = pcache_op_privdb;
5745         pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5746         pcache.on_bi.bi_op_modify = pcache_op_privdb;
5747         pcache.on_bi.bi_op_add = pcache_op_privdb;
5748         pcache.on_bi.bi_op_delete = pcache_op_privdb;
5749 #endif /* PCACHE_CONTROL_PRIVDB */
5750         pcache.on_bi.bi_extended = pcache_op_extended;
5751
5752         pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5753         pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5754
5755         pcache.on_bi.bi_cf_ocs = pcocs;
5756
5757         code = config_register_schema( pccfg, pcocs );
5758         if ( code ) return code;
5759
5760         return overlay_register( &pcache );
5761 }
5762
5763 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5764 int init_module(int argc, char *argv[]) {
5765         return pcache_initialize();
5766 }
5767 #endif
5768
5769 #endif  /* defined(SLAPD_OVER_PROXYCACHE) */