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