git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/cache.c

   1 /* cache.c - routines to maintain an in-core cache of entries */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2009 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 #include "portable.h"
  18
  19 #include <stdio.h>
  20
  21 #include <ac/errno.h>
  22 #include <ac/string.h>
  23 #include <ac/socket.h>
  24
  25 #include "slap.h"
  26
  27 #include "back-bdb.h"
  28
  29 #include "ldap_rq.h"
  30
  31 #ifdef BDB_HIER
  32 #define bdb_cache_lru_purge     hdb_cache_lru_purge
  33 #endif
  34 static void bdb_cache_lru_purge( struct bdb_info *bdb );
  35
  36 static int      bdb_cache_delete_internal(Cache *cache, EntryInfo *e, int decr);
  37 #ifdef LDAP_DEBUG
  38 #define SLAPD_UNUSED
  39 #ifdef SLAPD_UNUSED
  40 static void     bdb_lru_print(Cache *cache);
  41 #endif
  42 #endif
  43
  44 /* For concurrency experiments only! */
  45 #if 0
  46 #define ldap_pvt_thread_rdwr_wlock(a)   0
  47 #define ldap_pvt_thread_rdwr_wunlock(a) 0
  48 #define ldap_pvt_thread_rdwr_rlock(a)   0
  49 #define ldap_pvt_thread_rdwr_runlock(a) 0
  50 #endif
  51
  52 #if 0
  53 #define ldap_pvt_thread_mutex_trylock(a) 0
  54 #endif
  55
  56 static EntryInfo *
  57 bdb_cache_entryinfo_new( Cache *cache )
  58 {
  59         EntryInfo *ei = NULL;
  60
  61         if ( cache->c_eifree ) {
  62                 ldap_pvt_thread_mutex_lock( &cache->c_eifree_mutex );
  63                 if ( cache->c_eifree ) {
  64                         ei = cache->c_eifree;
  65                         cache->c_eifree = ei->bei_lrunext;
  66                         ei->bei_finders = 0;
  67                 }
  68                 ldap_pvt_thread_mutex_unlock( &cache->c_eifree_mutex );
  69         }
  70         if ( !ei ) {
  71                 ei = ch_calloc(1, sizeof(EntryInfo));
  72                 ldap_pvt_thread_mutex_init( &ei->bei_kids_mutex );
  73         }
  74
  75         ei->bei_state = CACHE_ENTRY_REFERENCED;
  76
  77         return ei;
  78 }
  79
  80 static void
  81 bdb_cache_entryinfo_free( Cache *cache, EntryInfo *ei )
  82 {
  83         free( ei->bei_nrdn.bv_val );
  84         ei->bei_nrdn.bv_val = NULL;
  85 #ifdef BDB_HIER
  86         free( ei->bei_rdn.bv_val );
  87         ei->bei_rdn.bv_val = NULL;
  88         ei->bei_modrdns = 0;
  89         ei->bei_ckids = 0;
  90         ei->bei_dkids = 0;
  91 #endif
  92         ei->bei_parent = NULL;
  93         ei->bei_kids = NULL;
  94         ei->bei_lruprev = NULL;
  95
  96         ldap_pvt_thread_mutex_lock( &cache->c_eifree_mutex );
  97         ei->bei_lrunext = cache->c_eifree;
  98         cache->c_eifree = ei;
  99         ldap_pvt_thread_mutex_unlock( &cache->c_eifree_mutex );
 100 }
 101
 102 #define LRU_DEL( c, e ) do { \
 103         if ( e == (c)->c_lruhead ) (c)->c_lruhead = e->bei_lruprev; \
 104         if ( e == (c)->c_lrutail ) (c)->c_lrutail = e->bei_lruprev; \
 105         e->bei_lrunext->bei_lruprev = e->bei_lruprev; \
 106         e->bei_lruprev->bei_lrunext = e->bei_lrunext; \
 107         e->bei_lruprev = NULL; \
 108 } while ( 0 )
 109
 110 /* Note - we now use a Second-Chance / Clock algorithm instead of
 111  * Least-Recently-Used. This tremendously improves concurrency
 112  * because we no longer need to manipulate the lists every time an
 113  * entry is touched. We only need to lock the lists when adding
 114  * or deleting an entry. It's now a circular doubly-linked list.
 115  * We always append to the tail, but the head traverses the circle
 116  * during a purge operation.
 117  */
 118 static void
 119 bdb_cache_lru_link( struct bdb_info *bdb, EntryInfo *ei )
 120 {
 121
 122         /* Already linked, ignore */
 123         if ( ei->bei_lruprev )
 124                 return;
 125
 126         /* Insert into circular LRU list */
 127         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_lru_mutex );
 128
 129         ei->bei_lruprev = bdb->bi_cache.c_lrutail;
 130         if ( bdb->bi_cache.c_lrutail ) {
 131                 ei->bei_lrunext = bdb->bi_cache.c_lrutail->bei_lrunext;
 132                 bdb->bi_cache.c_lrutail->bei_lrunext = ei;
 133                 if ( ei->bei_lrunext )
 134                         ei->bei_lrunext->bei_lruprev = ei;
 135         } else {
 136                 ei->bei_lrunext = ei->bei_lruprev = ei;
 137                 bdb->bi_cache.c_lruhead = ei;
 138         }
 139         bdb->bi_cache.c_lrutail = ei;
 140         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
 141 }
 142
 143 #ifdef NO_THREADS
 144 #define NO_DB_LOCK
 145 #endif
 146
 147 /* #define NO_DB_LOCK 1 */
 148 /* Note: The BerkeleyDB locks are much slower than regular
 149  * mutexes or rdwr locks. But the BDB implementation has the
 150  * advantage of using a fixed size lock table, instead of
 151  * allocating a lock object per entry in the DB. That's a
 152  * key benefit for scaling. It also frees us from worrying
 153  * about undetectable deadlocks between BDB activity and our
 154  * own cache activity. It's still worth exploring faster
 155  * alternatives though.
 156  */
 157
 158 /* Atomically release and reacquire a lock */
 159 int
 160 bdb_cache_entry_db_relock(
 161         struct bdb_info *bdb,
 162         DB_TXN *txn,
 163         EntryInfo *ei,
 164         int rw,
 165         int tryOnly,
 166         DB_LOCK *lock )
 167 {
 168 #ifdef NO_DB_LOCK
 169         return 0;
 170 #else
 171         int     rc;
 172         DBT     lockobj;
 173         DB_LOCKREQ list[2];
 174
 175         if ( !lock ) return 0;
 176
 177         lockobj.data = &ei->bei_id;
 178         lockobj.size = sizeof(ei->bei_id) + 1;
 179
 180         list[0].op = DB_LOCK_PUT;
 181         list[0].lock = *lock;
 182         list[1].op = DB_LOCK_GET;
 183         list[1].lock = *lock;
 184         list[1].mode = rw ? DB_LOCK_WRITE : DB_LOCK_READ;
 185         list[1].obj = &lockobj;
 186         rc = bdb->bi_dbenv->lock_vec(bdb->bi_dbenv, TXN_ID(txn), tryOnly ? DB_LOCK_NOWAIT : 0,
 187                 list, 2, NULL );
 188
 189         if (rc && !tryOnly) {
 190                 Debug( LDAP_DEBUG_TRACE,
 191                         "bdb_cache_entry_db_relock: entry %ld, rw %d, rc %d\n",
 192                         ei->bei_id, rw, rc );
 193         } else {
 194                 *lock = list[1].lock;
 195         }
 196         return rc;
 197 #endif
 198 }
 199
 200 static int
 201 bdb_cache_entry_db_lock( struct bdb_info *bdb, DB_TXN *txn, EntryInfo *ei,
 202         int rw, int tryOnly, DB_LOCK *lock )
 203 {
 204 #ifdef NO_DB_LOCK
 205         return 0;
 206 #else
 207         int       rc;
 208         DBT       lockobj;
 209         int       db_rw;
 210
 211         if ( !lock ) return 0;
 212
 213         if (rw)
 214                 db_rw = DB_LOCK_WRITE;
 215         else
 216                 db_rw = DB_LOCK_READ;
 217
 218         lockobj.data = &ei->bei_id;
 219         lockobj.size = sizeof(ei->bei_id) + 1;
 220
 221         rc = LOCK_GET(bdb->bi_dbenv, TXN_ID(txn), tryOnly ? DB_LOCK_NOWAIT : 0,
 222                                         &lockobj, db_rw, lock);
 223         if (rc && !tryOnly) {
 224                 Debug( LDAP_DEBUG_TRACE,
 225                         "bdb_cache_entry_db_lock: entry %ld, rw %d, rc %d\n",
 226                         ei->bei_id, rw, rc );
 227         }
 228         return rc;
 229 #endif /* NO_DB_LOCK */
 230 }
 231
 232 int
 233 bdb_cache_entry_db_unlock ( struct bdb_info *bdb, DB_LOCK *lock )
 234 {
 235 #ifdef NO_DB_LOCK
 236         return 0;
 237 #else
 238         int rc;
 239
 240         if ( !lock || lock->mode == DB_LOCK_NG ) return 0;
 241
 242         rc = LOCK_PUT ( bdb->bi_dbenv, lock );
 243         return rc;
 244 #endif
 245 }
 246
 247 void
 248 bdb_cache_return_entry_rw( struct bdb_info *bdb, Entry *e,
 249         int rw, DB_LOCK *lock )
 250 {
 251         EntryInfo *ei;
 252         int free = 0;
 253
 254         ei = e->e_private;
 255         if ( ei &&
 256                 ( ei->bei_state & CACHE_ENTRY_NOT_CACHED ) &&
 257                 ( bdb_cache_entryinfo_trylock( ei ) == 0 )) {
 258                 if ( ei->bei_state & CACHE_ENTRY_NOT_CACHED ) {
 259                         /* Releasing the entry can only be done when
 260                          * we know that nobody else is using it, i.e we
 261                          * should have an entry_db writelock.  But the
 262                          * flag is only set by the thread that loads the
 263                          * entry, and only if no other threads has found
 264                          * it while it was working.  All other threads
 265                          * clear the flag, which mean that we should be
 266                          * the only thread using the entry if the flag
 267                          * is set here.
 268                          */
 269                         ei->bei_e = NULL;
 270                         ei->bei_state ^= CACHE_ENTRY_NOT_CACHED;
 271                         free = 1;
 272                 }
 273                 bdb_cache_entryinfo_unlock( ei );
 274         }
 275         bdb_cache_entry_db_unlock( bdb, lock );
 276         if ( free ) {
 277                 e->e_private = NULL;
 278                 bdb_entry_return( e );
 279         }
 280 }
 281
 282 static int
 283 bdb_cache_entryinfo_destroy( EntryInfo *e )
 284 {
 285         ldap_pvt_thread_mutex_destroy( &e->bei_kids_mutex );
 286         free( e->bei_nrdn.bv_val );
 287 #ifdef BDB_HIER
 288         free( e->bei_rdn.bv_val );
 289 #endif
 290         free( e );
 291         return 0;
 292 }
 293
 294 /* Do a length-ordered sort on normalized RDNs */
 295 static int
 296 bdb_rdn_cmp( const void *v_e1, const void *v_e2 )
 297 {
 298         const EntryInfo *e1 = v_e1, *e2 = v_e2;
 299         int rc = e1->bei_nrdn.bv_len - e2->bei_nrdn.bv_len;
 300         if (rc == 0) {
 301                 rc = strncmp( e1->bei_nrdn.bv_val, e2->bei_nrdn.bv_val,
 302                         e1->bei_nrdn.bv_len );
 303         }
 304         return rc;
 305 }
 306
 307 static int
 308 bdb_id_cmp( const void *v_e1, const void *v_e2 )
 309 {
 310         const EntryInfo *e1 = v_e1, *e2 = v_e2;
 311         return e1->bei_id - e2->bei_id;
 312 }
 313
 314 static int
 315 bdb_id_dup_err( void *v1, void *v2 )
 316 {
 317         EntryInfo *e2 = v2;
 318         e2->bei_lrunext = v1;
 319         return -1;
 320 }
 321
 322 /* Create an entryinfo in the cache. Caller must release the locks later.
 323  */
 324 static int
 325 bdb_entryinfo_add_internal(
 326         struct bdb_info *bdb,
 327         EntryInfo *ei,
 328         EntryInfo **res )
 329 {
 330         EntryInfo *ei2 = NULL;
 331
 332         *res = NULL;
 333
 334         ei2 = bdb_cache_entryinfo_new( &bdb->bi_cache );
 335
 336         ldap_pvt_thread_rdwr_wlock( &bdb->bi_cache.c_rwlock );
 337         bdb_cache_entryinfo_lock( ei->bei_parent );
 338
 339         ei2->bei_id = ei->bei_id;
 340         ei2->bei_parent = ei->bei_parent;
 341 #ifdef BDB_HIER
 342         ei2->bei_rdn = ei->bei_rdn;
 343 #endif
 344 #ifdef SLAP_ZONE_ALLOC
 345         ei2->bei_bdb = bdb;
 346 #endif
 347
 348         /* Add to cache ID tree */
 349         if (avl_insert( &bdb->bi_cache.c_idtree, ei2, bdb_id_cmp,
 350                 bdb_id_dup_err )) {
 351                 EntryInfo *eix = ei2->bei_lrunext;
 352                 bdb_cache_entryinfo_free( &bdb->bi_cache, ei2 );
 353                 ei2 = eix;
 354 #ifdef BDB_HIER
 355                 /* It got freed above because its value was
 356                  * assigned to ei2.
 357                  */
 358                 ei->bei_rdn.bv_val = NULL;
 359 #endif
 360         } else {
 361                 int rc;
 362
 363                 bdb->bi_cache.c_eiused++;
 364                 ber_dupbv( &ei2->bei_nrdn, &ei->bei_nrdn );
 365
 366                 /* This is a new leaf node. But if parent had no kids, then it was
 367                  * a leaf and we would be decrementing that. So, only increment if
 368                  * the parent already has kids.
 369                  */
 370                 if ( ei->bei_parent->bei_kids || !ei->bei_parent->bei_id )
 371                         bdb->bi_cache.c_leaves++;
 372                 rc = avl_insert( &ei->bei_parent->bei_kids, ei2, bdb_rdn_cmp,
 373                         avl_dup_error );
 374                 if ( rc ) {
 375                         /* This should never happen; entry cache is corrupt */
 376                         bdb->bi_dbenv->log_flush( bdb->bi_dbenv, NULL );
 377                         assert( !rc );
 378                 }
 379 #ifdef BDB_HIER
 380                 ei->bei_parent->bei_ckids++;
 381 #endif
 382         }
 383
 384         *res = ei2;
 385         return 0;
 386 }
 387
 388 /* Find the EntryInfo for the requested DN. If the DN cannot be found, return
 389  * the info for its closest ancestor. *res should be NULL to process a
 390  * complete DN starting from the tree root. Otherwise *res must be the
 391  * immediate parent of the requested DN, and only the RDN will be searched.
 392  * The EntryInfo is locked upon return and must be unlocked by the caller.
 393  */
 394 int
 395 bdb_cache_find_ndn(
 396         Operation       *op,
 397         DB_TXN          *txn,
 398         struct berval   *ndn,
 399         EntryInfo       **res )
 400 {
 401         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 402         EntryInfo       ei, *eip, *ei2;
 403         int rc = 0;
 404         char *ptr;
 405
 406         /* this function is always called with normalized DN */
 407         if ( *res ) {
 408                 /* we're doing a onelevel search for an RDN */
 409                 ei.bei_nrdn.bv_val = ndn->bv_val;
 410                 ei.bei_nrdn.bv_len = dn_rdnlen( op->o_bd, ndn );
 411                 eip = *res;
 412         } else {
 413                 /* we're searching a full DN from the root */
 414                 ptr = ndn->bv_val + ndn->bv_len - op->o_bd->be_nsuffix[0].bv_len;
 415                 ei.bei_nrdn.bv_val = ptr;
 416                 ei.bei_nrdn.bv_len = op->o_bd->be_nsuffix[0].bv_len;
 417                 /* Skip to next rdn if suffix is empty */
 418                 if ( ei.bei_nrdn.bv_len == 0 ) {
 419                         for (ptr = ei.bei_nrdn.bv_val - 2; ptr > ndn->bv_val
 420                                 && !DN_SEPARATOR(*ptr); ptr--) /* empty */;
 421                         if ( ptr >= ndn->bv_val ) {
 422                                 if (DN_SEPARATOR(*ptr)) ptr++;
 423                                 ei.bei_nrdn.bv_len = ei.bei_nrdn.bv_val - ptr;
 424                                 ei.bei_nrdn.bv_val = ptr;
 425                         }
 426                 }
 427                 eip = &bdb->bi_cache.c_dntree;
 428         }
 429
 430         for ( bdb_cache_entryinfo_lock( eip ); eip; ) {
 431                 eip->bei_state |= CACHE_ENTRY_REFERENCED;
 432                 ei.bei_parent = eip;
 433                 ei2 = (EntryInfo *)avl_find( eip->bei_kids, &ei, bdb_rdn_cmp );
 434                 if ( !ei2 ) {
 435                         DB_LOCK lock;
 436                         int len = ei.bei_nrdn.bv_len;
 437
 438                         if ( BER_BVISEMPTY( ndn )) {
 439                                 *res = eip;
 440                                 return LDAP_SUCCESS;
 441                         }
 442
 443                         ei.bei_nrdn.bv_len = ndn->bv_len -
 444                                 (ei.bei_nrdn.bv_val - ndn->bv_val);
 445                         bdb_cache_entryinfo_unlock( eip );
 446
 447                         BDB_LOG_PRINTF( bdb->bi_dbenv, NULL, "slapd Reading %s",
 448                                 ei.bei_nrdn.bv_val );
 449
 450                         lock.mode = DB_LOCK_NG;
 451                         rc = bdb_dn2id( op, &ei.bei_nrdn, &ei, txn, &lock );
 452                         if (rc) {
 453                                 bdb_cache_entryinfo_lock( eip );
 454                                 bdb_cache_entry_db_unlock( bdb, &lock );
 455                                 *res = eip;
 456                                 return rc;
 457                         }
 458
 459                         BDB_LOG_PRINTF( bdb->bi_dbenv, NULL, "slapd Read got %s(%d)",
 460                                 ei.bei_nrdn.bv_val, ei.bei_id );
 461
 462                         /* DN exists but needs to be added to cache */
 463                         ei.bei_nrdn.bv_len = len;
 464                         rc = bdb_entryinfo_add_internal( bdb, &ei, &ei2 );
 465                         /* add_internal left eip and c_rwlock locked */
 466                         ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 467                         bdb_cache_entry_db_unlock( bdb, &lock );
 468                         if ( rc ) {
 469                                 *res = eip;
 470                                 return rc;
 471                         }
 472                 } else if ( ei2->bei_state & CACHE_ENTRY_DELETED ) {
 473                         /* In the midst of deleting? Give it a chance to
 474                          * complete.
 475                          */
 476                         bdb_cache_entryinfo_unlock( eip );
 477                         ldap_pvt_thread_yield();
 478                         bdb_cache_entryinfo_lock( eip );
 479                         *res = eip;
 480                         return DB_NOTFOUND;
 481                 }
 482                 bdb_cache_entryinfo_unlock( eip );
 483                 bdb_cache_entryinfo_lock( ei2 );
 484
 485                 eip = ei2;
 486
 487                 /* Advance to next lower RDN */
 488                 for (ptr = ei.bei_nrdn.bv_val - 2; ptr > ndn->bv_val
 489                         && !DN_SEPARATOR(*ptr); ptr--) /* empty */;
 490                 if ( ptr >= ndn->bv_val ) {
 491                         if (DN_SEPARATOR(*ptr)) ptr++;
 492                         ei.bei_nrdn.bv_len = ei.bei_nrdn.bv_val - ptr - 1;
 493                         ei.bei_nrdn.bv_val = ptr;
 494                 }
 495                 if ( ptr < ndn->bv_val ) {
 496                         *res = eip;
 497                         break;
 498                 }
 499         }
 500
 501         return rc;
 502 }
 503
 504 #ifdef BDB_HIER
 505 /* Walk up the tree from a child node, looking for an ID that's already
 506  * been linked into the cache.
 507  */
 508 int
 509 hdb_cache_find_parent(
 510         Operation *op,
 511         DB_TXN  *txn,
 512         ID id,
 513         EntryInfo **res )
 514 {
 515         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 516         EntryInfo ei, eip, *ei2 = NULL, *ein = NULL, *eir = NULL;
 517         int rc;
 518
 519         ei.bei_id = id;
 520         ei.bei_kids = NULL;
 521         ei.bei_ckids = 0;
 522
 523         for (;;) {
 524                 rc = hdb_dn2id_parent( op, txn, &ei, &eip.bei_id );
 525                 if ( rc ) break;
 526
 527                 /* Save the previous node, if any */
 528                 ei2 = ein;
 529
 530                 /* Create a new node for the current ID */
 531                 ein = bdb_cache_entryinfo_new( &bdb->bi_cache );
 532                 ein->bei_id = ei.bei_id;
 533                 ein->bei_kids = ei.bei_kids;
 534                 ein->bei_nrdn = ei.bei_nrdn;
 535                 ein->bei_rdn = ei.bei_rdn;
 536                 ein->bei_ckids = ei.bei_ckids;
 537 #ifdef SLAP_ZONE_ALLOC
 538                 ein->bei_bdb = bdb;
 539 #endif
 540                 ei.bei_ckids = 0;
 541
 542                 /* This node is not fully connected yet */
 543                 ein->bei_state |= CACHE_ENTRY_NOT_LINKED;
 544
 545                 /* Insert this node into the ID tree */
 546                 ldap_pvt_thread_rdwr_wlock( &bdb->bi_cache.c_rwlock );
 547                 if ( avl_insert( &bdb->bi_cache.c_idtree, (caddr_t)ein,
 548                         bdb_id_cmp, bdb_id_dup_err ) ) {
 549                         EntryInfo *eix = ein->bei_lrunext;
 550
 551                         /* Someone else created this node just before us.
 552                          * Free our new copy and use the existing one.
 553                          */
 554                         bdb_cache_entryinfo_free( &bdb->bi_cache, ein );
 555                         ein = eix;
 556
 557                         /* Link in any kids we've already processed */
 558                         if ( ei2 ) {
 559                                 bdb_cache_entryinfo_lock( ein );
 560                                 avl_insert( &ein->bei_kids, (caddr_t)ei2,
 561                                         bdb_rdn_cmp, avl_dup_error );
 562                                 ein->bei_ckids++;
 563                                 bdb_cache_entryinfo_unlock( ein );
 564                         }
 565                 }
 566
 567                 /* If this is the first time, save this node
 568                  * to be returned later.
 569                  */
 570                 if ( eir == NULL ) eir = ein;
 571
 572                 /* If there was a previous node, link it to this one */
 573                 if ( ei2 ) ei2->bei_parent = ein;
 574
 575                 /* Look for this node's parent */
 576                 if ( eip.bei_id ) {
 577                         ei2 = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 578                                         (caddr_t) &eip, bdb_id_cmp );
 579                 } else {
 580                         ei2 = &bdb->bi_cache.c_dntree;
 581                 }
 582                 bdb->bi_cache.c_eiused++;
 583                 if ( ei2 && ( ei2->bei_kids || !ei2->bei_id ))
 584                                 bdb->bi_cache.c_leaves++;
 585                 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 586
 587                 /* Got the parent, link in and we're done. */
 588                 if ( ei2 ) {
 589                         bdb_cache_entryinfo_lock( eir );
 590                         bdb_cache_entryinfo_lock( ei2 );
 591                         ein->bei_parent = ei2;
 592
 593                         avl_insert( &ei2->bei_kids, (caddr_t)ein, bdb_rdn_cmp,
 594                                 avl_dup_error);
 595                         ei2->bei_ckids++;
 596
 597                         /* Reset all the state info */
 598                         for (ein = eir; ein != ei2; ein=ein->bei_parent)
 599                                 ein->bei_state &= ~CACHE_ENTRY_NOT_LINKED;
 600
 601                         bdb_cache_entryinfo_unlock( ei2 );
 602
 603                         *res = eir;
 604                         break;
 605                 }
 606                 ei.bei_kids = NULL;
 607                 ei.bei_id = eip.bei_id;
 608                 ei.bei_ckids = 1;
 609                 avl_insert( &ei.bei_kids, (caddr_t)ein, bdb_rdn_cmp,
 610                         avl_dup_error );
 611         }
 612         return rc;
 613 }
 614
 615 /* Used by hdb_dn2idl when loading the EntryInfo for all the children
 616  * of a given node
 617  */
 618 int hdb_cache_load(
 619         struct bdb_info *bdb,
 620         EntryInfo *ei,
 621         EntryInfo **res )
 622 {
 623         EntryInfo *ei2;
 624         int rc;
 625
 626         /* See if we already have this one */
 627         bdb_cache_entryinfo_lock( ei->bei_parent );
 628         ei2 = (EntryInfo *)avl_find( ei->bei_parent->bei_kids, ei, bdb_rdn_cmp );
 629         bdb_cache_entryinfo_unlock( ei->bei_parent );
 630
 631         if ( !ei2 ) {
 632                 /* Not found, add it */
 633                 struct berval bv;
 634
 635                 /* bei_rdn was not malloc'd before, do it now */
 636                 ber_dupbv( &bv, &ei->bei_rdn );
 637                 ei->bei_rdn = bv;
 638
 639                 rc = bdb_entryinfo_add_internal( bdb, ei, res );
 640                 bdb_cache_entryinfo_unlock( ei->bei_parent );
 641                 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 642         } else {
 643                 /* Found, return it */
 644                 *res = ei2;
 645                 return 0;
 646         }
 647         return rc;
 648 }
 649 #endif
 650
 651 /* This is best-effort only. If all entries in the cache are
 652  * busy, they will all be kept. This is unlikely to happen
 653  * unless the cache is very much smaller than the working set.
 654  */
 655 static void
 656 bdb_cache_lru_purge( struct bdb_info *bdb )
 657 {
 658         DB_LOCK         lock, *lockp;
 659         EntryInfo *elru, *elnext = NULL;
 660         int count, islocked, eimax;
 661
 662         /* Wait for the mutex; we're the only one trying to purge. */
 663         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_lru_mutex );
 664
 665         /* maximum number of EntryInfo leaves to cache. In slapcat
 666          * we always free all leaf nodes.
 667          */
 668         if ( slapMode & SLAP_TOOL_READONLY )
 669                 eimax = 0;
 670         else
 671                 eimax = bdb->bi_cache.c_eimax;
 672
 673         if ( bdb->bi_cache.c_cursize <= bdb->bi_cache.c_maxsize &&
 674                 bdb->bi_cache.c_leaves <= eimax ) {
 675                 ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
 676                 bdb->bi_cache.c_purging = 0;
 677                 return;
 678         }
 679
 680         if ( bdb->bi_cache.c_txn ) {
 681                 lockp = &lock;
 682         } else {
 683                 lockp = NULL;
 684         }
 685
 686         count = 0;
 687
 688         /* Look for an unused entry to remove */
 689         for ( elru = bdb->bi_cache.c_lruhead; elru; elru = elnext ) {
 690                 elnext = elru->bei_lrunext;
 691
 692                 if ( bdb_cache_entryinfo_trylock( elru ))
 693                         goto bottom;
 694
 695                 /* This flag implements the clock replacement behavior */
 696                 if ( elru->bei_state & ( CACHE_ENTRY_REFERENCED )) {
 697                         elru->bei_state &= ~CACHE_ENTRY_REFERENCED;
 698                         bdb_cache_entryinfo_unlock( elru );
 699                         goto bottom;
 700                 }
 701
 702                 /* If this node is in the process of linking into the cache,
 703                  * or this node is being deleted, skip it.
 704                  */
 705                 if (( elru->bei_state & ( CACHE_ENTRY_NOT_LINKED |
 706                         CACHE_ENTRY_DELETED | CACHE_ENTRY_LOADING )) ||
 707                         elru->bei_finders > 0 ) {
 708                         bdb_cache_entryinfo_unlock( elru );
 709                         goto bottom;
 710                 }
 711
 712                 /* entryinfo is locked */
 713                 islocked = 1;
 714
 715                 /* If we can successfully writelock it, then
 716                  * the object is idle.
 717                  */
 718                 if ( bdb_cache_entry_db_lock( bdb,
 719                         bdb->bi_cache.c_txn, elru, 1, 1, lockp ) == 0 ) {
 720
 721                         /* Free entry for this node if it's present */
 722                         if ( elru->bei_e && bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize &&
 723                                 count < bdb->bi_cache.c_minfree ) {
 724                                 elru->bei_e->e_private = NULL;
 725 #ifdef SLAP_ZONE_ALLOC
 726                                 bdb_entry_return( bdb, elru->bei_e, elru->bei_zseq );
 727 #else
 728                                 bdb_entry_return( elru->bei_e );
 729 #endif
 730                                 elru->bei_e = NULL;
 731                                 count++;
 732                         }
 733                         bdb_cache_entry_db_unlock( bdb, lockp );
 734
 735                         /*
 736                          * If it is a leaf node, and we're over the limit, free it.
 737                          */
 738                         if ( elru->bei_kids ) {
 739                                 /* Drop from list, we ignore it... */
 740                                 LRU_DEL( &bdb->bi_cache, elru );
 741                         } else if ( bdb->bi_cache.c_leaves > eimax ) {
 742                                 /* Too many leaf nodes, free this one */
 743                                 bdb_cache_delete_internal( &bdb->bi_cache, elru, 0 );
 744                                 bdb_cache_delete_cleanup( &bdb->bi_cache, elru );
 745                                 islocked = 0;
 746                         }       /* Leave on list until we need to free it */
 747                 }
 748
 749                 if ( islocked )
 750                         bdb_cache_entryinfo_unlock( elru );
 751
 752                 if ( (unsigned) count >= bdb->bi_cache.c_minfree && bdb->bi_cache.c_leaves <= eimax ) {
 753                         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_count_mutex );
 754                         bdb->bi_cache.c_cursize -= count;
 755                         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_count_mutex );
 756                         break;
 757                 }
 758 bottom:
 759                 if ( elnext == bdb->bi_cache.c_lruhead )
 760                         break;
 761         }
 762
 763         bdb->bi_cache.c_lruhead = elnext;
 764         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
 765         bdb->bi_cache.c_purging = 0;
 766 }
 767
 768 EntryInfo *
 769 bdb_cache_find_info(
 770         struct bdb_info *bdb,
 771         ID id )
 772 {
 773         EntryInfo       ei = { 0 },
 774                         *ei2;
 775
 776         ei.bei_id = id;
 777
 778         ldap_pvt_thread_rdwr_rlock( &bdb->bi_cache.c_rwlock );
 779         ei2 = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 780                                         (caddr_t) &ei, bdb_id_cmp );
 781         ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 782         return ei2;
 783 }
 784
 785 /*
 786  * cache_find_id - find an entry in the cache, given id.
 787  * The entry is locked for Read upon return. Call with flag ID_LOCKED if
 788  * the supplied *eip was already locked.
 789  */
 790
 791 int
 792 bdb_cache_find_id(
 793         Operation *op,
 794         DB_TXN  *tid,
 795         ID                              id,
 796         EntryInfo       **eip,
 797         int             flag,
 798         DB_LOCK         *lock )
 799 {
 800         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 801         Entry   *ep = NULL;
 802         int     rc = 0, load = 0;
 803         EntryInfo ei = { 0 };
 804
 805         ei.bei_id = id;
 806
 807 #ifdef SLAP_ZONE_ALLOC
 808         slap_zh_rlock(bdb->bi_cache.c_zctx);
 809 #endif
 810         /* If we weren't given any info, see if we have it already cached */
 811         if ( !*eip ) {
 812 again:  ldap_pvt_thread_rdwr_rlock( &bdb->bi_cache.c_rwlock );
 813                 *eip = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 814                         (caddr_t) &ei, bdb_id_cmp );
 815                 if ( *eip ) {
 816                         /* If the lock attempt fails, the info is in use */
 817                         if ( bdb_cache_entryinfo_trylock( *eip )) {
 818                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 819                                 /* If this node is being deleted, treat
 820                                  * as if the delete has already finished
 821                                  */
 822                                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 823                                         return DB_NOTFOUND;
 824                                 }
 825                                 /* otherwise, wait for the info to free up */
 826                                 ldap_pvt_thread_yield();
 827                                 goto again;
 828                         }
 829                         /* If this info isn't hooked up to its parent yet,
 830                          * unlock and wait for it to be fully initialized
 831                          */
 832                         if ( (*eip)->bei_state & CACHE_ENTRY_NOT_LINKED ) {
 833                                 bdb_cache_entryinfo_unlock( *eip );
 834                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 835                                 ldap_pvt_thread_yield();
 836                                 goto again;
 837                         }
 838                         flag |= ID_LOCKED;
 839                 }
 840                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 841         }
 842
 843         /* See if the ID exists in the database; add it to the cache if so */
 844         if ( !*eip ) {
 845 #ifndef BDB_HIER
 846                 rc = bdb_id2entry( op->o_bd, tid, id, &ep );
 847                 if ( rc == 0 ) {
 848                         rc = bdb_cache_find_ndn( op, tid,
 849                                 &ep->e_nname, eip );
 850                         if ( *eip ) flag |= ID_LOCKED;
 851                         if ( rc ) {
 852                                 ep->e_private = NULL;
 853 #ifdef SLAP_ZONE_ALLOC
 854                                 bdb_entry_return( bdb, ep, (*eip)->bei_zseq );
 855 #else
 856                                 bdb_entry_return( ep );
 857 #endif
 858                                 ep = NULL;
 859                         }
 860                 }
 861 #else
 862                 rc = hdb_cache_find_parent(op, tid, id, eip );
 863                 if ( rc == 0 ) flag |= ID_LOCKED;
 864 #endif
 865         }
 866
 867         /* Ok, we found the info, do we have the entry? */
 868         if ( rc == 0 ) {
 869                 if ( !( flag & ID_LOCKED )) {
 870                         bdb_cache_entryinfo_lock( *eip );
 871                         flag |= ID_LOCKED;
 872                 }
 873
 874                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 875                         rc = DB_NOTFOUND;
 876                 } else {
 877                         (*eip)->bei_finders++;
 878                         (*eip)->bei_state |= CACHE_ENTRY_REFERENCED;
 879                         /* Make sure only one thread tries to load the entry */
 880 load1:
 881 #ifdef SLAP_ZONE_ALLOC
 882                         if ((*eip)->bei_e && !slap_zn_validate(
 883                                         bdb->bi_cache.c_zctx, (*eip)->bei_e, (*eip)->bei_zseq)) {
 884                                 (*eip)->bei_e = NULL;
 885                                 (*eip)->bei_zseq = 0;
 886                         }
 887 #endif
 888                         if ( !(*eip)->bei_e && !((*eip)->bei_state & CACHE_ENTRY_LOADING)) {
 889                                 load = 1;
 890                                 (*eip)->bei_state |= CACHE_ENTRY_LOADING;
 891                         }
 892
 893                         if ( !load ) {
 894                                 /* Clear the uncached state if we are not
 895                                  * loading it, i.e it is already cached or
 896                                  * another thread is currently loading it.
 897                                  */
 898                                 (*eip)->bei_state &= ~CACHE_ENTRY_NOT_CACHED;
 899                                 flag &= ~ID_NOCACHE;
 900                         }
 901
 902                         if ( flag & ID_LOCKED ) {
 903                                 bdb_cache_entryinfo_unlock( *eip );
 904                                 flag ^= ID_LOCKED;
 905                         }
 906                         rc = bdb_cache_entry_db_lock( bdb, tid, *eip, load, 0, lock );
 907                         if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 908                                 rc = DB_NOTFOUND;
 909                                 bdb_cache_entry_db_unlock( bdb, lock );
 910                         } else if ( rc == 0 ) {
 911                                 if ( load ) {
 912                                         if ( !ep) {
 913                                                 rc = bdb_id2entry( op->o_bd, tid, id, &ep );
 914                                         }
 915                                         if ( rc == 0 ) {
 916                                                 ep->e_private = *eip;
 917 #ifdef BDB_HIER
 918                                                 bdb_fix_dn( ep, 0 );
 919 #endif
 920                                                 (*eip)->bei_e = ep;
 921 #ifdef SLAP_ZONE_ALLOC
 922                                                 (*eip)->bei_zseq = *((ber_len_t *)ep - 2);
 923 #endif
 924                                                 ep = NULL;
 925                                                 bdb_cache_lru_link( bdb, *eip );
 926                                                 if (( flag & ID_NOCACHE ) &&
 927                                                         ( bdb_cache_entryinfo_trylock( *eip ) == 0 )) {
 928                                                         /* Set the cached state only if no other thread
 929                                                          * found the info while we were loading the entry.
 930                                                          */
 931                                                         if ( (*eip)->bei_finders == 1 )
 932                                                                 (*eip)->bei_state |= CACHE_ENTRY_NOT_CACHED;
 933                                                         bdb_cache_entryinfo_unlock( *eip );
 934                                                 }
 935                                         }
 936                                         if ( rc == 0 ) {
 937                                                 /* If we succeeded, downgrade back to a readlock. */
 938                                                 rc = bdb_cache_entry_db_relock( bdb, tid,
 939                                                         *eip, 0, 0, lock );
 940                                         } else {
 941                                                 /* Otherwise, release the lock. */
 942                                                 bdb_cache_entry_db_unlock( bdb, lock );
 943                                         }
 944                                 } else if ( !(*eip)->bei_e ) {
 945                                         /* Some other thread is trying to load the entry,
 946                                          * wait for it to finish.
 947                                          */
 948                                         bdb_cache_entry_db_unlock( bdb, lock );
 949                                         bdb_cache_entryinfo_lock( *eip );
 950                                         flag |= ID_LOCKED;
 951                                         goto load1;
 952 #ifdef BDB_HIER
 953                                 } else {
 954                                         /* Check for subtree renames
 955                                          */
 956                                         rc = bdb_fix_dn( (*eip)->bei_e, 1 );
 957                                         if ( rc ) {
 958                                                 bdb_cache_entry_db_relock( bdb,
 959                                                         tid, *eip, 1, 0, lock );
 960                                                 /* check again in case other modifier did it already */
 961                                                 if ( bdb_fix_dn( (*eip)->bei_e, 1 ) )
 962                                                         rc = bdb_fix_dn( (*eip)->bei_e, 2 );
 963                                                 bdb_cache_entry_db_relock( bdb,
 964                                                         tid, *eip, 0, 0, lock );
 965                                         }
 966 #endif
 967                                 }
 968                         }
 969                         bdb_cache_entryinfo_lock( *eip );
 970                         (*eip)->bei_finders--;
 971                         if ( load )
 972                                 (*eip)->bei_state ^= CACHE_ENTRY_LOADING;
 973                         bdb_cache_entryinfo_unlock( *eip );
 974                 }
 975         }
 976         if ( flag & ID_LOCKED ) {
 977                 bdb_cache_entryinfo_unlock( *eip );
 978         }
 979         if ( ep ) {
 980                 ep->e_private = NULL;
 981 #ifdef SLAP_ZONE_ALLOC
 982                 bdb_entry_return( bdb, ep, (*eip)->bei_zseq );
 983 #else
 984                 bdb_entry_return( ep );
 985 #endif
 986         }
 987         if ( rc == 0 ) {
 988                 int purge = 0;
 989
 990                 if ( load ) {
 991                         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_count_mutex );
 992                         if ( !( flag & ID_NOCACHE )) {
 993                                 bdb->bi_cache.c_cursize++;
 994                                 if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize &&
 995                                         !bdb->bi_cache.c_purging ) {
 996                                         purge = 1;
 997                                         bdb->bi_cache.c_purging = 1;
 998                                 }
 999                         } else if ( bdb->bi_cache.c_leaves > bdb->bi_cache.c_eimax && !bdb->bi_cache.c_purging ) {
1000                                 purge = 1;
1001                                 bdb->bi_cache.c_purging = 1;
1002                         }
1003                         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_count_mutex );
1004                 }
1005                 if ( purge )
1006                         bdb_cache_lru_purge( bdb );
1007         }
1008
1009 #ifdef SLAP_ZONE_ALLOC
1010         if (rc == 0 && (*eip)->bei_e) {
1011                 slap_zn_rlock(bdb->bi_cache.c_zctx, (*eip)->bei_e);
1012         }
1013         slap_zh_runlock(bdb->bi_cache.c_zctx);
1014 #endif
1015         return rc;
1016 }
1017
1018 int
1019 bdb_cache_children(
1020         Operation *op,
1021         DB_TXN *txn,
1022         Entry *e )
1023 {
1024         int rc;
1025
1026         if ( BEI(e)->bei_kids ) {
1027                 return 0;
1028         }
1029         if ( BEI(e)->bei_state & CACHE_ENTRY_NO_KIDS ) {
1030                 return DB_NOTFOUND;
1031         }
1032         rc = bdb_dn2id_children( op, txn, e );
1033         if ( rc == DB_NOTFOUND ) {
1034                 BEI(e)->bei_state |= CACHE_ENTRY_NO_KIDS | CACHE_ENTRY_NO_GRANDKIDS;
1035         }
1036         return rc;
1037 }
1038
1039 /* Update the cache after a successful database Add. */
1040 int
1041 bdb_cache_add(
1042         struct bdb_info *bdb,
1043         EntryInfo *eip,
1044         Entry *e,
1045         struct berval *nrdn,
1046         DB_TXN *txn,
1047         DB_LOCK *lock )
1048 {
1049         EntryInfo *new, ei;
1050         int rc, purge = 0;
1051 #ifdef BDB_HIER
1052         struct berval rdn = e->e_name;
1053 #endif
1054
1055         ei.bei_id = e->e_id;
1056         ei.bei_parent = eip;
1057         ei.bei_nrdn = *nrdn;
1058         ei.bei_lockpad = 0;
1059
1060         /* Lock this entry so that bdb_add can run to completion.
1061          * It can only fail if BDB has run out of lock resources.
1062          */
1063         rc = bdb_cache_entry_db_lock( bdb, txn, &ei, 0, 0, lock );
1064         if ( rc ) {
1065                 bdb_cache_entryinfo_unlock( eip );
1066                 return rc;
1067         }
1068
1069 #ifdef BDB_HIER
1070         if ( nrdn->bv_len != e->e_nname.bv_len ) {
1071                 char *ptr = ber_bvchr( &rdn, ',' );
1072                 assert( ptr != NULL );
1073                 rdn.bv_len = ptr - rdn.bv_val;
1074         }
1075         ber_dupbv( &ei.bei_rdn, &rdn );
1076         if ( eip->bei_dkids ) eip->bei_dkids++;
1077 #endif
1078
1079         rc = bdb_entryinfo_add_internal( bdb, &ei, &new );
1080         /* bdb_csn_commit can cause this when adding the database root entry */
1081         if ( new->bei_e ) {
1082                 new->bei_e->e_private = NULL;
1083 #ifdef SLAP_ZONE_ALLOC
1084                 bdb_entry_return( bdb, new->bei_e, new->bei_zseq );
1085 #else
1086                 bdb_entry_return( new->bei_e );
1087 #endif
1088         }
1089         new->bei_e = e;
1090         e->e_private = new;
1091         new->bei_state |= CACHE_ENTRY_NO_KIDS | CACHE_ENTRY_NO_GRANDKIDS;
1092         eip->bei_state &= ~CACHE_ENTRY_NO_KIDS;
1093         if (eip->bei_parent) {
1094                 eip->bei_parent->bei_state &= ~CACHE_ENTRY_NO_GRANDKIDS;
1095         }
1096         bdb_cache_entryinfo_unlock( eip );
1097
1098         ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
1099         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_count_mutex );
1100         ++bdb->bi_cache.c_cursize;
1101         if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize &&
1102                 !bdb->bi_cache.c_purging ) {
1103                 purge = 1;
1104                 bdb->bi_cache.c_purging = 1;
1105         }
1106         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_count_mutex );
1107
1108         bdb_cache_lru_link( bdb, new );
1109
1110         if ( purge )
1111                 bdb_cache_lru_purge( bdb );
1112
1113         return rc;
1114 }
1115
1116 int
1117 bdb_cache_modify(
1118         struct bdb_info *bdb,
1119         Entry *e,
1120         Attribute *newAttrs,
1121         DB_TXN *txn,
1122         DB_LOCK *lock )
1123 {
1124         EntryInfo *ei = BEI(e);
1125         int rc;
1126         /* Get write lock on data */
1127         rc = bdb_cache_entry_db_relock( bdb, txn, ei, 1, 0, lock );
1128
1129         /* If we've done repeated mods on a cached entry, then e_attrs
1130          * is no longer contiguous with the entry, and must be freed.
1131          */
1132         if ( ! rc ) {
1133                 if ( (void *)e->e_attrs != (void *)(e+1) ) {
1134                         attrs_free( e->e_attrs );
1135                 }
1136                 e->e_attrs = newAttrs;
1137         }
1138         return rc;
1139 }
1140
1141 /*
1142  * Change the rdn in the entryinfo. Also move to a new parent if needed.
1143  */
1144 int
1145 bdb_cache_modrdn(
1146         struct bdb_info *bdb,
1147         Entry *e,
1148         struct berval *nrdn,
1149         Entry *new,
1150         EntryInfo *ein,
1151         DB_TXN *txn,
1152         DB_LOCK *lock )
1153 {
1154         EntryInfo *ei = BEI(e), *pei;
1155         int rc;
1156 #ifdef BDB_HIER
1157         struct berval rdn;
1158 #endif
1159
1160         /* Get write lock on data */
1161         rc =  bdb_cache_entry_db_relock( bdb, txn, ei, 1, 0, lock );
1162         if ( rc ) return rc;
1163
1164         /* If we've done repeated mods on a cached entry, then e_attrs
1165          * is no longer contiguous with the entry, and must be freed.
1166          */
1167         if ( (void *)e->e_attrs != (void *)(e+1) ) {
1168                 attrs_free( e->e_attrs );
1169         }
1170         e->e_attrs = new->e_attrs;
1171         if( e->e_nname.bv_val < e->e_bv.bv_val ||
1172                 e->e_nname.bv_val > e->e_bv.bv_val + e->e_bv.bv_len )
1173         {
1174                 ch_free(e->e_name.bv_val);
1175                 ch_free(e->e_nname.bv_val);
1176         }
1177         e->e_name = new->e_name;
1178         e->e_nname = new->e_nname;
1179
1180         /* Lock the parent's kids AVL tree */
1181         pei = ei->bei_parent;
1182         bdb_cache_entryinfo_lock( pei );
1183         avl_delete( &pei->bei_kids, (caddr_t) ei, bdb_rdn_cmp );
1184         free( ei->bei_nrdn.bv_val );
1185         ber_dupbv( &ei->bei_nrdn, nrdn );
1186
1187 #ifdef BDB_HIER
1188         free( ei->bei_rdn.bv_val );
1189
1190         rdn = e->e_name;
1191         if ( nrdn->bv_len != e->e_nname.bv_len ) {
1192                 char *ptr = ber_bvchr(&rdn, ',');
1193                 assert( ptr != NULL );
1194                 rdn.bv_len = ptr - rdn.bv_val;
1195         }
1196         ber_dupbv( &ei->bei_rdn, &rdn );
1197
1198         /* If new parent, decrement kid counts */
1199         if ( ein ) {
1200                 pei->bei_ckids--;
1201                 if ( pei->bei_dkids ) {
1202                         pei->bei_dkids--;
1203                         if ( pei->bei_dkids < 2 )
1204                                 pei->bei_state |= CACHE_ENTRY_NO_KIDS | CACHE_ENTRY_NO_GRANDKIDS;
1205                 }
1206         }
1207 #endif
1208
1209         if (!ein) {
1210                 ein = ei->bei_parent;
1211         } else {
1212                 ei->bei_parent = ein;
1213                 bdb_cache_entryinfo_unlock( pei );
1214                 bdb_cache_entryinfo_lock( ein );
1215
1216                 /* new parent now has kids */
1217                 if ( ein->bei_state & CACHE_ENTRY_NO_KIDS )
1218                         ein->bei_state ^= CACHE_ENTRY_NO_KIDS;
1219                 /* grandparent has grandkids */
1220                 if ( ein->bei_parent )
1221                         ein->bei_parent->bei_state &= ~CACHE_ENTRY_NO_GRANDKIDS;
1222 #ifdef BDB_HIER
1223                 /* parent might now have grandkids */
1224                 if ( ein->bei_state & CACHE_ENTRY_NO_GRANDKIDS &&
1225                         !(ei->bei_state & CACHE_ENTRY_NO_KIDS))
1226                         ein->bei_state ^= CACHE_ENTRY_NO_GRANDKIDS;
1227
1228                 ein->bei_ckids++;
1229                 if ( ein->bei_dkids ) ein->bei_dkids++;
1230 #endif
1231         }
1232
1233 #ifdef BDB_HIER
1234         /* Record the generation number of this change */
1235         ldap_pvt_thread_mutex_lock( &bdb->bi_modrdns_mutex );
1236         bdb->bi_modrdns++;
1237         ei->bei_modrdns = bdb->bi_modrdns;
1238         ldap_pvt_thread_mutex_unlock( &bdb->bi_modrdns_mutex );
1239 #endif
1240
1241         avl_insert( &ein->bei_kids, ei, bdb_rdn_cmp, avl_dup_error );
1242         bdb_cache_entryinfo_unlock( ein );
1243         return rc;
1244 }
1245 /*
1246  * cache_delete - delete the entry e from the cache.
1247  *
1248  * returns:     0       e was deleted ok
1249  *              1       e was not in the cache
1250  *              -1      something bad happened
1251  */
1252 int
1253 bdb_cache_delete(
1254         struct bdb_info *bdb,
1255     Entry               *e,
1256     DB_TXN *txn,
1257     DB_LOCK     *lock )
1258 {
1259         EntryInfo *ei = BEI(e);
1260         int     rc;
1261
1262         assert( e->e_private != NULL );
1263
1264         /* Lock the entry's info */
1265         bdb_cache_entryinfo_lock( ei );
1266
1267         /* Set this early, warn off any queriers */
1268         ei->bei_state |= CACHE_ENTRY_DELETED;
1269
1270         bdb_cache_entryinfo_unlock( ei );
1271
1272         /* Get write lock on the data */
1273         rc = bdb_cache_entry_db_relock( bdb, txn, ei, 1, 0, lock );
1274         if ( rc ) {
1275                 /* couldn't lock, undo and give up */
1276                 ei->bei_state ^= CACHE_ENTRY_DELETED;
1277                 return rc;
1278         }
1279
1280         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_delete( %ld )\n",
1281                 e->e_id, 0, 0 );
1282
1283         /* set lru mutex */
1284         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_lru_mutex );
1285
1286         rc = bdb_cache_delete_internal( &bdb->bi_cache, e->e_private, 1 );
1287
1288         /* free lru mutex */
1289         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
1290
1291         return( rc );
1292 }
1293
1294 void
1295 bdb_cache_delete_cleanup(
1296         Cache *cache,
1297         EntryInfo *ei )
1298 {
1299         /* Enter with ei locked */
1300
1301         if ( ei->bei_e ) {
1302                 ei->bei_e->e_private = NULL;
1303 #ifdef SLAP_ZONE_ALLOC
1304                 bdb_entry_return( ei->bei_bdb, ei->bei_e, ei->bei_zseq );
1305 #else
1306                 bdb_entry_return( ei->bei_e );
1307 #endif
1308                 ei->bei_e = NULL;
1309         }
1310
1311         bdb_cache_entryinfo_free( cache, ei );
1312         bdb_cache_entryinfo_unlock( ei );
1313 }
1314
1315 static int
1316 bdb_cache_delete_internal(
1317     Cache       *cache,
1318     EntryInfo           *e,
1319     int         decr )
1320 {
1321         int rc = 0;     /* return code */
1322         int decr_leaf = 0;
1323
1324         /* Lock the parent's kids tree */
1325         bdb_cache_entryinfo_lock( e->bei_parent );
1326
1327 #ifdef BDB_HIER
1328         e->bei_parent->bei_ckids--;
1329         if ( decr && e->bei_parent->bei_dkids ) e->bei_parent->bei_dkids--;
1330 #endif
1331         /* dn tree */
1332         if ( avl_delete( &e->bei_parent->bei_kids, (caddr_t) e, bdb_rdn_cmp )
1333                 == NULL )
1334         {
1335                 rc = -1;
1336         }
1337         if ( e->bei_parent->bei_kids )
1338                 decr_leaf = 1;
1339
1340         bdb_cache_entryinfo_unlock( e->bei_parent );
1341
1342         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
1343         /* id tree */
1344         if ( avl_delete( &cache->c_idtree, (caddr_t) e, bdb_id_cmp )) {
1345                 cache->c_eiused--;
1346                 if ( decr_leaf )
1347                         cache->c_leaves--;
1348         } else {
1349                 rc = -1;
1350         }
1351         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
1352
1353         if ( rc == 0 ){
1354                 /* lru */
1355                 LRU_DEL( cache, e );
1356
1357                 if ( e->bei_e ) {
1358                         ldap_pvt_thread_mutex_lock( &cache->c_count_mutex );
1359                         cache->c_cursize--;
1360                         ldap_pvt_thread_mutex_unlock( &cache->c_count_mutex );
1361                 }
1362         }
1363
1364         return( rc );
1365 }
1366
1367 static void
1368 bdb_entryinfo_release( void *data )
1369 {
1370         EntryInfo *ei = (EntryInfo *)data;
1371         if ( ei->bei_kids ) {
1372                 avl_free( ei->bei_kids, NULL );
1373         }
1374         if ( ei->bei_e ) {
1375                 ei->bei_e->e_private = NULL;
1376 #ifdef SLAP_ZONE_ALLOC
1377                 bdb_entry_return( ei->bei_bdb, ei->bei_e, ei->bei_zseq );
1378 #else
1379                 bdb_entry_return( ei->bei_e );
1380 #endif
1381         }
1382         bdb_cache_entryinfo_destroy( ei );
1383 }
1384
1385 void
1386 bdb_cache_release_all( Cache *cache )
1387 {
1388         /* set cache write lock */
1389         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
1390         /* set lru mutex */
1391         ldap_pvt_thread_mutex_lock( &cache->c_lru_mutex );
1392
1393         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_release_all\n", 0, 0, 0 );
1394
1395         avl_free( cache->c_dntree.bei_kids, NULL );
1396         avl_free( cache->c_idtree, bdb_entryinfo_release );
1397         for (;cache->c_eifree;cache->c_eifree = cache->c_lruhead) {
1398                 cache->c_lruhead = cache->c_eifree->bei_lrunext;
1399                 bdb_cache_entryinfo_destroy(cache->c_eifree);
1400         }
1401         cache->c_cursize = 0;
1402         cache->c_eiused = 0;
1403         cache->c_leaves = 0;
1404         cache->c_idtree = NULL;
1405         cache->c_lruhead = NULL;
1406         cache->c_lrutail = NULL;
1407         cache->c_dntree.bei_kids = NULL;
1408
1409         /* free lru mutex */
1410         ldap_pvt_thread_mutex_unlock( &cache->c_lru_mutex );
1411         /* free cache write lock */
1412         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
1413 }
1414
1415 #ifdef LDAP_DEBUG
1416 #ifdef SLAPD_UNUSED
1417 static void
1418 bdb_lru_print( Cache *cache )
1419 {
1420         EntryInfo       *e;
1421
1422         fprintf( stderr, "LRU circle head: %p\n", (void *) cache->c_lruhead );
1423         fprintf( stderr, "LRU circle (tail forward):\n" );
1424         for ( e = cache->c_lrutail; ; ) {
1425                 fprintf( stderr, "\t%p, %p id %ld rdn \"%s\"\n",
1426                         (void *) e, (void *) e->bei_e, e->bei_id, e->bei_nrdn.bv_val );
1427                 e = e->bei_lrunext;
1428                 if ( e == cache->c_lrutail )
1429                         break;
1430         }
1431         fprintf( stderr, "LRU circle (tail backward):\n" );
1432         for ( e = cache->c_lrutail; ; ) {
1433                 fprintf( stderr, "\t%p, %p id %ld rdn \"%s\"\n",
1434                         (void *) e, (void *) e->bei_e, e->bei_id, e->bei_nrdn.bv_val );
1435                 e = e->bei_lruprev;
1436                 if ( e == cache->c_lrutail )
1437                         break;
1438         }
1439 }
1440 #endif
1441 #endif
1442
1443 static void
1444 bdb_reader_free( void *key, void *data )
1445 {
1446         /* DB_ENV *env = key; */
1447         DB_TXN *txn = data;
1448
1449         TXN_ABORT( txn );
1450 }
1451
1452 /* free up any keys used by the main thread */
1453 void
1454 bdb_reader_flush( DB_ENV *env )
1455 {
1456         void *data;
1457         void *ctx = ldap_pvt_thread_pool_context();
1458
1459         if ( !ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
1460                 ldap_pvt_thread_pool_setkey( ctx, env, NULL, 0, NULL, NULL );
1461                 bdb_reader_free( env, data );
1462         }
1463 }
1464
1465 int
1466 bdb_reader_get( Operation *op, DB_ENV *env, DB_TXN **txn )
1467 {
1468         int i, rc;
1469         void *data;
1470         void *ctx;
1471
1472         if ( !env || !txn ) return -1;
1473
1474         /* If no op was provided, try to find the ctx anyway... */
1475         if ( op ) {
1476                 ctx = op->o_threadctx;
1477         } else {
1478                 ctx = ldap_pvt_thread_pool_context();
1479         }
1480
1481         /* Shouldn't happen unless we're single-threaded */
1482         if ( !ctx ) {
1483                 *txn = NULL;
1484                 return 0;
1485         }
1486
1487         if ( ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
1488                 for ( i=0, rc=1; rc != 0 && i<4; i++ ) {
1489                         rc = TXN_BEGIN( env, NULL, txn, DB_READ_COMMITTED );
1490                         if (rc) ldap_pvt_thread_yield();
1491                 }
1492                 if ( rc != 0) {
1493                         return rc;
1494                 }
1495                 data = *txn;
1496                 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, env,
1497                         data, bdb_reader_free, NULL, NULL ) ) ) {
1498                         TXN_ABORT( *txn );
1499                         Debug( LDAP_DEBUG_ANY, "bdb_reader_get: err %s(%d)\n",
1500                                 db_strerror(rc), rc, 0 );
1501
1502                         return rc;
1503                 }
1504         } else {
1505                 *txn = data;
1506         }
1507         return 0;
1508 }