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