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-2010 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
2393                 } else if ( si->caching_reason != PC_IGNORE ) {
2394                         CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2395                                 si->qtemp, si->caching_reason, 1 );
2396
2397                         if ( qc != NULL ) {
2398                                 switch ( si->caching_reason ) {
2399                                 case PC_POSITIVE:
2400                                         cache_entries( op, rs, &qc->q_uuid );
2401                                         if ( si->pbi )
2402                                                 si->pbi->bi_cq = qc;
2403                                         break;
2404
2405                                 case PC_SIZELIMIT:
2406                                         qc->q_sizelimit = rs->sr_nentries;
2407                                         break;
2408
2409                                 case PC_NEGATIVE:
2410                                         break;
2411
2412                                 default:
2413                                         assert( 0 );
2414                                         break;
2415                                 }
2416                                 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2417                                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2418                                 cm->num_cached_queries++;
2419                                 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2420                                                 cm->num_cached_queries, 0, 0 );
2421                                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2422
2423                                 /* If the consistency checker suspended itself,
2424                                  * wake it back up
2425                                  */
2426                                 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2427                                         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2428                                         if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2429                                                 cm->cc_paused = 0;
2430                                                 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2431                                         }
2432                                         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2433                                 }
2434
2435                         } else if ( si->count ) {
2436                                 /* duplicate query, free it */
2437                                 Entry *e;
2438                                 for (;si->head; si->head=e) {
2439                                         e = si->head->e_private;
2440                                         si->head->e_private = NULL;
2441                                         entry_free(si->head);
2442                                 }
2443                         }
2444
2445                 } else {
2446                         filter_free( si->query.filter );
2447                 }
2448
2449                 op->o_callback = op->o_callback->sc_next;
2450                 op->o_tmpfree( cb, op->o_tmpmemctx );
2451         }
2452
2453         return SLAP_CB_CONTINUE;
2454 }
2455
2456 static int
2457 pcache_response(
2458         Operation       *op,
2459         SlapReply       *rs )
2460 {
2461         struct search_info *si = op->o_callback->sc_private;
2462
2463         if ( si->swap_saved_attrs ) {
2464                 rs->sr_attrs = si->save_attrs;
2465                 op->ors_attrs = si->save_attrs;
2466         }
2467
2468         if ( rs->sr_type == REP_SEARCH ) {
2469                 /* don't return more entries than requested by the client */
2470                 if ( si->slimit_exceeded ) {
2471                         return 0;
2472                 }
2473
2474         } else if ( rs->sr_type == REP_RESULT ) {
2475
2476                 if ( si->count ) {
2477                         if ( rs->sr_err == LDAP_SUCCESS ) {
2478                                 si->caching_reason = PC_POSITIVE;
2479
2480                         } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2481                                 && si->qtemp->limitttl )
2482                         {
2483                                 Entry *e;
2484
2485                                 si->caching_reason = PC_SIZELIMIT;
2486                                 for (;si->head; si->head=e) {
2487                                         e = si->head->e_private;
2488                                         si->head->e_private = NULL;
2489                                         entry_free(si->head);
2490                                 }
2491                         }
2492
2493                 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2494                                 rs->sr_err == LDAP_SUCCESS )
2495                 {
2496                         si->caching_reason = PC_NEGATIVE;
2497                 }
2498
2499
2500                 if ( si->slimit_exceeded ) {
2501                         rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2502                 }
2503         }
2504
2505         return SLAP_CB_CONTINUE;
2506 }
2507
2508 /* NOTE: this is a quick workaround to let pcache minimally interact
2509  * with pagedResults.  A more articulated solutions would be to
2510  * perform the remote query without control and cache all results,
2511  * performing the pagedResults search only within the client
2512  * and the proxy.  This requires pcache to understand pagedResults. */
2513 static int
2514 pcache_chk_controls(
2515         Operation       *op,
2516         SlapReply       *rs )
2517 {
2518         const char      *non = "";
2519         const char      *stripped = "";
2520
2521         switch( op->o_pagedresults ) {
2522         case SLAP_CONTROL_NONCRITICAL:
2523                 non = "non-";
2524                 stripped = "; stripped";
2525                 /* fallthru */
2526
2527         case SLAP_CONTROL_CRITICAL:
2528                 Debug( pcache_debug, "%s: "
2529                         "%scritical pagedResults control "
2530                         "disabled with proxy cache%s.\n",
2531                         op->o_log_prefix, non, stripped );
2532
2533                 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2534                 break;
2535
2536         default:
2537                 rs->sr_err = SLAP_CB_CONTINUE;
2538                 break;
2539         }
2540
2541         return rs->sr_err;
2542 }
2543
2544 static int
2545 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2546 {
2547         struct berval vals[2];
2548
2549         {
2550                 const char *text = NULL;
2551                 BER_BVZERO( &vals[0] );
2552                 slap_passwd_hash( pwd, &vals[0], &text );
2553                 if ( BER_BVISEMPTY( &vals[0] )) {
2554                         Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2555                                 text, 0, 0 );
2556                         return LDAP_OTHER;
2557                 }
2558         }
2559
2560         BER_BVZERO( &vals[1] );
2561
2562         {
2563                 Modifications mod;
2564                 SlapReply sr = { REP_RESULT };
2565                 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2566                 int rc;
2567
2568                 mod.sml_op = LDAP_MOD_REPLACE;
2569                 mod.sml_flags = 0;
2570                 mod.sml_desc = slap_schema.si_ad_userPassword;
2571                 mod.sml_type = mod.sml_desc->ad_cname;
2572                 mod.sml_values = vals;
2573                 mod.sml_nvalues = NULL;
2574                 mod.sml_numvals = 1;
2575                 mod.sml_next = NULL;
2576
2577                 op->o_tag = LDAP_REQ_MODIFY;
2578                 op->orm_modlist = &mod;
2579                 op->o_bd = &cm->db;
2580                 op->o_dn = op->o_bd->be_rootdn;
2581                 op->o_ndn = op->o_bd->be_rootndn;
2582                 op->o_callback = &cb;
2583                 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2584                         op->o_req_dn.bv_val, 0, 0 );
2585                 rc = op->o_bd->be_modify( op, &sr );
2586                 ch_free( vals[0].bv_val );
2587                 return rc;
2588         }
2589 }
2590
2591 typedef struct bindcacheinfo {
2592         slap_overinst *on;
2593         CachedQuery *qc;
2594 } bindcacheinfo;
2595
2596 static int
2597 pc_bind_save( Operation *op, SlapReply *rs )
2598 {
2599         if ( rs->sr_err == LDAP_SUCCESS ) {
2600                 bindcacheinfo *bci = op->o_callback->sc_private;
2601                 slap_overinst *on = bci->on;
2602                 cache_manager *cm = on->on_bi.bi_private;
2603
2604                 Operation op2 = *op;
2605                 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2606                         bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2607         }
2608         return SLAP_CB_CONTINUE;
2609 }
2610
2611 static Filter *
2612 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2613         struct berval *fbv )
2614 {
2615         int i, len = 0;
2616         struct berval *vals, pres = BER_BVC("*");
2617         char *p1, *p2, *t1;
2618         Attribute *a;
2619
2620         vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2621                 op->o_tmpmemctx );
2622
2623         for ( i=0; i<temp->bindnattrs; i++ ) {
2624                 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2625                 if ( a && a->a_vals ) {
2626                         vals[i] = a->a_vals[0];
2627                         len += a->a_vals[0].bv_len;
2628                 } else {
2629                         vals[i] = pres;
2630                 }
2631         }
2632         fbv->bv_len = len + temp->bindftemp.bv_len;
2633         fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2634
2635         p1 = temp->bindftemp.bv_val;
2636         p2 = fbv->bv_val;
2637         i = 0;
2638         while ( *p1 ) {
2639                 *p2++ = *p1;
2640                 if ( p1[0] == '=' && p1[1] == ')' ) {
2641                         AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2642                         p2 += vals[i].bv_len;
2643                         i++;
2644                 }
2645                 p1++;
2646         }
2647         *p2 = '\0';
2648         op->o_tmpfree( vals, op->o_tmpmemctx );
2649
2650         /* FIXME: are we sure str2filter_x can't fail?
2651          * caller needs to check */
2652         {
2653                 Filter *f = str2filter_x( op, fbv->bv_val );
2654                 assert( f != NULL );
2655                 return f;
2656         }
2657 }
2658
2659 /* Check if the requested entry is from the cache and has a valid
2660  * ttr and password hash
2661  */
2662 static int
2663 pc_bind_search( Operation *op, SlapReply *rs )
2664 {
2665         if ( rs->sr_type == REP_SEARCH ) {
2666                 bindinfo *pbi = op->o_callback->sc_private;
2667
2668                 /* We only care if this is an already cached result and we're
2669                  * below the refresh time, or we're offline.
2670                  */
2671                 if ( pbi->bi_cq ) {
2672                         if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2673                                 op->o_time < pbi->bi_cq->bindref_time ) {
2674                                 Attribute *a;
2675
2676                                 /* See if a recognized password is hashed here */
2677                                 a = attr_find( rs->sr_entry->e_attrs,
2678                                         slap_schema.si_ad_userPassword );
2679                                 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2680                                         lutil_passwd_scheme( a->a_vals[0].bv_val ))
2681                                         pbi->bi_flags |= BI_HASHED;
2682                         } else {
2683                                 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2684                                         "reftime: %ld, current time: %ld\n",
2685                                         pbi->bi_cq->bindref_time, op->o_time, 0 );
2686                         }
2687                 } else if ( pbi->bi_si ) {
2688                         /* This search result is going into the cache */
2689                         struct berval fbv;
2690                         Filter *f;
2691
2692                         filter_free( pbi->bi_si->query.filter );
2693                         f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2694                         op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2695                         pbi->bi_si->query.filter = filter_dup( f, NULL );
2696                         filter_free_x( op, f, 1 );
2697                 }
2698         }
2699         return 0;
2700 }
2701
2702 /* We always want pc_bind_search to run after the search handlers */
2703 static int
2704 pc_bind_resp( Operation *op, SlapReply *rs )
2705 {
2706         bindinfo *pbi = op->o_callback->sc_private;
2707         if ( !( pbi->bi_flags & BI_DIDCB )) {
2708                 slap_callback *sc = op->o_callback;
2709                 while ( sc && sc->sc_response != pcache_response )
2710                         sc = sc->sc_next;
2711                 if ( !sc )
2712                         sc = op->o_callback;
2713                 pbi->bi_cb.sc_next = sc->sc_next;
2714                 sc->sc_next = &pbi->bi_cb;
2715                 pbi->bi_flags |= BI_DIDCB;
2716         }
2717         return SLAP_CB_CONTINUE;
2718 }
2719
2720 #ifdef PCACHE_CONTROL_PRIVDB
2721 static int
2722 pcache_op_privdb(
2723         Operation               *op,
2724         SlapReply               *rs )
2725 {
2726         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
2727         cache_manager   *cm = on->on_bi.bi_private;
2728         slap_callback   *save_cb;
2729         slap_op_t       type;
2730
2731         /* skip if control is unset */
2732         if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2733                 return SLAP_CB_CONTINUE;
2734         }
2735
2736         /* The cache DB isn't open yet */
2737         if ( cm->defer_db_open ) {
2738                 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2739                         "pcachePrivDB: cacheDB not available" );
2740                 return rs->sr_err;
2741         }
2742
2743         /* FIXME: might be a little bit exaggerated... */
2744         if ( !be_isroot( op ) ) {
2745                 save_cb = op->o_callback;
2746                 op->o_callback = NULL;
2747                 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2748                         "pcachePrivDB: operation not allowed" );
2749                 op->o_callback = save_cb;
2750
2751                 return rs->sr_err;
2752         }
2753
2754         /* map tag to operation */
2755         type = slap_req2op( op->o_tag );
2756         if ( type != SLAP_OP_LAST ) {
2757                 BI_op_func      **func;
2758                 int             rc;
2759
2760                 /* execute, if possible */
2761                 func = &cm->db.be_bind;
2762                 if ( func[ type ] != NULL ) {
2763                         Operation       op2 = *op;
2764
2765                         op2.o_bd = &cm->db;
2766
2767                         rc = func[ type ]( &op2, rs );
2768                         if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2769                                 op->o_conn->c_authz_cookie = cm->db.be_private;
2770                         }
2771
2772                         return rs->sr_err;
2773                 }
2774         }
2775
2776         /* otherwise fall back to error */
2777         save_cb = op->o_callback;
2778         op->o_callback = NULL;
2779         send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2780                 "operation not supported with pcachePrivDB control" );
2781         op->o_callback = save_cb;
2782
2783         return rs->sr_err;
2784 }
2785 #endif /* PCACHE_CONTROL_PRIVDB */
2786
2787 static int
2788 pcache_op_bind(
2789         Operation               *op,
2790         SlapReply               *rs )
2791 {
2792         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
2793         cache_manager   *cm = on->on_bi.bi_private;
2794         QueryTemplate *temp;
2795         Entry *e;
2796         slap_callback   cb = { 0 }, *sc;
2797         bindinfo bi;
2798         bindcacheinfo *bci;
2799         Operation op2;
2800         int rc;
2801
2802 #ifdef PCACHE_CONTROL_PRIVDB
2803         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2804                 return pcache_op_privdb( op, rs );
2805 #endif /* PCACHE_CONTROL_PRIVDB */
2806
2807         /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2808         if ( !cm->cache_binds || cm->defer_db_open )
2809                 return SLAP_CB_CONTINUE;
2810
2811         /* First find a matching template with Bind info */
2812         for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2813                 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2814                         break;
2815         }
2816         /* Didn't find a suitable template, just passthru */
2817         if ( !temp )
2818                 return SLAP_CB_CONTINUE;
2819
2820         /* See if the entry is already locally cached. If so, we can
2821          * populate the query filter to retrieve the cached query. We
2822          * need to check the bindrefresh time in the query.
2823          */
2824         op2 = *op;
2825         op2.o_dn = op->o_bd->be_rootdn;
2826         op2.o_ndn = op->o_bd->be_rootndn;
2827         bi.bi_flags = 0;
2828
2829         op2.o_bd = &cm->db;
2830         e = NULL;
2831         rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2832         if ( rc == LDAP_SUCCESS && e ) {
2833                 bi.bi_flags |= BI_LOOKUP;
2834                 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2835                 be_entry_release_r( &op2, e );
2836         } else {
2837                 op2.ors_filter = temp->bindfilter;
2838                 op2.ors_filterstr = temp->bindfilterstr;
2839         }
2840
2841         op2.o_bd = op->o_bd;
2842         op2.o_tag = LDAP_REQ_SEARCH;
2843         op2.ors_scope = LDAP_SCOPE_BASE;
2844         op2.ors_deref = LDAP_DEREF_NEVER;
2845         op2.ors_slimit = 1;
2846         op2.ors_tlimit = SLAP_NO_LIMIT;
2847         op2.ors_limit = NULL;
2848         op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2849         op2.ors_attrsonly = 0;
2850
2851         /* We want to invoke search at the same level of the stack
2852          * as we're already at...
2853          */
2854         bi.bi_cm = cm;
2855         bi.bi_templ = temp;
2856         bi.bi_cq = NULL;
2857         bi.bi_si = NULL;
2858
2859         bi.bi_cb.sc_response = pc_bind_search;
2860         bi.bi_cb.sc_cleanup = NULL;
2861         bi.bi_cb.sc_private = &bi;
2862         cb.sc_private = &bi;
2863         cb.sc_response = pc_bind_resp;
2864         op2.o_callback = &cb;
2865         overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2866
2867         /* OK, just bind locally */
2868         if ( bi.bi_flags & BI_HASHED ) {
2869                 BackendDB *be = op->o_bd;
2870                 op->o_bd = &cm->db;
2871
2872                 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2873                         op->o_req_dn.bv_val, 0, 0 );
2874
2875                 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2876                         op->o_conn->c_authz_cookie = cm->db.be_private;
2877                 }
2878                 op->o_bd = be;
2879                 return rs->sr_err;
2880         }
2881
2882         /* We have a cached query to work with */
2883         if ( bi.bi_cq ) {
2884                 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2885                         op->o_tmpmemctx );
2886                 sc->sc_response = pc_bind_save;
2887                 sc->sc_cleanup = NULL;
2888                 sc->sc_private = sc+1;
2889                 bci = sc->sc_private;
2890                 sc->sc_next = op->o_callback;
2891                 op->o_callback = sc;
2892                 bci->on = on;
2893                 bci->qc = bi.bi_cq;
2894         }
2895         return SLAP_CB_CONTINUE;
2896 }
2897
2898 static int
2899 pcache_op_search(
2900         Operation       *op,
2901         SlapReply       *rs )
2902 {
2903         slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2904         cache_manager *cm = on->on_bi.bi_private;
2905         query_manager*          qm = cm->qm;
2906
2907         int i = -1;
2908
2909         Query           query;
2910         QueryTemplate   *qtemp = NULL;
2911         bindinfo *pbi = NULL;
2912
2913         int             attr_set = -1;
2914         CachedQuery     *answerable = NULL;
2915         int             cacheable = 0;
2916
2917         struct berval   tempstr;
2918
2919 #ifdef PCACHE_CONTROL_PRIVDB
2920         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2921                 return pcache_op_privdb( op, rs );
2922         }
2923 #endif /* PCACHE_CONTROL_PRIVDB */
2924
2925         /* The cache DB isn't open yet */
2926         if ( cm->defer_db_open ) {
2927                 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2928                         "pcachePrivDB: cacheDB not available" );
2929                 return rs->sr_err;
2930         }
2931
2932         /* pickup runtime ACL changes */
2933         cm->db.be_acl = op->o_bd->be_acl;
2934
2935         {
2936                 /* See if we're processing a Bind request */
2937                 slap_callback *cb = op->o_callback;
2938
2939                 for ( ; cb; cb=cb->sc_next ) {
2940                         if ( cb->sc_response == pc_bind_resp ) {
2941                                 pbi = cb->sc_private;
2942                                 break;
2943                         }
2944                 }
2945         }
2946
2947         /* FIXME: cannot cache/answer requests with pagedResults control */
2948
2949         query.filter = op->ors_filter;
2950
2951         if ( pbi ) {
2952                 query.base = pbi->bi_templ->bindbase;
2953                 query.scope = pbi->bi_templ->bindscope;
2954                 attr_set = pbi->bi_templ->attr_set_index;
2955                 cacheable = 1;
2956                 qtemp = pbi->bi_templ;
2957                 if ( pbi->bi_flags & BI_LOOKUP )
2958                         answerable = qm->qcfunc(op, qm, &query, qtemp);
2959
2960         } else {
2961                 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2962                         op->o_tmpmemctx );
2963                 tempstr.bv_len = 0;
2964                 if ( filter2template( op, op->ors_filter, &tempstr ))
2965                 {
2966                         op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2967                         return SLAP_CB_CONTINUE;
2968                 }
2969
2970                 Debug( pcache_debug, "query template of incoming query = %s\n",
2971                                                 tempstr.bv_val, 0, 0 );
2972
2973                 /* find attr set */
2974                 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2975
2976                 query.base = op->o_req_ndn;
2977                 query.scope = op->ors_scope;
2978
2979                 /* check for query containment */
2980                 if (attr_set > -1) {
2981                         QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2982                         for (; qt; qt = qt->qtnext ) {
2983                                 /* find if template i can potentially answer tempstr */
2984                                 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2985                                         continue;
2986                                 cacheable = 1;
2987                                 qtemp = qt;
2988                                 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2989                                                 op->ors_filterstr.bv_val, 0, 0 );
2990                                 answerable = qm->qcfunc(op, qm, &query, qt);
2991
2992                                 /* if != NULL, rlocks qtemp->t_rwlock */
2993                                 if (answerable)
2994                                         break;
2995                         }
2996                 }
2997                 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2998         }
2999
3000         if (answerable) {
3001                 BackendDB       *save_bd = op->o_bd;
3002
3003                 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
3004                 answerable->answerable_cnt++;
3005                 /* we only care about refcnts if we're refreshing */
3006                 if ( answerable->refresh_time )
3007                         answerable->refcnt++;
3008                 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3009                         answerable->answerable_cnt, 0, 0 );
3010                 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3011
3012                 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
3013                 if ( BER_BVISNULL( &answerable->q_uuid )) {
3014                         /* No entries cached, just an empty result set */
3015                         i = rs->sr_err = 0;
3016                         send_ldap_result( op, rs );
3017                 } else {
3018                         /* Let Bind know we used a cached query */
3019                         if ( pbi )
3020                                 pbi->bi_cq = answerable;
3021
3022                         op->o_bd = &cm->db;
3023                         if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3024                                 slap_callback cb;
3025                                 /* The cached entry was already processed by any
3026                                  * other overlays, so don't let it get processed again.
3027                                  *
3028                                  * This loop removes over_back_response from the stack.
3029                                  */
3030                                 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3031                                         slap_callback **scp;
3032                                         for ( scp = &op->o_callback; *scp != NULL;
3033                                                 scp = &(*scp)->sc_next ) {
3034                                                 if ( (*scp)->sc_next == &cb ) {
3035                                                         *scp = cb.sc_next;
3036                                                         break;
3037                                                 }
3038                                         }
3039                                 }
3040                         }
3041                         i = cm->db.bd_info->bi_op_search( op, rs );
3042                 }
3043                 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
3044                 /* locked by qtemp->qcfunc (query_containment) */
3045                 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3046                 op->o_bd = save_bd;
3047                 return i;
3048         }
3049
3050         Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3051
3052         ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3053         if (cm->num_cached_queries >= cm->max_queries) {
3054                 cacheable = 0;
3055         }
3056         ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3057
3058         if (op->ors_attrsonly)
3059                 cacheable = 0;
3060
3061         if (cacheable) {
3062                 slap_callback           *cb;
3063                 struct search_info      *si;
3064
3065                 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3066                 query.filter = filter_dup(op->ors_filter, NULL);
3067
3068                 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3069                 cb->sc_response = pcache_response;
3070                 cb->sc_cleanup = pcache_op_cleanup;
3071                 cb->sc_private = (cb+1);
3072                 si = cb->sc_private;
3073                 si->on = on;
3074                 si->query = query;
3075                 si->qtemp = qtemp;
3076                 si->max = cm->num_entries_limit ;
3077                 si->over = 0;
3078                 si->count = 0;
3079                 si->slimit = 0;
3080                 si->slimit_exceeded = 0;
3081                 si->caching_reason = PC_IGNORE;
3082                 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3083                         si->slimit = op->ors_slimit;
3084                         op->ors_slimit = cm->num_entries_limit;
3085                 }
3086                 si->head = NULL;
3087                 si->tail = NULL;
3088                 si->swap_saved_attrs = 1;
3089                 si->save_attrs = op->ors_attrs;
3090                 si->pbi = pbi;
3091                 if ( pbi )
3092                         pbi->bi_si = si;
3093
3094                 op->ors_attrs = qtemp->t_attrs.attrs;
3095
3096                 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3097                         cb->sc_next = op->o_callback;
3098                         op->o_callback = cb;
3099
3100                 } else {
3101                         slap_callback           **pcb;
3102
3103                         /* need to move the callback at the end, in case other
3104                          * overlays are present, so that the final entry is
3105                          * actually cached */
3106                         cb->sc_next = NULL;
3107                         for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3108                         *pcb = cb;
3109                 }
3110
3111         } else {
3112                 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3113                                         0, 0, 0);
3114         }
3115
3116         return SLAP_CB_CONTINUE;
3117 }
3118
3119 static int
3120 get_attr_set(
3121         AttributeName* attrs,
3122         query_manager* qm,
3123         int num )
3124 {
3125         int i = 0;
3126         int count = 0;
3127
3128         if ( attrs ) {
3129                 for ( ; attrs[i].an_name.bv_val; i++ ) {
3130                         /* only count valid attribute names
3131                          * (searches ignore others, this overlay does the same) */
3132                         if ( attrs[i].an_desc ) {
3133                                 count++;
3134                         }
3135                 }
3136         }
3137
3138         /* recognize default or explicit single "*" */
3139         if ( ! attrs ||
3140                 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_all_user_attrs ) ) )
3141         {
3142                 count = 1;
3143                 attrs = slap_anlist_all_user_attributes;
3144
3145         /* recognize implicit (no valid attributes) or explicit single "1.1" */
3146         } else if ( count == 0 ||
3147                 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) )
3148         {
3149                 count = 0;
3150                 attrs = NULL;
3151         }
3152
3153         for ( i = 0; i < num; i++ ) {
3154                 AttributeName *a2;
3155                 int found = 1;
3156
3157                 if ( count > qm->attr_sets[i].count ) {
3158                         continue;
3159                 }
3160
3161                 if ( !count ) {
3162                         if ( !qm->attr_sets[i].count ) {
3163                                 break;
3164                         }
3165                         continue;
3166                 }
3167
3168                 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3169                         if ( !a2->an_desc && !bvmatch( &a2->an_name, slap_bv_all_user_attrs ) ) continue;
3170
3171                         if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3172                                 found = 0;
3173                                 break;
3174                         }
3175                 }
3176
3177                 if ( found ) {
3178                         break;
3179                 }
3180         }
3181
3182         if ( i == num ) {
3183                 i = -1;
3184         }
3185
3186         return i;
3187 }
3188
3189 /* Refresh a cached query:
3190  * 1: Replay the query on the remote DB and merge each entry into
3191  * the local DB. Remember the DNs of each remote entry.
3192  * 2: Search the local DB for all entries matching this queryID.
3193  * Delete any entry whose DN is not in the list from (1).
3194  */
3195 typedef struct dnlist {
3196         struct dnlist *next;
3197         struct berval dn;
3198         char delete;
3199 } dnlist;
3200
3201 typedef struct refresh_info {
3202         dnlist *ri_dns;
3203         dnlist *ri_tail;
3204         dnlist *ri_dels;
3205         BackendDB *ri_be;
3206         CachedQuery *ri_q;
3207 } refresh_info;
3208
3209 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3210 {
3211         dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3212                         op->o_tmpmemctx );
3213         dn->dn.bv_len = bvdn->bv_len;
3214         dn->dn.bv_val = (char *)(dn+1);
3215         AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3216         dn->dn.bv_val[dn->dn.bv_len] = '\0';
3217         return dn;
3218 }
3219
3220 static int
3221 refresh_merge( Operation *op, SlapReply *rs )
3222 {
3223         if ( rs->sr_type == REP_SEARCH ) {
3224                 refresh_info *ri = op->o_callback->sc_private;
3225                 BackendDB *be = op->o_bd;
3226                 Entry *e;
3227                 dnlist *dnl;
3228                 slap_callback *ocb;
3229                 int rc;
3230
3231                 ocb = op->o_callback;
3232                 /* Find local entry, merge */
3233                 op->o_bd = ri->ri_be;
3234                 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3235                 if ( rc != LDAP_SUCCESS || e == NULL ) {
3236                         /* No local entry, just add it. FIXME: we are not checking
3237                          * the cache entry limit here
3238                          */
3239                          merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3240                 } else {
3241                         /* Entry exists, update it */
3242                         Entry ne;
3243                         Attribute *a, **b;
3244                         Modifications *modlist, *mods = NULL;
3245                         const char*     text = NULL;
3246                         char                    textbuf[SLAP_TEXT_BUFLEN];
3247                         size_t                  textlen = sizeof(textbuf);
3248                         slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3249
3250                         ne = *e;
3251                         b = &ne.e_attrs;
3252                         /* Get a copy of only the attrs we requested */
3253                         for ( a=e->e_attrs; a; a=a->a_next ) {
3254                                 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3255                                         *b = attr_alloc( a->a_desc );
3256                                         *(*b) = *a;
3257                                         /* The actual values still belong to e */
3258                                         (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3259                                                 SLAP_ATTR_DONT_FREE_DATA;
3260                                         b = &((*b)->a_next);
3261                                 }
3262                         }
3263                         *b = NULL;
3264                         slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3265                         syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3266                                 &mods, &modlist, 0 );
3267                         be_entry_release_r( op, e );
3268                         attrs_free( ne.e_attrs );
3269                         slap_mods_free( modlist, 1 );
3270                         /* mods is NULL if there are no changes */
3271                         if ( mods ) {
3272                                 struct berval dn = op->o_req_dn;
3273                                 struct berval ndn = op->o_req_ndn;
3274                                 op->o_tag = LDAP_REQ_MODIFY;
3275                                 op->orm_modlist = mods;
3276                                 op->o_req_dn = rs->sr_entry->e_name;
3277                                 op->o_req_ndn = rs->sr_entry->e_nname;
3278                                 op->o_callback = &cb;
3279                                 op->o_bd->be_modify( op, rs );
3280                                 slap_mods_free( mods, 1 );
3281                                 op->o_req_dn = dn;
3282                                 op->o_req_ndn = ndn;
3283                         }
3284                 }
3285
3286                 /* Add DN to list */
3287                 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3288                 dnl->next = NULL;
3289                 if ( ri->ri_tail ) {
3290                         ri->ri_tail->next = dnl;
3291                 } else {
3292                         ri->ri_dns = dnl;
3293                 }
3294                 ri->ri_tail = dnl;
3295                 op->o_callback = ocb;
3296         }
3297         return 0;
3298 }
3299
3300 static int
3301 refresh_purge( Operation *op, SlapReply *rs )
3302 {
3303         if ( rs->sr_type == REP_SEARCH ) {
3304                 refresh_info *ri = op->o_callback->sc_private;
3305                 dnlist **dn;
3306                 int del = 1;
3307
3308                 /* Did the entry exist on the remote? */
3309                 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3310                         if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3311                                 dnlist *dnext = (*dn)->next;
3312                                 op->o_tmpfree( *dn, op->o_tmpmemctx );
3313                                 *dn = dnext;
3314                                 del = 0;
3315                                 break;
3316                         }
3317                 }
3318                 /* No, so put it on the list to delete */
3319                 if ( del ) {
3320                         Attribute *a;
3321                         dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3322                         dnl->next = ri->ri_dels;
3323                         ri->ri_dels = dnl;
3324                         a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3325                         /* If ours is the only queryId, delete entry */
3326                         dnl->delete = ( a->a_numvals == 1 );
3327                 }
3328         }
3329         return 0;
3330 }
3331
3332 static int
3333 refresh_query( Operation *op, SlapReply *rs, CachedQuery *query,
3334         slap_overinst *on )
3335 {
3336         slap_callback cb = { 0 };
3337         refresh_info ri = { 0 };
3338         char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3339         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
3340         Filter filter = {LDAP_FILTER_EQUALITY};
3341         AttributeName attrs[ 2 ] = {{{ 0 }}};
3342         dnlist *dn;
3343         int rc;
3344
3345         ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3346         query->refcnt = 0;
3347         ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3348
3349         cb.sc_response = refresh_merge;
3350         cb.sc_private = &ri;
3351
3352         /* cache DB */
3353         ri.ri_be = op->o_bd;
3354         ri.ri_q = query;
3355
3356         op->o_tag = LDAP_REQ_SEARCH;
3357         op->o_protocol = LDAP_VERSION3;
3358         op->o_callback = &cb;
3359         op->o_do_not_cache = 1;
3360
3361         op->o_req_dn = query->qbase->base;
3362         op->o_req_ndn = query->qbase->base;
3363         op->ors_scope = query->scope;
3364         op->ors_slimit = SLAP_NO_LIMIT;
3365         op->ors_tlimit = SLAP_NO_LIMIT;
3366         op->ors_limit = NULL;
3367         op->ors_filter = query->filter;
3368         filter2bv_x( op, query->filter, &op->ors_filterstr );
3369         op->ors_attrs = query->qtemp->t_attrs.attrs;
3370         op->ors_attrsonly = 0;
3371
3372         op->o_bd = on->on_info->oi_origdb;
3373         rc = op->o_bd->be_search( op, rs );
3374         if ( rc ) {
3375                 op->o_bd = ri.ri_be;
3376                 goto leave;
3377         }
3378
3379         /* Get the DNs of all entries matching this query */
3380         cb.sc_response = refresh_purge;
3381
3382         op->o_bd = ri.ri_be;
3383         op->o_req_dn = op->o_bd->be_suffix[0];
3384         op->o_req_ndn = op->o_bd->be_nsuffix[0];
3385         op->ors_scope = LDAP_SCOPE_SUBTREE;
3386         op->ors_deref = LDAP_DEREF_NEVER;
3387         op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3388                 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3389         filter.f_ava = &ava;
3390         filter.f_av_desc = ad_queryId;
3391         filter.f_av_value = query->q_uuid;
3392         attrs[ 0 ].an_desc = ad_queryId;
3393         attrs[ 0 ].an_name = ad_queryId->ad_cname;
3394         op->ors_attrs = attrs;
3395         op->ors_attrsonly = 0;
3396         rs->sr_entry = NULL;
3397         rs->sr_nentries = 0;
3398         rc = op->o_bd->be_search( op, rs );
3399         if ( rc ) goto leave;
3400
3401         while (( dn = ri.ri_dels )) {
3402                 op->o_req_dn = dn->dn;
3403                 op->o_req_ndn = dn->dn;
3404                 if ( dn->delete ) {
3405                         op->o_tag = LDAP_REQ_DELETE;
3406                         op->o_bd->be_delete( op, rs );
3407                 } else {
3408                         Modifications mod;
3409                         struct berval vals[2];
3410
3411                         vals[0] = query->q_uuid;
3412                         BER_BVZERO( &vals[1] );
3413                         mod.sml_op = LDAP_MOD_DELETE;
3414                         mod.sml_flags = 0;
3415                         mod.sml_desc = ad_queryId;
3416                         mod.sml_type = ad_queryId->ad_cname;
3417                         mod.sml_values = vals;
3418                         mod.sml_nvalues = NULL;
3419                         mod.sml_numvals = 1;
3420                         mod.sml_next = NULL;
3421
3422                         op->o_tag = LDAP_REQ_MODIFY;
3423                         op->orm_modlist = &mod;
3424                         op->o_bd->be_modify( op, rs );
3425                 }
3426                 ri.ri_dels = dn->next;
3427                 op->o_tmpfree( dn, op->o_tmpmemctx );
3428         }
3429
3430 leave:
3431         /* reset our local heap, we're done with it */
3432         slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3433         return rc;
3434 }
3435
3436 static void*
3437 consistency_check(
3438         void *ctx,
3439         void *arg )
3440 {
3441         struct re_s *rtask = arg;
3442         slap_overinst *on = rtask->arg;
3443         cache_manager *cm = on->on_bi.bi_private;
3444         query_manager *qm = cm->qm;
3445         Connection conn = {0};
3446         OperationBuffer opbuf;
3447         Operation *op;
3448
3449         SlapReply rs = {REP_RESULT};
3450         CachedQuery *query, *qprev;
3451         int return_val, pause = PCACHE_CC_PAUSED;
3452         QueryTemplate *templ;
3453
3454         /* Don't expire anything when we're offline */
3455         if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3456                 pause = PCACHE_CC_OFFLINE;
3457                 goto leave;
3458         }
3459
3460         connection_fake_init( &conn, &opbuf, ctx );
3461         op = &opbuf.ob_op;
3462
3463         op->o_bd = &cm->db;
3464         op->o_dn = cm->db.be_rootdn;
3465         op->o_ndn = cm->db.be_rootndn;
3466
3467         cm->cc_arg = arg;
3468
3469         for (templ = qm->templates; templ; templ=templ->qmnext) {
3470                 time_t ttl;
3471                 if ( !templ->query_last ) continue;
3472                 pause = 0;
3473                 op->o_time = slap_get_time();
3474                 if ( !templ->ttr ) {
3475                         ttl = templ->ttl;
3476                         if ( templ->negttl && templ->negttl < ttl )
3477                                 ttl = templ->negttl;
3478                         if ( templ->limitttl && templ->limitttl < ttl )
3479                                 ttl = templ->limitttl;
3480                         /* The oldest timestamp that needs expiration checking */
3481                         ttl += op->o_time;
3482                 }
3483
3484                 for ( query=templ->query_last; query; query=qprev ) {
3485                         qprev = query->prev;
3486                         if ( query->refresh_time && query->refresh_time < op->o_time ) {
3487                                 /* A refresh will extend the expiry if the query has been
3488                                  * referenced, but not if it's unreferenced. If the
3489                                  * expiration has been hit, then skip the refresh since
3490                                  * we're just going to discard the result anyway.
3491                                  */
3492                                 if ( query->refcnt )
3493                                         query->expiry_time = op->o_time + templ->ttl;
3494                                 if ( query->expiry_time > op->o_time ) {
3495                                         refresh_query( op, &rs, query, on );
3496                                         continue;
3497                                 }
3498                         }
3499
3500                         if (query->expiry_time < op->o_time) {
3501                                 int rem = 0;
3502                                 Debug( pcache_debug, "Lock CR index = %p\n",
3503                                                 (void *) templ, 0, 0 );
3504                                 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3505                                 if ( query == templ->query_last ) {
3506                                         rem = 1;
3507                                         remove_from_template(query, templ);
3508                                         Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3509                                                         (void *) templ, templ->no_of_queries, 0 );
3510                                         Debug( pcache_debug, "Unlock CR index = %p\n",
3511                                                         (void *) templ, 0, 0 );
3512                                 }
3513                                 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3514                                 if ( !rem ) {
3515                                         continue;
3516                                 }
3517                                 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3518                                 remove_query(qm, query);
3519                                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3520                                 if ( BER_BVISNULL( &query->q_uuid ))
3521                                         return_val = 0;
3522                                 else
3523                                         return_val = remove_query_data(op, &rs, &query->q_uuid);
3524                                 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3525                                                         return_val, 0, 0 );
3526                                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3527                                 cm->cur_entries -= return_val;
3528                                 cm->num_cached_queries--;
3529                                 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3530                                                 cm->num_cached_queries, 0, 0 );
3531                                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3532                                 Debug( pcache_debug,
3533                                         "STALE QUERY REMOVED, CACHE ="
3534                                         "%d entries\n",
3535                                         cm->cur_entries, 0, 0 );
3536                                 free_query(query);
3537                         } else if ( !templ->ttr && query->expiry_time > ttl ) {
3538                                 /* We don't need to check for refreshes, and this
3539                                  * query's expiry is too new, and all subsequent queries
3540                                  * will be newer yet. So stop looking.
3541                                  *
3542                                  * If we have refreshes, then we always have to walk the
3543                                  * entire query list.
3544                                  */
3545                                 break;
3546                         }
3547                 }
3548         }
3549
3550 leave:
3551         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3552         if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3553                 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3554         }
3555         /* If there were no queries, defer processing for a while */
3556         if ( cm->cc_paused != pause )
3557                 cm->cc_paused = pause;
3558         ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3559
3560         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3561         return NULL;
3562 }
3563
3564
3565 #define MAX_ATTR_SETS 500
3566
3567 enum {
3568         PC_MAIN = 1,
3569         PC_ATTR,
3570         PC_TEMP,
3571         PC_RESP,
3572         PC_QUERIES,
3573         PC_OFFLINE,
3574         PC_BIND,
3575         PC_PRIVATE_DB
3576 };
3577
3578 static ConfigDriver pc_cf_gen;
3579 static ConfigLDAPadd pc_ldadd;
3580 static ConfigCfAdd pc_cfadd;
3581
3582 static ConfigTable pccfg[] = {
3583         { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3584                                 "<cycle_time",
3585                 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3586                 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3587                         "DESC 'Proxy Cache basic parameters' "
3588                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3589         { "pcacheAttrset", "index> <attributes...",
3590                 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3591                 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3592                         "DESC 'A set of attributes to cache' "
3593                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3594         { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3595                         "<limitTTL> <TTR",
3596                 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3597                 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3598                         "DESC 'Filter template, attrset, cache TTL, "
3599                                 "optional negative TTL, optional sizelimit TTL, "
3600                                 "optional TTR' "
3601                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3602         { "pcachePosition", "head|tail(default)",
3603                 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3604                 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3605                         "DESC 'Response callback position in overlay stack' "
3606                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3607         { "pcacheMaxQueries", "queries",
3608                 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3609                 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3610                         "DESC 'Maximum number of queries to cache' "
3611                         "SYNTAX OMsInteger )", NULL, NULL },
3612         { "pcachePersist", "TRUE|FALSE",
3613                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3614                 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3615                         "DESC 'Save cached queries for hot restart' "
3616                         "SYNTAX OMsBoolean )", NULL, NULL },
3617         { "pcacheValidate", "TRUE|FALSE",
3618                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3619                 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3620                         "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3621                         "SYNTAX OMsBoolean )", NULL, NULL },
3622         { "pcacheOffline", "TRUE|FALSE",
3623                 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3624                 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3625                         "DESC 'Set cache to offline mode and disable expiration' "
3626                         "SYNTAX OMsBoolean )", NULL, NULL },
3627         { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3628                 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3629                 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3630                         "DESC 'Parameters for caching Binds' "
3631                         "SYNTAX OMsDirectoryString )", NULL, NULL },
3632         { "pcache-", "private database args",
3633                 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3634                 NULL, NULL, NULL },
3635
3636         /* Legacy keywords */
3637         { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3638                                 "<cycle_time",
3639                 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3640                 NULL, NULL, NULL },
3641         { "proxyattrset", "index> <attributes...",
3642                 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3643                 NULL, NULL, NULL },
3644         { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3645                 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3646                 NULL, NULL, NULL },
3647         { "response-callback", "head|tail(default)",
3648                 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3649                 NULL, NULL, NULL },
3650         { "proxyCacheQueries", "queries",
3651                 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3652                 NULL, NULL, NULL },
3653         { "proxySaveQueries", "TRUE|FALSE",
3654                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3655                 NULL, NULL, NULL },
3656         { "proxyCheckCacheability", "TRUE|FALSE",
3657                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3658                 NULL, NULL, NULL },
3659
3660         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3661 };
3662
3663 static ConfigOCs pcocs[] = {
3664         { "( OLcfgOvOc:2.1 "
3665                 "NAME 'olcPcacheConfig' "
3666                 "DESC 'ProxyCache configuration' "
3667                 "SUP olcOverlayConfig "
3668                 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3669                 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3670                         "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3671                 Cft_Overlay, pccfg, NULL, pc_cfadd },
3672         { "( OLcfgOvOc:2.2 "
3673                 "NAME 'olcPcacheDatabase' "
3674                 "DESC 'Cache database configuration' "
3675                 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3676         { NULL, 0, NULL }
3677 };
3678
3679 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3680
3681 static int
3682 pc_ldadd_cleanup( ConfigArgs *c )
3683 {
3684         slap_overinst *on = c->ca_private;
3685         return pcache_db_open2( on, &c->reply );
3686 }
3687
3688 static int
3689 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3690 {
3691         slap_overinst *on;
3692         cache_manager *cm;
3693
3694         if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3695                 p->ce_bi->bi_cf_ocs != pcocs )
3696                 return LDAP_CONSTRAINT_VIOLATION;
3697
3698         on = (slap_overinst *)p->ce_bi;
3699         cm = on->on_bi.bi_private;
3700         ca->be = &cm->db;
3701         /* Defer open if this is an LDAPadd */
3702         if ( CONFIG_ONLINE_ADD( ca ))
3703                 ca->cleanup = pc_ldadd_cleanup;
3704         else
3705                 cm->defer_db_open = 0;
3706         ca->ca_private = on;
3707         return LDAP_SUCCESS;
3708 }
3709
3710 static int
3711 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3712 {
3713         CfEntryInfo *pe = p->e_private;
3714         slap_overinst *on = (slap_overinst *)pe->ce_bi;
3715         cache_manager *cm = on->on_bi.bi_private;
3716         struct berval bv;
3717
3718         /* FIXME: should not hardcode "olcDatabase" here */
3719         bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3720                 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3721                 0, cm->db.bd_info->bi_type );
3722         if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3723                 return -1;
3724         }
3725         bv.bv_val = ca->cr_msg;
3726         ca->be = &cm->db;
3727         cm->defer_db_open = 0;
3728
3729         /* We can only create this entry if the database is table-driven
3730          */
3731         if ( cm->db.bd_info->bi_cf_ocs )
3732                 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3733                         &pcocs[1] );
3734
3735         return 0;
3736 }
3737
3738 static int
3739 pc_cf_gen( ConfigArgs *c )
3740 {
3741         slap_overinst   *on = (slap_overinst *)c->bi;
3742         cache_manager*  cm = on->on_bi.bi_private;
3743         query_manager*  qm = cm->qm;
3744         QueryTemplate*  temp;
3745         AttributeName*  attr_name;
3746         AttributeName*  attrarray;
3747         const char*     text=NULL;
3748         int             i, num, rc = 0;
3749         char            *ptr;
3750         unsigned long   t;
3751
3752         if ( c->op == SLAP_CONFIG_EMIT ) {
3753                 struct berval bv;
3754                 switch( c->type ) {
3755                 case PC_MAIN:
3756                         bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3757                                 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3758                                 cm->num_entries_limit, cm->cc_period );
3759                         bv.bv_val = c->cr_msg;
3760                         value_add_one( &c->rvalue_vals, &bv );
3761                         break;
3762                 case PC_ATTR:
3763                         for (i=0; i<cm->numattrsets; i++) {
3764                                 if ( !qm->attr_sets[i].count ) continue;
3765
3766                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3767
3768                                 /* count the attr length */
3769                                 for ( attr_name = qm->attr_sets[i].attrs;
3770                                         attr_name->an_name.bv_val; attr_name++ )
3771                                         bv.bv_len += attr_name->an_name.bv_len + 1;
3772
3773                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
3774                                 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3775                                 for ( attr_name = qm->attr_sets[i].attrs;
3776                                         attr_name->an_name.bv_val; attr_name++ ) {
3777                                         *ptr++ = ' ';
3778                                         ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3779                                 }
3780                                 ber_bvarray_add( &c->rvalue_vals, &bv );
3781                         }
3782                         if ( !c->rvalue_vals )
3783                                 rc = 1;
3784                         break;
3785                 case PC_TEMP:
3786                         for (temp=qm->templates; temp; temp=temp->qmnext) {
3787                                 /* HEADS-UP: always print all;
3788                                  * if optional == 0, ignore */
3789                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3790                                         " %d %ld %ld %ld %ld",
3791                                         temp->attr_set_index,
3792                                         temp->ttl,
3793                                         temp->negttl,
3794                                         temp->limitttl,
3795                                         temp->ttr );
3796                                 bv.bv_len += temp->querystr.bv_len + 2;
3797                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
3798                                 ptr = bv.bv_val;
3799                                 *ptr++ = '"';
3800                                 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3801                                 *ptr++ = '"';
3802                                 strcpy( ptr, c->cr_msg );
3803                                 ber_bvarray_add( &c->rvalue_vals, &bv );
3804                         }
3805                         if ( !c->rvalue_vals )
3806                                 rc = 1;
3807                         break;
3808                 case PC_BIND:
3809                         for (temp=qm->templates; temp; temp=temp->qmnext) {
3810                                 if ( !temp->bindttr ) continue;
3811                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3812                                         " %d %ld %s ",
3813                                         temp->attr_set_index,
3814                                         temp->bindttr,
3815                                         ldap_pvt_scope2str( temp->bindscope ));
3816                                 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3817                                 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3818                                 ptr = bv.bv_val;
3819                                 *ptr++ = '"';
3820                                 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3821                                 *ptr++ = '"';
3822                                 ptr = lutil_strcopy( ptr, c->cr_msg );
3823                                 *ptr++ = '"';
3824                                 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3825                                 *ptr++ = '"';
3826                                 *ptr = '\0';
3827                                 ber_bvarray_add( &c->rvalue_vals, &bv );
3828                         }
3829                         if ( !c->rvalue_vals )
3830                                 rc = 1;
3831                         break;
3832                 case PC_RESP:
3833                         if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3834                                 BER_BVSTR( &bv, "head" );
3835                         } else {
3836                                 BER_BVSTR( &bv, "tail" );
3837                         }
3838                         value_add_one( &c->rvalue_vals, &bv );
3839                         break;
3840                 case PC_QUERIES:
3841                         c->value_int = cm->max_queries;
3842                         break;
3843                 case PC_OFFLINE:
3844                         c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3845                         break;
3846                 }
3847                 return rc;
3848         } else if ( c->op == LDAP_MOD_DELETE ) {
3849                 rc = 1;
3850                 switch( c->type ) {
3851                 case PC_ATTR: /* FIXME */
3852                 case PC_TEMP:
3853                 case PC_BIND:
3854                         break;
3855                 case PC_OFFLINE:
3856                         cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3857                         /* If there were cached queries when we went offline,
3858                          * restart the checker now.
3859                          */
3860                         if ( cm->num_cached_queries ) {
3861                                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3862                                 cm->cc_paused = 0;
3863                                 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3864                                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3865                         }
3866                         rc = 0;
3867                         break;
3868                 }
3869                 return rc;
3870         }
3871
3872         switch( c->type ) {
3873         case PC_MAIN:
3874                 if ( cm->numattrsets > 0 ) {
3875                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3876                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3877                         return( 1 );
3878                 }
3879
3880                 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3881                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3882                                 c->argv[3] );
3883                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3884                         return( 1 );
3885                 }
3886                 if ( cm->numattrsets <= 0 ) {
3887                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3888                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3889                         return( 1 );
3890                 }
3891                 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3892                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3893                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3894                         return( 1 );
3895                 }
3896
3897                 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3898                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3899                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3900                         return( 1 );
3901                 }
3902
3903                 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3904                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3905                                 c->argv[2] );
3906                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3907                         return( 1 );
3908                 }
3909                 if ( cm->max_entries <= 0 ) {
3910                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3911                         Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3912                         return( 1 );
3913                 }
3914
3915                 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3916                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3917                                 c->argv[4] );
3918                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3919                         return( 1 );
3920                 }
3921                 if ( cm->num_entries_limit <= 0 ) {
3922                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3923                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3924                         return( 1 );
3925                 }
3926                 if ( cm->num_entries_limit > cm->max_entries ) {
3927                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3928                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3929                         return( 1 );
3930                 }
3931
3932                 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3933                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3934                                 c->argv[5] );
3935                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3936                         return( 1 );
3937                 }
3938
3939                 cm->cc_period = (time_t)t;
3940                 Debug( pcache_debug,
3941                                 "Total # of attribute sets to be cached = %d.\n",
3942                                 cm->numattrsets, 0, 0 );
3943                 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3944                                                 sizeof( struct attr_set ) );
3945                 break;
3946         case PC_ATTR:
3947                 if ( cm->numattrsets == 0 ) {
3948                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3949                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3950                         return( 1 );
3951                 }
3952                 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3953                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3954                                 c->argv[1] );
3955                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3956                         return( 1 );
3957                 }
3958
3959                 if ( num < 0 || num >= cm->numattrsets ) {
3960                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3961                                 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3962                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3963                         return 1;
3964                 }
3965                 qm->attr_sets[num].flags |= PC_CONFIGURED;
3966                 if ( c->argc == 2 ) {
3967                         /* assume "1.1" */
3968                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
3969                                 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3970                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3971                         return 1;
3972
3973                 } else if ( c->argc == 3 ) {
3974                         if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3975                                 qm->attr_sets[num].count = 1;
3976                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3977                                         sizeof( AttributeName ) );
3978                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3979                                 break;
3980
3981                         } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3982                                 qm->attr_sets[num].count = 1;
3983                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3984                                         sizeof( AttributeName ) );
3985                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3986                                 break;
3987
3988                         } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3989                                 break;
3990                         }
3991                         /* else: fallthru */
3992
3993                 } else if ( c->argc == 4 ) {
3994                         if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
3995                                 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
3996                         {
3997                                 qm->attr_sets[num].count = 2;
3998                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
3999                                         sizeof( AttributeName ) );
4000                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4001                                 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4002                                 break;
4003                         }
4004                         /* else: fallthru */
4005                 }
4006
4007                 if ( c->argc > 2 ) {
4008                         int all_user = 0, all_op = 0;
4009
4010                         qm->attr_sets[num].count = c->argc - 2;
4011                         qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
4012                                 sizeof( AttributeName ) );
4013                         attr_name = qm->attr_sets[num].attrs;
4014                         for ( i = 2; i < c->argc; i++ ) {
4015                                 attr_name->an_desc = NULL;
4016                                 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4017                                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4018                                                 "invalid attr #%d \"%s\" in attrlist",
4019                                                 i - 2, c->argv[i] );
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                                 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4027                                         all_user = 1;
4028                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4029                                 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4030                                         all_op = 1;
4031                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4032                                 } else {
4033                                         if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4034                                                 strcpy( c->cr_msg, text );
4035                                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4036                                                 ch_free( qm->attr_sets[num].attrs );
4037                                                 qm->attr_sets[num].attrs = NULL;
4038                                                 qm->attr_sets[num].count = 0;
4039                                                 return 1;
4040                                         }
4041                                         attr_name->an_name = attr_name->an_desc->ad_cname;
4042                                 }
4043                                 attr_name->an_oc = NULL;
4044                                 attr_name->an_flags = 0;
4045                                 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4046                                         qm->attr_sets[num].flags |= PC_GOT_OC;
4047                                 attr_name++;
4048                                 BER_BVZERO( &attr_name->an_name );
4049                         }
4050
4051                         /* warn if list contains both "*" and "+" */
4052                         if ( i > 4 && all_user && all_op ) {
4053                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4054                                         "warning: attribute list contains \"*\" and \"+\"" );
4055                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4056                         }
4057                 }
4058                 break;
4059         case PC_TEMP:
4060                 if ( cm->numattrsets == 0 ) {
4061                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4062                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4063                         return( 1 );
4064                 }
4065                 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4066                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4067                                 c->argv[2] );
4068                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4069                         return( 1 );
4070                 }
4071
4072                 if ( i < 0 || i >= cm->numattrsets ||
4073                         !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4074                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4075                                 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4076                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4077                         return 1;
4078                 }
4079                 {
4080                         AttributeName *attrs;
4081                         int cnt;
4082                         cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4083                         if ( cnt < 0 ) {
4084                                 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4085                                         text );
4086                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4087                                 return 1;
4088                         }
4089                         temp = ch_calloc( 1, sizeof( QueryTemplate ));
4090                         temp->qmnext = qm->templates;
4091                         qm->templates = temp;
4092                         temp->t_attrs.attrs = attrs;
4093                         temp->t_attrs.count = cnt;
4094                 }
4095                 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4096                 temp->query = temp->query_last = NULL;
4097                 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4098                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4099                                 "unable to parse template ttl=\"%s\"",
4100                                 c->argv[3] );
4101                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4102 pc_temp_fail:
4103                         ch_free( temp->t_attrs.attrs );
4104                         ch_free( temp );
4105                         return( 1 );
4106                 }
4107                 temp->ttl = (time_t)t;
4108                 temp->negttl = (time_t)0;
4109                 temp->limitttl = (time_t)0;
4110                 temp->ttr = (time_t)0;
4111                 switch ( c->argc ) {
4112                 case 7:
4113                         if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4114                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4115                                         "unable to parse template ttr=\"%s\"",
4116                                         c->argv[6] );
4117                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4118                                 goto pc_temp_fail;
4119                         }
4120                         temp->ttr = (time_t)t;
4121                         /* fallthru */
4122
4123                 case 6:
4124                         if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4125                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4126                                         "unable to parse template sizelimit ttl=\"%s\"",
4127                                         c->argv[5] );
4128                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4129                                 goto pc_temp_fail;
4130                         }
4131                         temp->limitttl = (time_t)t;
4132                         /* fallthru */
4133
4134                 case 5:
4135                         if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4136                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4137                                         "unable to parse template negative ttl=\"%s\"",
4138                                         c->argv[4] );
4139                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4140                                 goto pc_temp_fail;
4141                         }
4142                         temp->negttl = (time_t)t;
4143                         break;
4144                 }
4145
4146                 temp->no_of_queries = 0;
4147
4148                 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4149                 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4150                 Debug( pcache_debug, "  query template: %s\n",
4151                                 temp->querystr.bv_val, 0, 0 );
4152                 temp->attr_set_index = i;
4153                 qm->attr_sets[i].flags |= PC_REFERENCED;
4154                 temp->qtnext = qm->attr_sets[i].templates;
4155                 qm->attr_sets[i].templates = temp;
4156                 Debug( pcache_debug, "  attributes: \n", 0, 0, 0 );
4157                 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4158                         for ( i=0; attrarray[i].an_name.bv_val; i++ )
4159                                 Debug( pcache_debug, "\t%s\n",
4160                                         attrarray[i].an_name.bv_val, 0, 0 );
4161                 }
4162                 break;
4163         case PC_BIND:
4164                 if ( !qm->templates ) {
4165                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4166                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4167                         return( 1 );
4168                 }
4169                 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4170                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4171                                 c->argv[2] );
4172                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4173                         return( 1 );
4174                 }
4175
4176                 if ( i < 0 || i >= cm->numattrsets ||
4177                         !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4178                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4179                                 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4180                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4181                         return 1;
4182                 }
4183                 {       struct berval bv, tempbv;
4184                         AttributeDescription **descs;
4185                         int ndescs;
4186                         ber_str2bv( c->argv[1], 0, 0, &bv );
4187                         ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4188                         if ( ndescs < 0 ) {
4189                                 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4190                                         text );
4191                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4192                                 return 1;
4193                         }
4194                         for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4195                                 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4196                                         &temp->querystr ))
4197                                         break;
4198                         }
4199                         ch_free( tempbv.bv_val );
4200                         if ( !temp ) {
4201                                 ch_free( descs );
4202                                 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4203                                         c->argv[1], i );
4204                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4205                                 return 1;
4206                         }
4207                         ber_dupbv( &temp->bindftemp, &bv );
4208                         temp->bindfattrs = descs;
4209                         temp->bindnattrs = ndescs;
4210                 }
4211                 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4212                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4213                                 "unable to parse bind ttr=\"%s\"",
4214                                 c->argv[3] );
4215                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4216 pc_bind_fail:
4217                         ch_free( temp->bindfattrs );
4218                         temp->bindfattrs = NULL;
4219                         ch_free( temp->bindftemp.bv_val );
4220                         BER_BVZERO( &temp->bindftemp );
4221                         return( 1 );
4222                 }
4223                 num = ldap_pvt_str2scope( c->argv[4] );
4224                 if ( num < 0 ) {
4225                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4226                                 "unable to parse bind scope=\"%s\"",
4227                                 c->argv[4] );
4228                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4229                         goto pc_bind_fail;
4230                 }
4231                 {
4232                         struct berval dn, ndn;
4233                         ber_str2bv( c->argv[5], 0, 0, &dn );
4234                         rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4235                         if ( rc ) {
4236                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4237                                         "invalid bind baseDN=\"%s\"",
4238                                         c->argv[5] );
4239                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4240                                 goto pc_bind_fail;
4241                         }
4242                         if ( temp->bindbase.bv_val )
4243                                 ch_free( temp->bindbase.bv_val );
4244                         temp->bindbase = ndn;
4245                 }
4246                 {
4247                         /* convert the template into dummy filter */
4248                         struct berval bv;
4249                         char *eq = temp->bindftemp.bv_val, *e2;
4250                         Filter *f;
4251                         i = 0;
4252                         while ((eq = strchr(eq, '=' ))) {
4253                                 eq++;
4254                                 if ( eq[1] == ')' )
4255                                         i++;
4256                         }
4257                         bv.bv_len = temp->bindftemp.bv_len + i;
4258                         bv.bv_val = ch_malloc( bv.bv_len + 1 );
4259                         for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4260                                 *eq; eq++ ) {
4261                                 if ( *eq == '=' ) {
4262                                         *e2++ = '=';
4263                                         if ( eq[1] == ')' )
4264                                                 *e2++ = '*';
4265                                 } else {
4266                                         *e2++ = *eq;
4267                                 }
4268                         }
4269                         *e2 = '\0';
4270                         f = str2filter( bv.bv_val );
4271                         if ( !f ) {
4272                                 ch_free( bv.bv_val );
4273                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4274                                         "unable to parse bindfilter=\"%s\"", bv.bv_val );
4275                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4276                                 ch_free( temp->bindbase.bv_val );
4277                                 BER_BVZERO( &temp->bindbase );
4278                                 goto pc_bind_fail;
4279                         }
4280                         if ( temp->bindfilter )
4281                                 filter_free( temp->bindfilter );
4282                         if ( temp->bindfilterstr.bv_val )
4283                                 ch_free( temp->bindfilterstr.bv_val );
4284                         temp->bindfilterstr = bv;
4285                         temp->bindfilter = f;
4286                 }
4287                 temp->bindttr = (time_t)t;
4288                 temp->bindscope = num;
4289                 cm->cache_binds = 1;
4290                 break;
4291
4292         case PC_RESP:
4293                 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4294                         cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4295
4296                 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4297                         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4298
4299                 } else {
4300                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4301                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4302                         return 1;
4303                 }
4304                 break;
4305         case PC_QUERIES:
4306                 if ( c->value_int <= 0 ) {
4307                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4308                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4309                         return( 1 );
4310                 }
4311                 cm->max_queries = c->value_int;
4312                 break;
4313         case PC_OFFLINE:
4314                 if ( c->value_int )
4315                         cm->cc_paused |= PCACHE_CC_OFFLINE;
4316                 else
4317                         cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4318                 break;
4319         case PC_PRIVATE_DB:
4320                 if ( cm->db.be_private == NULL ) {
4321                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4322                                 "private database must be defined before setting database specific options" );
4323                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4324                         return( 1 );
4325                 }
4326
4327                 if ( cm->db.bd_info->bi_cf_ocs ) {
4328                         ConfigTable     *ct;
4329                         ConfigArgs      c2 = *c;
4330                         char            *argv0 = c->argv[ 0 ];
4331
4332                         c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4333
4334                         ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4335                         if ( ct == NULL ) {
4336                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4337                                         "private database does not recognize specific option '%s'",
4338                                         c->argv[ 0 ] );
4339                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4340                                 rc = 1;
4341
4342                         } else {
4343                                 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4344                                 c->be = &cm->db;
4345                                 c->bi = c->be->bd_info;
4346
4347                                 rc = config_add_vals( ct, c );
4348
4349                                 c->bi = c2.bi;
4350                                 c->be = c2.be;
4351                                 c->table = c2.table;
4352                         }
4353
4354                         c->argv[ 0 ] = argv0;
4355
4356                 } else if ( cm->db.be_config != NULL ) {
4357                         char    *argv0 = c->argv[ 0 ];
4358
4359                         c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4360                         rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4361                         c->argv[ 0 ] = argv0;
4362
4363                 } else {
4364                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
4365                                 "no means to set private database specific options" );
4366                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4367                         return 1;
4368                 }
4369                 break;
4370         default:
4371                 rc = SLAP_CONF_UNKNOWN;
4372                 break;
4373         }
4374
4375         return rc;
4376 }
4377
4378 static int
4379 pcache_db_config(
4380         BackendDB       *be,
4381         const char      *fname,
4382         int             lineno,
4383         int             argc,
4384         char            **argv
4385 )
4386 {
4387         slap_overinst   *on = (slap_overinst *)be->bd_info;
4388         cache_manager*  cm = on->on_bi.bi_private;
4389
4390         /* Something for the cache database? */
4391         if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4392                 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4393                         argc, argv );
4394         return SLAP_CONF_UNKNOWN;
4395 }
4396
4397 static int
4398 pcache_db_init(
4399         BackendDB *be,
4400         ConfigReply *cr)
4401 {
4402         slap_overinst *on = (slap_overinst *)be->bd_info;
4403         cache_manager *cm;
4404         query_manager *qm;
4405
4406         cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4407         on->on_bi.bi_private = cm;
4408
4409         qm = (query_manager*)ch_malloc(sizeof(query_manager));
4410
4411         cm->db = *be;
4412         SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4413         cm->db.be_private = NULL;
4414         cm->db.bd_self = &cm->db;
4415         cm->qm = qm;
4416         cm->numattrsets = 0;
4417         cm->num_entries_limit = 5;
4418         cm->num_cached_queries = 0;
4419         cm->max_entries = 0;
4420         cm->cur_entries = 0;
4421         cm->max_queries = 10000;
4422         cm->save_queries = 0;
4423         cm->check_cacheability = 0;
4424         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4425         cm->defer_db_open = 1;
4426         cm->cache_binds = 0;
4427         cm->cc_period = 1000;
4428         cm->cc_paused = 0;
4429         cm->cc_arg = NULL;
4430 #ifdef PCACHE_MONITOR
4431         cm->monitor_cb = NULL;
4432 #endif /* PCACHE_MONITOR */
4433
4434         qm->attr_sets = NULL;
4435         qm->templates = NULL;
4436         qm->lru_top = NULL;
4437         qm->lru_bottom = NULL;
4438
4439         qm->qcfunc = query_containment;
4440         qm->crfunc = cache_replacement;
4441         qm->addfunc = add_query;
4442         ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4443
4444         ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4445
4446 #ifndef PCACHE_MONITOR
4447         return 0;
4448 #else /* PCACHE_MONITOR */
4449         return pcache_monitor_db_init( be );
4450 #endif /* PCACHE_MONITOR */
4451 }
4452
4453 static int
4454 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4455 {
4456         assert( op->o_tag == LDAP_REQ_SEARCH );
4457
4458         if ( rs->sr_type == REP_SEARCH ) {
4459                 Attribute       *a;
4460
4461                 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4462                 if ( a != NULL ) {
4463                         BerVarray       *valsp;
4464
4465                         assert( a->a_nvals != NULL );
4466
4467                         valsp = op->o_callback->sc_private;
4468                         assert( *valsp == NULL );
4469
4470                         ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4471                 }
4472         }
4473
4474         return 0;
4475 }
4476
4477 static int
4478 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4479 {
4480         assert( op->o_tag == LDAP_REQ_SEARCH );
4481
4482         if ( rs->sr_type == REP_SEARCH ) {
4483                 int     *countp = (int *)op->o_callback->sc_private;
4484
4485                 (*countp)++;
4486         }
4487
4488         return 0;
4489 }
4490
4491 static int
4492 pcache_db_open2(
4493         slap_overinst *on,
4494         ConfigReply *cr )
4495 {
4496         cache_manager   *cm = on->on_bi.bi_private;
4497         query_manager*  qm = cm->qm;
4498         int rc;
4499
4500         rc = backend_startup_one( &cm->db, cr );
4501         if ( rc == 0 ) {
4502                 cm->defer_db_open = 0;
4503         }
4504
4505         /* There is no runqueue in TOOL mode */
4506         if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4507                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4508                 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4509                         consistency_check, on,
4510                         "pcache_consistency", cm->db.be_suffix[0].bv_val );
4511                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4512
4513                 /* Cached database must have the rootdn */
4514                 if ( BER_BVISNULL( &cm->db.be_rootndn )
4515                                 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4516                 {
4517                         Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4518                                 "underlying database of type \"%s\"\n"
4519                                 "    serving naming context \"%s\"\n"
4520                                 "    has no \"rootdn\", required by \"pcache\".\n",
4521                                 on->on_info->oi_orig->bi_type,
4522                                 cm->db.be_suffix[0].bv_val, 0 );
4523                         return 1;
4524                 }
4525
4526                 if ( cm->save_queries ) {
4527                         void            *thrctx = ldap_pvt_thread_pool_context();
4528                         Connection      conn = { 0 };
4529                         OperationBuffer opbuf;
4530                         Operation       *op;
4531                         slap_callback   cb = { 0 };
4532                         SlapReply       rs = { 0 };
4533                         BerVarray       vals = NULL;
4534                         Filter          f = { 0 }, f2 = { 0 };
4535                         AttributeAssertion      ava = ATTRIBUTEASSERTION_INIT;
4536                         AttributeName   attrs[ 2 ] = {{{ 0 }}};
4537
4538                         connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4539                         op = &opbuf.ob_op;
4540
4541                         op->o_bd = &cm->db;
4542
4543                         op->o_tag = LDAP_REQ_SEARCH;
4544                         op->o_protocol = LDAP_VERSION3;
4545                         cb.sc_response = pcache_cachedquery_open_cb;
4546                         cb.sc_private = &vals;
4547                         op->o_callback = &cb;
4548                         op->o_time = slap_get_time();
4549                         op->o_do_not_cache = 1;
4550                         op->o_managedsait = SLAP_CONTROL_CRITICAL;
4551
4552                         op->o_dn = cm->db.be_rootdn;
4553                         op->o_ndn = cm->db.be_rootndn;
4554                         op->o_req_dn = cm->db.be_suffix[ 0 ];
4555                         op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4556
4557                         op->ors_scope = LDAP_SCOPE_BASE;
4558                         op->ors_deref = LDAP_DEREF_NEVER;
4559                         op->ors_slimit = 1;
4560                         op->ors_tlimit = SLAP_NO_LIMIT;
4561                         op->ors_limit = NULL;
4562                         ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4563                         f.f_choice = LDAP_FILTER_PRESENT;
4564                         f.f_desc = ad_cachedQueryURL;
4565                         op->ors_filter = &f;
4566                         attrs[ 0 ].an_desc = ad_cachedQueryURL;
4567                         attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4568                         op->ors_attrs = attrs;
4569                         op->ors_attrsonly = 0;
4570
4571                         rc = op->o_bd->be_search( op, &rs );
4572                         if ( rc == LDAP_SUCCESS && vals != NULL ) {
4573                                 int     i;
4574
4575                                 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4576                                         if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4577                                                 cm->num_cached_queries++;
4578                                         }
4579                                 }
4580
4581                                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4582                         }
4583
4584                         /* count cached entries */
4585                         f.f_choice = LDAP_FILTER_NOT;
4586                         f.f_not = &f2;
4587                         f2.f_choice = LDAP_FILTER_EQUALITY;
4588                         f2.f_ava = &ava;
4589                         f2.f_av_desc = slap_schema.si_ad_objectClass;
4590                         BER_BVSTR( &f2.f_av_value, "glue" );
4591                         ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4592
4593                         op->ors_slimit = SLAP_NO_LIMIT;
4594                         op->ors_scope = LDAP_SCOPE_SUBTREE;
4595                         op->ors_attrs = slap_anlist_no_attrs;
4596
4597                         op->o_callback->sc_response = pcache_cachedquery_count_cb;
4598                         rs.sr_nentries = 0;
4599                         op->o_callback->sc_private = &rs.sr_nentries;
4600
4601                         rc = op->o_bd->be_search( op, &rs );
4602
4603                         cm->cur_entries = rs.sr_nentries;
4604
4605                         /* ignore errors */
4606                         rc = 0;
4607                 }
4608         }
4609         return rc;
4610 }
4611
4612 static int
4613 pcache_db_open(
4614         BackendDB *be,
4615         ConfigReply *cr )
4616 {
4617         slap_overinst   *on = (slap_overinst *)be->bd_info;
4618         cache_manager   *cm = on->on_bi.bi_private;
4619         query_manager*  qm = cm->qm;
4620         int             i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4621
4622         /* check attr sets */
4623         for ( i = 0; i < cm->numattrsets; i++) {
4624                 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4625                         if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4626                                 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4627                                 rf++;
4628
4629                         } else {
4630                                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4631                         }
4632                         ncf++;
4633
4634                 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4635                         Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4636                         nrf++;
4637                 }
4638         }
4639
4640         if ( ncf || rf || nrf ) {
4641                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4642                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4643                 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4644
4645                 if ( rf > 0 ) {
4646                         return 1;
4647                 }
4648         }
4649
4650         /* need to inherit something from the original database... */
4651         cm->db.be_def_limit = be->be_def_limit;
4652         cm->db.be_limits = be->be_limits;
4653         cm->db.be_acl = be->be_acl;
4654         cm->db.be_dfltaccess = be->be_dfltaccess;
4655
4656         if ( SLAP_DBMONITORING( be ) ) {
4657                 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4658
4659         } else {
4660                 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4661         }
4662
4663         if ( !cm->defer_db_open ) {
4664                 rc = pcache_db_open2( on, cr );
4665         }
4666
4667 #ifdef PCACHE_MONITOR
4668         if ( rc == LDAP_SUCCESS ) {
4669                 rc = pcache_monitor_db_open( be );
4670         }
4671 #endif /* PCACHE_MONITOR */
4672
4673         return rc;
4674 }
4675
4676 static void
4677 pcache_free_qbase( void *v )
4678 {
4679         Qbase *qb = v;
4680         int i;
4681
4682         for (i=0; i<3; i++)
4683                 tavl_free( qb->scopes[i], NULL );
4684         ch_free( qb );
4685 }
4686
4687 static int
4688 pcache_db_close(
4689         BackendDB *be,
4690         ConfigReply *cr
4691 )
4692 {
4693         slap_overinst *on = (slap_overinst *)be->bd_info;
4694         cache_manager *cm = on->on_bi.bi_private;
4695         query_manager *qm = cm->qm;
4696         QueryTemplate *tm;
4697         int i, rc = 0;
4698
4699         /* stop the thread ... */
4700         if ( cm->cc_arg ) {
4701                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4702                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4703                         ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4704                 }
4705                 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4706                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4707         }
4708
4709         if ( cm->save_queries ) {
4710                 CachedQuery     *qc;
4711                 BerVarray       vals = NULL;
4712
4713                 void            *thrctx;
4714                 Connection      conn = { 0 };
4715                 OperationBuffer opbuf;
4716                 Operation       *op;
4717                 slap_callback   cb = { 0 };
4718
4719                 SlapReply       rs = { REP_RESULT };
4720                 Modifications   mod = {{ 0 }};
4721
4722                 thrctx = ldap_pvt_thread_pool_context();
4723
4724                 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4725                 op = &opbuf.ob_op;
4726
4727                 if ( qm->templates != NULL ) {
4728                         for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4729                                 for ( qc = tm->query; qc; qc = qc->next ) {
4730                                         struct berval   bv;
4731
4732                                         if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4733                                                 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4734                                         }
4735                                 }
4736                         }
4737                 }
4738
4739                 op->o_bd = &cm->db;
4740                 op->o_dn = cm->db.be_rootdn;
4741                 op->o_ndn = cm->db.be_rootndn;
4742
4743                 op->o_tag = LDAP_REQ_MODIFY;
4744                 op->o_protocol = LDAP_VERSION3;
4745                 cb.sc_response = slap_null_cb;
4746                 op->o_callback = &cb;
4747                 op->o_time = slap_get_time();
4748                 op->o_do_not_cache = 1;
4749                 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4750
4751                 op->o_req_dn = op->o_bd->be_suffix[0];
4752                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4753
4754                 mod.sml_op = LDAP_MOD_REPLACE;
4755                 mod.sml_flags = 0;
4756                 mod.sml_desc = ad_cachedQueryURL;
4757                 mod.sml_type = ad_cachedQueryURL->ad_cname;
4758                 mod.sml_values = vals;
4759                 mod.sml_nvalues = NULL;
4760                 mod.sml_numvals = 1;
4761                 mod.sml_next = NULL;
4762                 Debug( pcache_debug,
4763                         "%sSETTING CACHED QUERY URLS\n",
4764                         vals == NULL ? "RE" : "", 0, 0 );
4765
4766                 op->orm_modlist = &mod;
4767
4768                 op->o_bd->be_modify( op, &rs );
4769
4770                 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4771         }
4772
4773         /* cleanup stuff inherited from the original database... */
4774         cm->db.be_limits = NULL;
4775         cm->db.be_acl = NULL;
4776
4777
4778         if ( cm->db.bd_info->bi_db_close ) {
4779                 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4780         }
4781         while ( (tm = qm->templates) != NULL ) {
4782                 CachedQuery *qc, *qn;
4783                 qm->templates = tm->qmnext;
4784                 for ( qc = tm->query; qc; qc = qn ) {
4785                         qn = qc->next;
4786                         free_query( qc );
4787                 }
4788                 avl_free( tm->qbase, pcache_free_qbase );
4789                 free( tm->querystr.bv_val );
4790                 free( tm->bindfattrs );
4791                 free( tm->bindftemp.bv_val );
4792                 free( tm->bindfilterstr.bv_val );
4793                 free( tm->bindbase.bv_val );
4794                 filter_free( tm->bindfilter );
4795                 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4796                 free( tm->t_attrs.attrs );
4797                 free( tm );
4798         }
4799
4800         for ( i=0; i<cm->numattrsets; i++ ) {
4801                 free( qm->attr_sets[i].attrs );
4802         }
4803         free( qm->attr_sets );
4804         qm->attr_sets = NULL;
4805
4806 #ifdef PCACHE_MONITOR
4807         if ( rc == LDAP_SUCCESS ) {
4808                 rc = pcache_monitor_db_close( be );
4809         }
4810 #endif /* PCACHE_MONITOR */
4811
4812         return rc;
4813 }
4814
4815 static int
4816 pcache_db_destroy(
4817         BackendDB *be,
4818         ConfigReply *cr
4819 )
4820 {
4821         slap_overinst *on = (slap_overinst *)be->bd_info;
4822         cache_manager *cm = on->on_bi.bi_private;
4823         query_manager *qm = cm->qm;
4824
4825         if ( cm->db.be_private != NULL ) {
4826                 backend_stopdown_one( &cm->db );
4827         }
4828
4829         ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4830         ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4831         free( qm );
4832         free( cm );
4833
4834 #ifdef PCACHE_MONITOR
4835         pcache_monitor_db_destroy( be );
4836 #endif /* PCACHE_MONITOR */
4837
4838         return 0;
4839 }
4840
4841 #ifdef PCACHE_CONTROL_PRIVDB
4842 /*
4843         Control ::= SEQUENCE {
4844              controlType             LDAPOID,
4845              criticality             BOOLEAN DEFAULT FALSE,
4846              controlValue            OCTET STRING OPTIONAL }
4847
4848         controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4849
4850  * criticality must be TRUE; controlValue must be absent.
4851  */
4852 static int
4853 parse_privdb_ctrl(
4854         Operation       *op,
4855         SlapReply       *rs,
4856         LDAPControl     *ctrl )
4857 {
4858         if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4859                 rs->sr_text = "privateDB control specified multiple times";
4860                 return LDAP_PROTOCOL_ERROR;
4861         }
4862
4863         if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4864                 rs->sr_text = "privateDB control value not absent";
4865                 return LDAP_PROTOCOL_ERROR;
4866         }
4867
4868         if ( !ctrl->ldctl_iscritical ) {
4869                 rs->sr_text = "privateDB control criticality required";
4870                 return LDAP_PROTOCOL_ERROR;
4871         }
4872
4873         op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4874
4875         return LDAP_SUCCESS;
4876 }
4877
4878 static char *extops[] = {
4879         LDAP_EXOP_MODIFY_PASSWD,
4880         NULL
4881 };
4882 #endif /* PCACHE_CONTROL_PRIVDB */
4883
4884 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4885 #ifdef PCACHE_EXOP_QUERY_DELETE
4886 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4887
4888 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4889 #define LDAP_TAG_EXOP_QUERY_DELETE_DN   ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4890 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4891
4892 /*
4893         ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4894              requestName      [0] LDAPOID,
4895              requestValue     [1] OCTET STRING OPTIONAL }
4896
4897         requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4898
4899         requestValue ::= SEQUENCE { CHOICE {
4900                   baseDN           [0] LDAPDN
4901                   entryDN          [1] LDAPDN },
4902              queryID          [2] OCTET STRING (SIZE(16))
4903                   -- constrained to UUID }
4904
4905  * Either baseDN or entryDN must be present, to allow database selection.
4906  *
4907  * 1. if baseDN and queryID are present, then the query corresponding
4908  *    to queryID is deleted;
4909  * 2. if baseDN is present and queryID is absent, then all queries
4910  *    are deleted;
4911  * 3. if entryDN is present and queryID is absent, then all queries
4912  *    corresponding to the queryID values present in entryDN are deleted;
4913  * 4. if entryDN and queryID are present, then all queries
4914  *    corresponding to the queryID values present in entryDN are deleted,
4915  *    but only if the value of queryID is contained in the entry;
4916  *
4917  * Currently, only 1, 3 and 4 are implemented.  2 can be obtained by either
4918  * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4919  * or by removing the database files.
4920
4921         ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4922              COMPONENTS OF LDAPResult,
4923              responseName     [10] LDAPOID OPTIONAL,
4924              responseValue    [11] OCTET STRING OPTIONAL }
4925
4926  * responseName and responseValue must be absent.
4927  */
4928
4929 /*
4930  * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4931  *   or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4932  * - if ndn != NULL, it is set to the normalized DN in the request
4933  *   corresponding to either the baseDN or the entryDN, according
4934  *   to *tagp; memory is malloc'ed on the Operation's slab, and must
4935  *   be freed by the caller.
4936  * - if uuid != NULL, it is set to point to the normalized UUID;
4937  *   memory is malloc'ed on the Operation's slab, and must
4938  *   be freed by the caller.
4939  */
4940 static int
4941 pcache_parse_query_delete(
4942         struct berval   *in,
4943         ber_tag_t       *tagp,
4944         struct berval   *ndn,
4945         struct berval   *uuid,
4946         const char      **text,
4947         void            *ctx )
4948 {
4949         int                     rc = LDAP_SUCCESS;
4950         ber_tag_t               tag;
4951         ber_len_t               len = -1;
4952         BerElementBuffer        berbuf;
4953         BerElement              *ber = (BerElement *)&berbuf;
4954         struct berval           reqdata = BER_BVNULL;
4955
4956         *text = NULL;
4957
4958         if ( ndn ) {
4959                 BER_BVZERO( ndn );
4960         }
4961
4962         if ( uuid ) {
4963                 BER_BVZERO( uuid );
4964         }
4965
4966         if ( in == NULL || in->bv_len == 0 ) {
4967                 *text = "empty request data field in queryDelete exop";
4968                 return LDAP_PROTOCOL_ERROR;
4969         }
4970
4971         ber_dupbv_x( &reqdata, in, ctx );
4972
4973         /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4974         ber_init2( ber, &reqdata, 0 );
4975
4976         tag = ber_scanf( ber, "{" /*}*/ );
4977
4978         if ( tag == LBER_ERROR ) {
4979                 Debug( LDAP_DEBUG_TRACE,
4980                         "pcache_parse_query_delete: decoding error.\n",
4981                         0, 0, 0 );
4982                 goto decoding_error;
4983         }
4984
4985         tag = ber_peek_tag( ber, &len );
4986         if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
4987                 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
4988         {
4989                 *tagp = tag;
4990
4991                 if ( ndn != NULL ) {
4992                         struct berval   dn;
4993
4994                         tag = ber_scanf( ber, "m", &dn );
4995                         if ( tag == LBER_ERROR ) {
4996                                 Debug( LDAP_DEBUG_TRACE,
4997                                         "pcache_parse_query_delete: DN parse failed.\n",
4998                                         0, 0, 0 );
4999                                 goto decoding_error;
5000                         }
5001
5002                         rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
5003                         if ( rc != LDAP_SUCCESS ) {
5004                                 *text = "invalid DN in queryDelete exop request data";
5005                                 goto done;
5006                         }
5007
5008                 } else {
5009                         tag = ber_scanf( ber, "x" /* "m" */ );
5010                         if ( tag == LBER_DEFAULT ) {
5011                                 goto decoding_error;
5012                         }
5013                 }
5014
5015                 tag = ber_peek_tag( ber, &len );
5016         }
5017
5018         if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5019                 if ( uuid != NULL ) {
5020                         struct berval   bv;
5021                         char            uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5022
5023                         tag = ber_scanf( ber, "m", &bv );
5024                         if ( tag == LBER_ERROR ) {
5025                                 Debug( LDAP_DEBUG_TRACE,
5026                                         "pcache_parse_query_delete: UUID parse failed.\n",
5027                                         0, 0, 0 );
5028                                 goto decoding_error;
5029                         }
5030
5031                         if ( bv.bv_len != 16 ) {
5032                                 Debug( LDAP_DEBUG_TRACE,
5033                                         "pcache_parse_query_delete: invalid UUID length %lu.\n",
5034                                         (unsigned long)bv.bv_len, 0, 0 );
5035                                 goto decoding_error;
5036                         }
5037
5038                         rc = lutil_uuidstr_from_normalized(
5039                                 bv.bv_val, bv.bv_len,
5040                                 uuidbuf, sizeof( uuidbuf ) );
5041                         if ( rc == -1 ) {
5042                                 goto decoding_error;
5043                         }
5044                         ber_str2bv( uuidbuf, rc, 1, uuid );
5045                         rc = LDAP_SUCCESS;
5046
5047                 } else {
5048                         tag = ber_skip_tag( ber, &len );
5049                         if ( tag == LBER_DEFAULT ) {
5050                                 goto decoding_error;
5051                         }
5052
5053                         if ( len != 16 ) {
5054                                 Debug( LDAP_DEBUG_TRACE,
5055                                         "pcache_parse_query_delete: invalid UUID length %lu.\n",
5056                                         (unsigned long)len, 0, 0 );
5057                                 goto decoding_error;
5058                         }
5059                 }
5060
5061                 tag = ber_peek_tag( ber, &len );
5062         }
5063
5064         if ( tag != LBER_DEFAULT || len != 0 ) {
5065 decoding_error:;
5066                 Debug( LDAP_DEBUG_TRACE,
5067                         "pcache_parse_query_delete: decoding error\n",
5068                         0, 0, 0 );
5069                 rc = LDAP_PROTOCOL_ERROR;
5070                 *text = "queryDelete data decoding error";
5071
5072 done:;
5073                 if ( ndn && !BER_BVISNULL( ndn ) ) {
5074                         slap_sl_free( ndn->bv_val, ctx );
5075                         BER_BVZERO( ndn );
5076                 }
5077
5078                 if ( uuid && !BER_BVISNULL( uuid ) ) {
5079                         slap_sl_free( uuid->bv_val, ctx );
5080                         BER_BVZERO( uuid );
5081                 }
5082         }
5083
5084         if ( !BER_BVISNULL( &reqdata ) ) {
5085                 ber_memfree_x( reqdata.bv_val, ctx );
5086         }
5087
5088         return rc;
5089 }
5090
5091 static int
5092 pcache_exop_query_delete(
5093         Operation       *op,
5094         SlapReply       *rs )
5095 {
5096         BackendDB       *bd = op->o_bd;
5097
5098         struct berval   uuid = BER_BVNULL,
5099                         *uuidp = NULL;
5100         char            buf[ SLAP_TEXT_BUFLEN ];
5101         unsigned        len;
5102         ber_tag_t       tag = LBER_DEFAULT;
5103
5104         if ( LogTest( LDAP_DEBUG_STATS ) ) {
5105                 uuidp = &uuid;
5106         }
5107
5108         rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5109                 &tag, &op->o_req_ndn, uuidp,
5110                 &rs->sr_text, op->o_tmpmemctx );
5111         if ( rs->sr_err != LDAP_SUCCESS ) {
5112                 return rs->sr_err;
5113         }
5114
5115         if ( LogTest( LDAP_DEBUG_STATS ) ) {
5116                 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5117                 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5118
5119                 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5120                         snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5121                 }
5122
5123                 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5124                         op->o_log_prefix, buf, 0 );
5125         }
5126         op->o_req_dn = op->o_req_ndn;
5127
5128         op->o_bd = select_backend( &op->o_req_ndn, 0 );
5129         if ( op->o_bd == NULL ) {
5130                 send_ldap_error( op, rs, LDAP_NO_SUCH_OBJECT,
5131                         "no global superior knowledge" );
5132         }
5133         rs->sr_err = backend_check_restrictions( op, rs,
5134                 (struct berval *)&pcache_exop_QUERY_DELETE );
5135         if ( rs->sr_err != LDAP_SUCCESS ) {
5136                 goto done;
5137         }
5138
5139         if ( op->o_bd->be_extended == NULL ) {
5140                 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5141                         "backend does not support extended operations" );
5142                 goto done;
5143         }
5144
5145         op->o_bd->be_extended( op, rs );
5146
5147 done:;
5148         if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5149                 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5150                 BER_BVZERO( &op->o_req_ndn );
5151                 BER_BVZERO( &op->o_req_dn );
5152         }
5153
5154         if ( !BER_BVISNULL( &uuid ) ) {
5155                 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5156         }
5157
5158         op->o_bd = bd;
5159
5160         return rs->sr_err;
5161 }
5162 #endif /* PCACHE_EXOP_QUERY_DELETE */
5163
5164 static int
5165 pcache_op_extended( Operation *op, SlapReply *rs )
5166 {
5167         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
5168         cache_manager   *cm = on->on_bi.bi_private;
5169
5170 #ifdef PCACHE_CONTROL_PRIVDB
5171         if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5172                 return pcache_op_privdb( op, rs );
5173         }
5174 #endif /* PCACHE_CONTROL_PRIVDB */
5175
5176 #ifdef PCACHE_EXOP_QUERY_DELETE
5177         if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5178                 struct berval   uuid = BER_BVNULL;
5179                 ber_tag_t       tag = LBER_DEFAULT;
5180
5181                 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5182                         &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5183                 assert( rs->sr_err == LDAP_SUCCESS );
5184
5185                 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5186                         /* remove all queries related to the selected entry */
5187                         rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5188                                 cm, &op->o_req_ndn, &uuid );
5189
5190                 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5191                         if ( !BER_BVISNULL( &uuid ) ) {
5192                                 /* remove the selected query */
5193                                 rs->sr_err = pcache_remove_query_from_cache( op,
5194                                         cm, &uuid );
5195
5196                         } else {
5197                                 /* TODO: remove all queries */
5198                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5199                                 rs->sr_text = "deletion of all queries not implemented";
5200                         }
5201                 }
5202
5203                 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5204                 return rs->sr_err;
5205         }
5206 #endif /* PCACHE_EXOP_QUERY_DELETE */
5207
5208         /* We only care if we're configured for Bind caching */
5209         if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5210                 cm->cache_binds ) {
5211                 /* See if the local entry exists and has a password.
5212                  * It's too much work to find the matching query, so
5213                  * we just see if there's a hashed password to update.
5214                  */
5215                 Operation op2 = *op;
5216                 Entry *e = NULL;
5217                 int rc;
5218                 int doit = 0;
5219
5220                 op2.o_bd = &cm->db;
5221                 op2.o_dn = op->o_bd->be_rootdn;
5222                 op2.o_ndn = op->o_bd->be_rootndn;
5223                 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5224                         slap_schema.si_ad_userPassword, 0, &e );
5225                 if ( rc == LDAP_SUCCESS && e ) {
5226                         /* See if a recognized password is hashed here */
5227                         Attribute *a = attr_find( e->e_attrs,
5228                                 slap_schema.si_ad_userPassword );
5229                         if ( a && a->a_vals[0].bv_val[0] == '{' &&
5230                                 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5231                                 doit = 1;
5232                         }
5233                         be_entry_release_r( &op2, e );
5234                 }
5235
5236                 if ( doit ) {
5237                         rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5238                                 on->on_next );
5239                         if ( rc == LDAP_SUCCESS ) {
5240                                 req_pwdexop_s *qpw = &op->oq_pwdexop;
5241
5242                                 /* We don't care if it succeeds or not */
5243                                 pc_setpw( &op2, &qpw->rs_new, cm );
5244                         }
5245                         return rc;
5246                 }
5247         }
5248         return SLAP_CB_CONTINUE;
5249 }
5250
5251 static int
5252 pcache_entry_release( Operation  *op, Entry *e, int rw )
5253 {
5254         slap_overinst   *on = (slap_overinst *)op->o_bd->bd_info;
5255         cache_manager   *cm = on->on_bi.bi_private;
5256         BackendDB *db = op->o_bd;
5257         int rc;
5258
5259         op->o_bd = &cm->db;
5260         rc = be_entry_release_rw( op, e, rw );
5261         op->o_bd = db;
5262         return rc;
5263 }
5264
5265 #ifdef PCACHE_MONITOR
5266
5267 static int
5268 pcache_monitor_update(
5269         Operation       *op,
5270         SlapReply       *rs,
5271         Entry           *e,
5272         void            *priv )
5273 {
5274         cache_manager   *cm = (cache_manager *) priv;
5275         query_manager   *qm = cm->qm;
5276
5277         CachedQuery     *qc;
5278         BerVarray       vals = NULL;
5279
5280         attr_delete( &e->e_attrs, ad_cachedQueryURL );
5281         if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5282                 && qm->templates != NULL )
5283         {
5284                 QueryTemplate *tm;
5285
5286                 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5287                         for ( qc = tm->query; qc; qc = qc->next ) {
5288                                 struct berval   bv;
5289
5290                                 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5291                                         ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5292                                 }
5293                         }
5294                 }
5295
5296
5297                 if ( vals != NULL ) {
5298                         attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5299                         ber_bvarray_free_x( vals, op->o_tmpmemctx );
5300                 }
5301         }
5302
5303         {
5304                 Attribute       *a;
5305                 char            buf[ SLAP_TEXT_BUFLEN ];
5306                 struct berval   bv;
5307
5308                 /* number of cached queries */
5309                 a = attr_find( e->e_attrs, ad_numQueries );
5310                 assert( a != NULL );
5311
5312                 bv.bv_val = buf;
5313                 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5314
5315                 if ( a->a_nvals != a->a_vals ) {
5316                         ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5317                 }
5318                 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5319
5320                 /* number of cached entries */
5321                 a = attr_find( e->e_attrs, ad_numEntries );
5322                 assert( a != NULL );
5323
5324                 bv.bv_val = buf;
5325                 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5326
5327                 if ( a->a_nvals != a->a_vals ) {
5328                         ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5329                 }
5330                 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5331         }
5332
5333         return SLAP_CB_CONTINUE;
5334 }
5335
5336 static int
5337 pcache_monitor_free(
5338         Entry           *e,
5339         void            **priv )
5340 {
5341         struct berval   values[ 2 ];
5342         Modification    mod = { 0 };
5343
5344         const char      *text;
5345         char            textbuf[ SLAP_TEXT_BUFLEN ];
5346
5347         int             rc;
5348
5349         /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5350         *priv = NULL;
5351
5352         /* Remove objectClass */
5353         mod.sm_op = LDAP_MOD_DELETE;
5354         mod.sm_desc = slap_schema.si_ad_objectClass;
5355         mod.sm_values = values;
5356         mod.sm_numvals = 1;
5357         values[ 0 ] = oc_olmPCache->soc_cname;
5358         BER_BVZERO( &values[ 1 ] );
5359
5360         rc = modify_delete_values( e, &mod, 1, &text,
5361                 textbuf, sizeof( textbuf ) );
5362         /* don't care too much about return code... */
5363
5364         /* remove attrs */
5365         mod.sm_values = NULL;
5366         mod.sm_desc = ad_cachedQueryURL;
5367         mod.sm_numvals = 0;
5368         rc = modify_delete_values( e, &mod, 1, &text,
5369                 textbuf, sizeof( textbuf ) );
5370         /* don't care too much about return code... */
5371
5372         /* remove attrs */
5373         mod.sm_values = NULL;
5374         mod.sm_desc = ad_numQueries;
5375         mod.sm_numvals = 0;
5376         rc = modify_delete_values( e, &mod, 1, &text,
5377                 textbuf, sizeof( textbuf ) );
5378         /* don't care too much about return code... */
5379
5380         /* remove attrs */
5381         mod.sm_values = NULL;
5382         mod.sm_desc = ad_numEntries;
5383         mod.sm_numvals = 0;
5384         rc = modify_delete_values( e, &mod, 1, &text,
5385                 textbuf, sizeof( textbuf ) );
5386         /* don't care too much about return code... */
5387
5388         return SLAP_CB_CONTINUE;
5389 }
5390
5391 /*
5392  * call from within pcache_initialize()
5393  */
5394 static int
5395 pcache_monitor_initialize( void )
5396 {
5397         static int      pcache_monitor_initialized = 0;
5398
5399         if ( backend_info( "monitor" ) == NULL ) {
5400                 return -1;
5401         }
5402
5403         if ( pcache_monitor_initialized++ ) {
5404                 return 0;
5405         }
5406
5407         return 0;
5408 }
5409
5410 static int
5411 pcache_monitor_db_init( BackendDB *be )
5412 {
5413         if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5414                 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5415         }
5416
5417         return 0;
5418 }
5419
5420 static int
5421 pcache_monitor_db_open( BackendDB *be )
5422 {
5423         slap_overinst           *on = (slap_overinst *)be->bd_info;
5424         cache_manager           *cm = on->on_bi.bi_private;
5425         Attribute               *a, *next;
5426         monitor_callback_t      *cb = NULL;
5427         int                     rc = 0;
5428         BackendInfo             *mi;
5429         monitor_extra_t         *mbe;
5430         struct berval           dummy = BER_BVC( "" );
5431
5432         if ( !SLAP_DBMONITORING( be ) ) {
5433                 return 0;
5434         }
5435
5436         mi = backend_info( "monitor" );
5437         if ( !mi || !mi->bi_extra ) {
5438                 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5439                 return 0;
5440         }
5441         mbe = mi->bi_extra;
5442
5443         /* don't bother if monitor is not configured */
5444         if ( !mbe->is_configured() ) {
5445                 static int warning = 0;
5446
5447                 if ( warning++ == 0 ) {
5448                         Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5449                                 "monitoring disabled; "
5450                                 "configure monitor database to enable\n",
5451                                 0, 0, 0 );
5452                 }
5453
5454                 return 0;
5455         }
5456
5457         /* alloc as many as required (plus 1 for objectClass) */
5458         a = attrs_alloc( 1 + 2 );
5459         if ( a == NULL ) {
5460                 rc = 1;
5461                 goto cleanup;
5462         }
5463
5464         a->a_desc = slap_schema.si_ad_objectClass;
5465         attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5466         next = a->a_next;
5467
5468         {
5469                 struct berval   bv = BER_BVC( "0" );
5470
5471                 next->a_desc = ad_numQueries;
5472                 attr_valadd( next, &bv, NULL, 1 );
5473                 next = next->a_next;
5474
5475                 next->a_desc = ad_numEntries;
5476                 attr_valadd( next, &bv, NULL, 1 );
5477                 next = next->a_next;
5478         }
5479
5480         cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5481         cb->mc_update = pcache_monitor_update;
5482         cb->mc_free = pcache_monitor_free;
5483         cb->mc_private = (void *)cm;
5484
5485         /* make sure the database is registered; then add monitor attributes */
5486         BER_BVZERO( &cm->monitor_ndn );
5487         rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5488         if ( rc == 0 ) {
5489                 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5490                         &dummy, -1, &dummy);
5491         }
5492
5493 cleanup:;
5494         if ( rc != 0 ) {
5495                 if ( cb != NULL ) {
5496                         ch_free( cb );
5497                         cb = NULL;
5498                 }
5499
5500                 if ( a != NULL ) {
5501                         attrs_free( a );
5502                         a = NULL;
5503                 }
5504         }
5505
5506         /* store for cleanup */
5507         cm->monitor_cb = (void *)cb;
5508
5509         /* we don't need to keep track of the attributes, because
5510          * bdb_monitor_free() takes care of everything */
5511         if ( a != NULL ) {
5512                 attrs_free( a );
5513         }
5514
5515         return rc;
5516 }
5517
5518 static int
5519 pcache_monitor_db_close( BackendDB *be )
5520 {
5521         slap_overinst *on = (slap_overinst *)be->bd_info;
5522         cache_manager *cm = on->on_bi.bi_private;
5523
5524         if ( cm->monitor_cb != NULL ) {
5525                 BackendInfo             *mi = backend_info( "monitor" );
5526                 monitor_extra_t         *mbe;
5527
5528                 if ( mi && &mi->bi_extra ) {
5529                         mbe = mi->bi_extra;
5530                         mbe->unregister_entry_callback( NULL,
5531                                 (monitor_callback_t *)cm->monitor_cb,
5532                                 NULL, 0, NULL );
5533                 }
5534         }
5535
5536         return 0;
5537 }
5538
5539 static int
5540 pcache_monitor_db_destroy( BackendDB *be )
5541 {
5542         return 0;
5543 }
5544
5545 #endif /* PCACHE_MONITOR */
5546
5547 static slap_overinst pcache;
5548
5549 static char *obsolete_names[] = {
5550         "proxycache",
5551         NULL
5552 };
5553
5554 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5555 static
5556 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5557 int
5558 pcache_initialize()
5559 {
5560         int i, code;
5561         struct berval debugbv = BER_BVC("pcache");
5562         ConfigArgs c;
5563         char *argv[ 4 ];
5564
5565         code = slap_loglevel_get( &debugbv, &pcache_debug );
5566         if ( code ) {
5567                 return code;
5568         }
5569
5570 #ifdef PCACHE_CONTROL_PRIVDB
5571         code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5572                 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5573                 parse_privdb_ctrl, &privDB_cid );
5574         if ( code != LDAP_SUCCESS ) {
5575                 Debug( LDAP_DEBUG_ANY,
5576                         "pcache_initialize: failed to register control %s (%d)\n",
5577                         PCACHE_CONTROL_PRIVDB, code, 0 );
5578                 return code;
5579         }
5580 #endif /* PCACHE_CONTROL_PRIVDB */
5581
5582 #ifdef PCACHE_EXOP_QUERY_DELETE
5583         code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5584                 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5585                 0 );
5586         if ( code != LDAP_SUCCESS ) {
5587                 Debug( LDAP_DEBUG_ANY,
5588                         "pcache_initialize: unable to register queryDelete exop: %d.\n",
5589                         code, 0, 0 );
5590                 return code;
5591         }
5592 #endif /* PCACHE_EXOP_QUERY_DELETE */
5593
5594         argv[ 0 ] = "back-bdb/back-hdb monitor";
5595         c.argv = argv;
5596         c.argc = 3;
5597         c.fname = argv[0];
5598
5599         for ( i = 0; s_oid[ i ].name; i++ ) {
5600                 c.lineno = i;
5601                 argv[ 1 ] = s_oid[ i ].name;
5602                 argv[ 2 ] = s_oid[ i ].oid;
5603
5604                 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5605                         Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5606                                 "unable to add objectIdentifier \"%s=%s\"\n",
5607                                 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5608                         return 1;
5609                 }
5610         }
5611
5612         for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5613                 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5614                 if ( code ) {
5615                         Debug( LDAP_DEBUG_ANY,
5616                                 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5617                         return code;
5618                 }
5619                 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5620         }
5621
5622         for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5623                 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5624                 if ( code ) {
5625                         Debug( LDAP_DEBUG_ANY,
5626                                 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5627                         return code;
5628                 }
5629                 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5630         }
5631
5632         pcache.on_bi.bi_type = "pcache";
5633         pcache.on_bi.bi_obsolete_names = obsolete_names;
5634         pcache.on_bi.bi_db_init = pcache_db_init;
5635         pcache.on_bi.bi_db_config = pcache_db_config;
5636         pcache.on_bi.bi_db_open = pcache_db_open;
5637         pcache.on_bi.bi_db_close = pcache_db_close;
5638         pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5639
5640         pcache.on_bi.bi_op_search = pcache_op_search;
5641         pcache.on_bi.bi_op_bind = pcache_op_bind;
5642 #ifdef PCACHE_CONTROL_PRIVDB
5643         pcache.on_bi.bi_op_compare = pcache_op_privdb;
5644         pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5645         pcache.on_bi.bi_op_modify = pcache_op_privdb;
5646         pcache.on_bi.bi_op_add = pcache_op_privdb;
5647         pcache.on_bi.bi_op_delete = pcache_op_privdb;
5648 #endif /* PCACHE_CONTROL_PRIVDB */
5649         pcache.on_bi.bi_extended = pcache_op_extended;
5650
5651         pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5652         pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5653
5654         pcache.on_bi.bi_cf_ocs = pcocs;
5655
5656         code = config_register_schema( pccfg, pcocs );
5657         if ( code ) return code;
5658
5659         return overlay_register( &pcache );
5660 }
5661
5662 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5663 int init_module(int argc, char *argv[]) {
5664         return pcache_initialize();
5665 }
5666 #endif
5667
5668 #endif  /* defined(SLAPD_OVER_PROXYCACHE) */