git.sur5r.net Git - openldap/blob - servers/slapd/overlays/pcache.c

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