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         int efree = 0, eifree = 0, eicount, ecount;
 662 #ifdef LDAP_DEBUG
 663         int iter;
 664 #endif
 665
 666         /* Wait for the mutex; we're the only one trying to purge. */
 667         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_lru_mutex );
 668
 669         /* maximum number of EntryInfo leaves to cache. In slapcat
 670          * we always free all leaf nodes.
 671          */
 672         if ( slapMode & SLAP_TOOL_READONLY )
 673                 eimax = 0;
 674         else
 675                 eimax = bdb->bi_cache.c_eimax;
 676
 677         if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize )
 678                 efree = bdb->bi_cache.c_minfree;
 679         if ( bdb->bi_cache.c_leaves > eimax ) {
 680                 eifree = bdb->bi_cache.c_minfree * 10;
 681                 if ( eifree >= eimax )
 682                         eifree = eimax / 2;
 683         }
 684
 685         if ( !efree && !eifree ) {
 686                 ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
 687                 bdb->bi_cache.c_purging = 0;
 688                 return;
 689         }
 690
 691         if ( bdb->bi_cache.c_txn ) {
 692                 lockp = &lock;
 693         } else {
 694                 lockp = NULL;
 695         }
 696
 697         count = 0;
 698         eicount = 0;
 699         ecount = 0;
 700 #ifdef LDAP_DEBUG
 701         iter = 0;
 702 #endif
 703
 704         /* Look for an unused entry to remove */
 705         for ( elru = bdb->bi_cache.c_lruhead; elru; elru = elnext ) {
 706                 elnext = elru->bei_lrunext;
 707
 708                 if ( bdb_cache_entryinfo_trylock( elru ))
 709                         goto bottom;
 710
 711                 /* This flag implements the clock replacement behavior */
 712                 if ( elru->bei_state & ( CACHE_ENTRY_REFERENCED )) {
 713                         elru->bei_state &= ~CACHE_ENTRY_REFERENCED;
 714                         bdb_cache_entryinfo_unlock( elru );
 715                         goto bottom;
 716                 }
 717
 718                 /* If this node is in the process of linking into the cache,
 719                  * or this node is being deleted, skip it.
 720                  */
 721                 if (( elru->bei_state & ( CACHE_ENTRY_NOT_LINKED |
 722                         CACHE_ENTRY_DELETED | CACHE_ENTRY_LOADING )) ||
 723                         elru->bei_finders > 0 ) {
 724                         bdb_cache_entryinfo_unlock( elru );
 725                         goto bottom;
 726                 }
 727
 728                 /* entryinfo is locked */
 729                 islocked = 1;
 730
 731                 /* If we can successfully writelock it, then
 732                  * the object is idle.
 733                  */
 734                 if ( bdb_cache_entry_db_lock( bdb,
 735                         bdb->bi_cache.c_txn, elru, 1, 1, lockp ) == 0 ) {
 736
 737                         /* Free entry for this node if it's present */
 738                         if ( elru->bei_e ) {
 739                                 ecount++;
 740                                 if ( count < efree ) {
 741                                         elru->bei_e->e_private = NULL;
 742 #ifdef SLAP_ZONE_ALLOC
 743                                         bdb_entry_return( bdb, elru->bei_e, elru->bei_zseq );
 744 #else
 745                                         bdb_entry_return( elru->bei_e );
 746 #endif
 747                                         elru->bei_e = NULL;
 748                                         count++;
 749                                 } else {
 750                                         /* Keep this node cached, skip to next */
 751                                         bdb_cache_entry_db_unlock( bdb, lockp );
 752                                         goto next;
 753                                 }
 754                         }
 755                         bdb_cache_entry_db_unlock( bdb, lockp );
 756
 757                         /*
 758                          * If it is a leaf node, and we're over the limit, free it.
 759                          */
 760                         if ( elru->bei_kids ) {
 761                                 /* Drop from list, we ignore it... */
 762                                 LRU_DEL( &bdb->bi_cache, elru );
 763                         } else if ( eicount < eifree ) {
 764                                 /* Too many leaf nodes, free this one */
 765                                 bdb_cache_delete_internal( &bdb->bi_cache, elru, 0 );
 766                                 bdb_cache_delete_cleanup( &bdb->bi_cache, elru );
 767                                 islocked = 0;
 768                                 eicount++;
 769                         }       /* Leave on list until we need to free it */
 770                 }
 771
 772 next:
 773                 if ( islocked )
 774                         bdb_cache_entryinfo_unlock( elru );
 775
 776                 if ( count >= efree && eicount >= eifree ) {
 777                         if ( count || ecount > bdb->bi_cache.c_cursize ) {
 778                                 ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_count_mutex );
 779                                 /* HACK: we seem to be losing track, fix up now */
 780                                 if ( ecount > bdb->bi_cache.c_cursize )
 781                                         bdb->bi_cache.c_cursize = ecount;
 782                                 bdb->bi_cache.c_cursize -= count;
 783                                 ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_count_mutex );
 784                         }
 785                         break;
 786                 }
 787 bottom:
 788                 if ( elnext == bdb->bi_cache.c_lruhead )
 789                         break;
 790 #ifdef LDAP_DEBUG
 791                 iter++;
 792 #endif
 793         }
 794
 795         bdb->bi_cache.c_lruhead = elnext;
 796         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
 797         bdb->bi_cache.c_purging = 0;
 798 }
 799
 800 EntryInfo *
 801 bdb_cache_find_info(
 802         struct bdb_info *bdb,
 803         ID id )
 804 {
 805         EntryInfo       ei = { 0 },
 806                         *ei2;
 807
 808         ei.bei_id = id;
 809
 810         ldap_pvt_thread_rdwr_rlock( &bdb->bi_cache.c_rwlock );
 811         ei2 = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 812                                         (caddr_t) &ei, bdb_id_cmp );
 813         ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 814         return ei2;
 815 }
 816
 817 /*
 818  * cache_find_id - find an entry in the cache, given id.
 819  * The entry is locked for Read upon return. Call with flag ID_LOCKED if
 820  * the supplied *eip was already locked.
 821  */
 822
 823 int
 824 bdb_cache_find_id(
 825         Operation *op,
 826         DB_TXN  *tid,
 827         ID                              id,
 828         EntryInfo       **eip,
 829         int             flag,
 830         DB_LOCK         *lock )
 831 {
 832         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 833         Entry   *ep = NULL;
 834         int     rc = 0, load = 0;
 835         EntryInfo ei = { 0 };
 836
 837         ei.bei_id = id;
 838
 839 #ifdef SLAP_ZONE_ALLOC
 840         slap_zh_rlock(bdb->bi_cache.c_zctx);
 841 #endif
 842         /* If we weren't given any info, see if we have it already cached */
 843         if ( !*eip ) {
 844 again:  ldap_pvt_thread_rdwr_rlock( &bdb->bi_cache.c_rwlock );
 845                 *eip = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 846                         (caddr_t) &ei, bdb_id_cmp );
 847                 if ( *eip ) {
 848                         /* If the lock attempt fails, the info is in use */
 849                         if ( bdb_cache_entryinfo_trylock( *eip )) {
 850                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 851                                 /* If this node is being deleted, treat
 852                                  * as if the delete has already finished
 853                                  */
 854                                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 855                                         return DB_NOTFOUND;
 856                                 }
 857                                 /* otherwise, wait for the info to free up */
 858                                 ldap_pvt_thread_yield();
 859                                 goto again;
 860                         }
 861                         /* If this info isn't hooked up to its parent yet,
 862                          * unlock and wait for it to be fully initialized
 863                          */
 864                         if ( (*eip)->bei_state & CACHE_ENTRY_NOT_LINKED ) {
 865                                 bdb_cache_entryinfo_unlock( *eip );
 866                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 867                                 ldap_pvt_thread_yield();
 868                                 goto again;
 869                         }
 870                         flag |= ID_LOCKED;
 871                 }
 872                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 873         }
 874
 875         /* See if the ID exists in the database; add it to the cache if so */
 876         if ( !*eip ) {
 877 #ifndef BDB_HIER
 878                 rc = bdb_id2entry( op->o_bd, tid, id, &ep );
 879                 if ( rc == 0 ) {
 880                         rc = bdb_cache_find_ndn( op, tid,
 881                                 &ep->e_nname, eip );
 882                         if ( *eip ) flag |= ID_LOCKED;
 883                         if ( rc ) {
 884                                 ep->e_private = NULL;
 885 #ifdef SLAP_ZONE_ALLOC
 886                                 bdb_entry_return( bdb, ep, (*eip)->bei_zseq );
 887 #else
 888                                 bdb_entry_return( ep );
 889 #endif
 890                                 ep = NULL;
 891                         }
 892                 }
 893 #else
 894                 rc = hdb_cache_find_parent(op, tid, id, eip );
 895                 if ( rc == 0 ) flag |= ID_LOCKED;
 896 #endif
 897         }
 898
 899         /* Ok, we found the info, do we have the entry? */
 900         if ( rc == 0 ) {
 901                 if ( !( flag & ID_LOCKED )) {
 902                         bdb_cache_entryinfo_lock( *eip );
 903                         flag |= ID_LOCKED;
 904                 }
 905
 906                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 907                         rc = DB_NOTFOUND;
 908                 } else {
 909                         (*eip)->bei_finders++;
 910                         (*eip)->bei_state |= CACHE_ENTRY_REFERENCED;
 911                         /* Make sure only one thread tries to load the entry */
 912 load1:
 913 #ifdef SLAP_ZONE_ALLOC
 914                         if ((*eip)->bei_e && !slap_zn_validate(
 915                                         bdb->bi_cache.c_zctx, (*eip)->bei_e, (*eip)->bei_zseq)) {
 916                                 (*eip)->bei_e = NULL;
 917                                 (*eip)->bei_zseq = 0;
 918                         }
 919 #endif
 920                         if ( !(*eip)->bei_e && !((*eip)->bei_state & CACHE_ENTRY_LOADING)) {
 921                                 load = 1;
 922                                 (*eip)->bei_state |= CACHE_ENTRY_LOADING;
 923                         }
 924
 925                         if ( !load ) {
 926                                 /* Clear the uncached state if we are not
 927                                  * loading it, i.e it is already cached or
 928                                  * another thread is currently loading it.
 929                                  */
 930                                 if ( (*eip)->bei_state & CACHE_ENTRY_NOT_CACHED ) {
 931                                         (*eip)->bei_state &= ~CACHE_ENTRY_NOT_CACHED;
 932                                 }
 933                                 flag &= ~ID_NOCACHE;
 934                         }
 935
 936                         if ( flag & ID_LOCKED ) {
 937                                 bdb_cache_entryinfo_unlock( *eip );
 938                                 flag ^= ID_LOCKED;
 939                         }
 940                         rc = bdb_cache_entry_db_lock( bdb, tid, *eip, load, 0, lock );
 941                         if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 942                                 rc = DB_NOTFOUND;
 943                                 bdb_cache_entry_db_unlock( bdb, lock );
 944                         } else if ( rc == 0 ) {
 945                                 if ( load ) {
 946                                         if ( !ep) {
 947                                                 rc = bdb_id2entry( op->o_bd, tid, id, &ep );
 948                                         }
 949                                         if ( rc == 0 ) {
 950                                                 ep->e_private = *eip;
 951 #ifdef BDB_HIER
 952                                                 bdb_fix_dn( ep, 0 );
 953 #endif
 954                                                 (*eip)->bei_e = ep;
 955 #ifdef SLAP_ZONE_ALLOC
 956                                                 (*eip)->bei_zseq = *((ber_len_t *)ep - 2);
 957 #endif
 958                                                 ep = NULL;
 959                                                 bdb_cache_lru_link( bdb, *eip );
 960                                                 if (( flag & ID_NOCACHE ) &&
 961                                                         ( bdb_cache_entryinfo_trylock( *eip ) == 0 )) {
 962                                                         /* Set the cached state only if no other thread
 963                                                          * found the info while we were loading the entry.
 964                                                          */
 965                                                         if ( (*eip)->bei_finders == 1 )
 966                                                                 (*eip)->bei_state |= CACHE_ENTRY_NOT_CACHED;
 967                                                         bdb_cache_entryinfo_unlock( *eip );
 968                                                 }
 969                                         }
 970                                         if ( rc == 0 ) {
 971                                                 /* If we succeeded, downgrade back to a readlock. */
 972                                                 rc = bdb_cache_entry_db_relock( bdb, tid,
 973                                                         *eip, 0, 0, lock );
 974                                         } else {
 975                                                 /* Otherwise, release the lock. */
 976                                                 bdb_cache_entry_db_unlock( bdb, lock );
 977                                         }
 978                                 } else if ( !(*eip)->bei_e ) {
 979                                         /* Some other thread is trying to load the entry,
 980                                          * wait for it to finish.
 981                                          */
 982                                         bdb_cache_entry_db_unlock( bdb, lock );
 983                                         bdb_cache_entryinfo_lock( *eip );
 984                                         flag |= ID_LOCKED;
 985                                         goto load1;
 986 #ifdef BDB_HIER
 987                                 } else {
 988                                         /* Check for subtree renames
 989                                          */
 990                                         rc = bdb_fix_dn( (*eip)->bei_e, 1 );
 991                                         if ( rc ) {
 992                                                 bdb_cache_entry_db_relock( bdb,
 993                                                         tid, *eip, 1, 0, lock );
 994                                                 /* check again in case other modifier did it already */
 995                                                 if ( bdb_fix_dn( (*eip)->bei_e, 1 ) )
 996                                                         rc = bdb_fix_dn( (*eip)->bei_e, 2 );
 997                                                 bdb_cache_entry_db_relock( bdb,
 998                                                         tid, *eip, 0, 0, lock );
 999                                         }
1000 #endif
1001                                 }
1002                         }
1003                         bdb_cache_entryinfo_lock( *eip );
1004                         (*eip)->bei_finders--;
1005                         if ( load )
1006                                 (*eip)->bei_state ^= CACHE_ENTRY_LOADING;
1007                         bdb_cache_entryinfo_unlock( *eip );
1008                 }
1009         }
1010         if ( flag & ID_LOCKED ) {
1011                 bdb_cache_entryinfo_unlock( *eip );
1012         }
1013         if ( ep ) {
1014                 ep->e_private = NULL;
1015 #ifdef SLAP_ZONE_ALLOC
1016                 bdb_entry_return( bdb, ep, (*eip)->bei_zseq );
1017 #else
1018                 bdb_entry_return( ep );
1019 #endif
1020         }
1021         if ( rc == 0 ) {
1022                 int purge = 0;
1023
1024                 if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize ||
1025                         bdb->bi_cache.c_leaves > bdb->bi_cache.c_eimax ) {
1026                         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_count_mutex );
1027                         if ( !bdb->bi_cache.c_purging ) {
1028                                 if ( !( flag & ID_NOCACHE )) {
1029                                         bdb->bi_cache.c_cursize++;
1030                                         if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize ) {
1031                                                 purge = 1;
1032                                                 bdb->bi_cache.c_purging = 1;
1033                                         }
1034                                 } else if ( bdb->bi_cache.c_leaves > bdb->bi_cache.c_eimax ) {
1035                                         purge = 1;
1036                                         bdb->bi_cache.c_purging = 1;
1037                                 }
1038                         }
1039                         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_count_mutex );
1040                 }
1041                 if ( purge )
1042                         bdb_cache_lru_purge( bdb );
1043         }
1044
1045 #ifdef SLAP_ZONE_ALLOC
1046         if (rc == 0 && (*eip)->bei_e) {
1047                 slap_zn_rlock(bdb->bi_cache.c_zctx, (*eip)->bei_e);
1048         }
1049         slap_zh_runlock(bdb->bi_cache.c_zctx);
1050 #endif
1051         return rc;
1052 }
1053
1054 int
1055 bdb_cache_children(
1056         Operation *op,
1057         DB_TXN *txn,
1058         Entry *e )
1059 {
1060         int rc;
1061
1062         if ( BEI(e)->bei_kids ) {
1063                 return 0;
1064         }
1065         if ( BEI(e)->bei_state & CACHE_ENTRY_NO_KIDS ) {
1066                 return DB_NOTFOUND;
1067         }
1068         rc = bdb_dn2id_children( op, txn, e );
1069         if ( rc == DB_NOTFOUND ) {
1070                 BEI(e)->bei_state |= CACHE_ENTRY_NO_KIDS | CACHE_ENTRY_NO_GRANDKIDS;
1071         }
1072         return rc;
1073 }
1074
1075 /* Update the cache after a successful database Add. */
1076 int
1077 bdb_cache_add(
1078         struct bdb_info *bdb,
1079         EntryInfo *eip,
1080         Entry *e,
1081         struct berval *nrdn,
1082         DB_TXN *txn,
1083         DB_LOCK *lock )
1084 {
1085         EntryInfo *new, ei;
1086         int rc, purge = 0;
1087 #ifdef BDB_HIER
1088         struct berval rdn = e->e_name;
1089 #endif
1090
1091         ei.bei_id = e->e_id;
1092         ei.bei_parent = eip;
1093         ei.bei_nrdn = *nrdn;
1094         ei.bei_lockpad = 0;
1095
1096         /* Lock this entry so that bdb_add can run to completion.
1097          * It can only fail if BDB has run out of lock resources.
1098          */
1099         rc = bdb_cache_entry_db_lock( bdb, txn, &ei, 0, 0, lock );
1100         if ( rc ) {
1101                 bdb_cache_entryinfo_unlock( eip );
1102                 return rc;
1103         }
1104
1105 #ifdef BDB_HIER
1106         if ( nrdn->bv_len != e->e_nname.bv_len ) {
1107                 char *ptr = ber_bvchr( &rdn, ',' );
1108                 assert( ptr != NULL );
1109                 rdn.bv_len = ptr - rdn.bv_val;
1110         }
1111         ber_dupbv( &ei.bei_rdn, &rdn );
1112         if ( eip->bei_dkids ) eip->bei_dkids++;
1113 #endif
1114
1115         rc = bdb_entryinfo_add_internal( bdb, &ei, &new );
1116         /* bdb_csn_commit can cause this when adding the database root entry */
1117         if ( new->bei_e ) {
1118                 new->bei_e->e_private = NULL;
1119 #ifdef SLAP_ZONE_ALLOC
1120                 bdb_entry_return( bdb, new->bei_e, new->bei_zseq );
1121 #else
1122                 bdb_entry_return( new->bei_e );
1123 #endif
1124         }
1125         new->bei_e = e;
1126         e->e_private = new;
1127         new->bei_state |= CACHE_ENTRY_NO_KIDS | CACHE_ENTRY_NO_GRANDKIDS;
1128         eip->bei_state &= ~CACHE_ENTRY_NO_KIDS;
1129         if (eip->bei_parent) {
1130                 eip->bei_parent->bei_state &= ~CACHE_ENTRY_NO_GRANDKIDS;
1131         }
1132         bdb_cache_entryinfo_unlock( eip );
1133
1134         ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
1135         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_count_mutex );
1136         ++bdb->bi_cache.c_cursize;
1137         if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize &&
1138                 !bdb->bi_cache.c_purging ) {
1139                 purge = 1;
1140                 bdb->bi_cache.c_purging = 1;
1141         }
1142         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_count_mutex );
1143
1144         bdb_cache_lru_link( bdb, new );
1145
1146         if ( purge )
1147                 bdb_cache_lru_purge( bdb );
1148
1149         return rc;
1150 }
1151
1152 int
1153 bdb_cache_modify(
1154         struct bdb_info *bdb,
1155         Entry *e,
1156         Attribute *newAttrs,
1157         DB_TXN *txn,
1158         DB_LOCK *lock )
1159 {
1160         EntryInfo *ei = BEI(e);
1161         int rc;
1162         /* Get write lock on data */
1163         rc = bdb_cache_entry_db_relock( bdb, txn, ei, 1, 0, lock );
1164
1165         /* If we've done repeated mods on a cached entry, then e_attrs
1166          * is no longer contiguous with the entry, and must be freed.
1167          */
1168         if ( ! rc ) {
1169                 if ( (void *)e->e_attrs != (void *)(e+1) ) {
1170                         attrs_free( e->e_attrs );
1171                 }
1172                 e->e_attrs = newAttrs;
1173         }
1174         return rc;
1175 }
1176
1177 /*
1178  * Change the rdn in the entryinfo. Also move to a new parent if needed.
1179  */
1180 int
1181 bdb_cache_modrdn(
1182         struct bdb_info *bdb,
1183         Entry *e,
1184         struct berval *nrdn,
1185         Entry *new,
1186         EntryInfo *ein,
1187         DB_TXN *txn,
1188         DB_LOCK *lock )
1189 {
1190         EntryInfo *ei = BEI(e), *pei;
1191         int rc;
1192 #ifdef BDB_HIER
1193         struct berval rdn;
1194 #endif
1195
1196         /* Get write lock on data */
1197         rc =  bdb_cache_entry_db_relock( bdb, txn, ei, 1, 0, lock );
1198         if ( rc ) return rc;
1199
1200         /* If we've done repeated mods on a cached entry, then e_attrs
1201          * is no longer contiguous with the entry, and must be freed.
1202          */
1203         if ( (void *)e->e_attrs != (void *)(e+1) ) {
1204                 attrs_free( e->e_attrs );
1205         }
1206         e->e_attrs = new->e_attrs;
1207         if( e->e_nname.bv_val < e->e_bv.bv_val ||
1208                 e->e_nname.bv_val > e->e_bv.bv_val + e->e_bv.bv_len )
1209         {
1210                 ch_free(e->e_name.bv_val);
1211                 ch_free(e->e_nname.bv_val);
1212         }
1213         e->e_name = new->e_name;
1214         e->e_nname = new->e_nname;
1215
1216         /* Lock the parent's kids AVL tree */
1217         pei = ei->bei_parent;
1218         bdb_cache_entryinfo_lock( pei );
1219         avl_delete( &pei->bei_kids, (caddr_t) ei, bdb_rdn_cmp );
1220         free( ei->bei_nrdn.bv_val );
1221         ber_dupbv( &ei->bei_nrdn, nrdn );
1222
1223 #ifdef BDB_HIER
1224         free( ei->bei_rdn.bv_val );
1225
1226         rdn = e->e_name;
1227         if ( nrdn->bv_len != e->e_nname.bv_len ) {
1228                 char *ptr = ber_bvchr(&rdn, ',');
1229                 assert( ptr != NULL );
1230                 rdn.bv_len = ptr - rdn.bv_val;
1231         }
1232         ber_dupbv( &ei->bei_rdn, &rdn );
1233
1234         /* If new parent, decrement kid counts */
1235         if ( ein ) {
1236                 pei->bei_ckids--;
1237                 if ( pei->bei_dkids ) {
1238                         pei->bei_dkids--;
1239                         if ( pei->bei_dkids < 2 )
1240                                 pei->bei_state |= CACHE_ENTRY_NO_KIDS | CACHE_ENTRY_NO_GRANDKIDS;
1241                 }
1242         }
1243 #endif
1244
1245         if (!ein) {
1246                 ein = ei->bei_parent;
1247         } else {
1248                 ei->bei_parent = ein;
1249                 bdb_cache_entryinfo_unlock( pei );
1250                 bdb_cache_entryinfo_lock( ein );
1251
1252                 /* new parent now has kids */
1253                 if ( ein->bei_state & CACHE_ENTRY_NO_KIDS )
1254                         ein->bei_state ^= CACHE_ENTRY_NO_KIDS;
1255                 /* grandparent has grandkids */
1256                 if ( ein->bei_parent )
1257                         ein->bei_parent->bei_state &= ~CACHE_ENTRY_NO_GRANDKIDS;
1258 #ifdef BDB_HIER
1259                 /* parent might now have grandkids */
1260                 if ( ein->bei_state & CACHE_ENTRY_NO_GRANDKIDS &&
1261                         !(ei->bei_state & CACHE_ENTRY_NO_KIDS))
1262                         ein->bei_state ^= CACHE_ENTRY_NO_GRANDKIDS;
1263
1264                 ein->bei_ckids++;
1265                 if ( ein->bei_dkids ) ein->bei_dkids++;
1266 #endif
1267         }
1268
1269 #ifdef BDB_HIER
1270         /* Record the generation number of this change */
1271         ldap_pvt_thread_mutex_lock( &bdb->bi_modrdns_mutex );
1272         bdb->bi_modrdns++;
1273         ei->bei_modrdns = bdb->bi_modrdns;
1274         ldap_pvt_thread_mutex_unlock( &bdb->bi_modrdns_mutex );
1275 #endif
1276
1277         avl_insert( &ein->bei_kids, ei, bdb_rdn_cmp, avl_dup_error );
1278         bdb_cache_entryinfo_unlock( ein );
1279         return rc;
1280 }
1281 /*
1282  * cache_delete - delete the entry e from the cache.
1283  *
1284  * returns:     0       e was deleted ok
1285  *              1       e was not in the cache
1286  *              -1      something bad happened
1287  */
1288 int
1289 bdb_cache_delete(
1290         struct bdb_info *bdb,
1291     Entry               *e,
1292     DB_TXN *txn,
1293     DB_LOCK     *lock )
1294 {
1295         EntryInfo *ei = BEI(e);
1296         int     rc;
1297
1298         assert( e->e_private != NULL );
1299
1300         /* Lock the entry's info */
1301         bdb_cache_entryinfo_lock( ei );
1302
1303         /* Set this early, warn off any queriers */
1304         ei->bei_state |= CACHE_ENTRY_DELETED;
1305
1306         bdb_cache_entryinfo_unlock( ei );
1307
1308         /* Get write lock on the data */
1309         rc = bdb_cache_entry_db_relock( bdb, txn, ei, 1, 0, lock );
1310         if ( rc ) {
1311                 /* couldn't lock, undo and give up */
1312                 ei->bei_state ^= CACHE_ENTRY_DELETED;
1313                 return rc;
1314         }
1315
1316         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_delete( %ld )\n",
1317                 e->e_id, 0, 0 );
1318
1319         /* set lru mutex */
1320         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.c_lru_mutex );
1321
1322         rc = bdb_cache_delete_internal( &bdb->bi_cache, e->e_private, 1 );
1323
1324         /* free lru mutex */
1325         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.c_lru_mutex );
1326
1327         return( rc );
1328 }
1329
1330 void
1331 bdb_cache_delete_cleanup(
1332         Cache *cache,
1333         EntryInfo *ei )
1334 {
1335         /* Enter with ei locked */
1336
1337         if ( ei->bei_e ) {
1338                 ei->bei_e->e_private = NULL;
1339 #ifdef SLAP_ZONE_ALLOC
1340                 bdb_entry_return( ei->bei_bdb, ei->bei_e, ei->bei_zseq );
1341 #else
1342                 bdb_entry_return( ei->bei_e );
1343 #endif
1344                 ei->bei_e = NULL;
1345         }
1346
1347         bdb_cache_entryinfo_free( cache, ei );
1348         bdb_cache_entryinfo_unlock( ei );
1349 }
1350
1351 static int
1352 bdb_cache_delete_internal(
1353     Cache       *cache,
1354     EntryInfo           *e,
1355     int         decr )
1356 {
1357         int rc = 0;     /* return code */
1358         int decr_leaf = 0;
1359
1360         /* Lock the parent's kids tree */
1361         bdb_cache_entryinfo_lock( e->bei_parent );
1362
1363 #ifdef BDB_HIER
1364         e->bei_parent->bei_ckids--;
1365         if ( decr && e->bei_parent->bei_dkids ) e->bei_parent->bei_dkids--;
1366 #endif
1367         /* dn tree */
1368         if ( avl_delete( &e->bei_parent->bei_kids, (caddr_t) e, bdb_rdn_cmp )
1369                 == NULL )
1370         {
1371                 rc = -1;
1372         }
1373         if ( e->bei_parent->bei_kids )
1374                 decr_leaf = 1;
1375
1376         bdb_cache_entryinfo_unlock( e->bei_parent );
1377
1378         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
1379         /* id tree */
1380         if ( avl_delete( &cache->c_idtree, (caddr_t) e, bdb_id_cmp )) {
1381                 cache->c_eiused--;
1382                 if ( decr_leaf )
1383                         cache->c_leaves--;
1384         } else {
1385                 rc = -1;
1386         }
1387         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
1388
1389         if ( rc == 0 ){
1390                 /* lru */
1391                 LRU_DEL( cache, e );
1392
1393                 if ( e->bei_e ) {
1394                         ldap_pvt_thread_mutex_lock( &cache->c_count_mutex );
1395                         cache->c_cursize--;
1396                         ldap_pvt_thread_mutex_unlock( &cache->c_count_mutex );
1397                 }
1398         }
1399
1400         return( rc );
1401 }
1402
1403 static void
1404 bdb_entryinfo_release( void *data )
1405 {
1406         EntryInfo *ei = (EntryInfo *)data;
1407         if ( ei->bei_kids ) {
1408                 avl_free( ei->bei_kids, NULL );
1409         }
1410         if ( ei->bei_e ) {
1411                 ei->bei_e->e_private = NULL;
1412 #ifdef SLAP_ZONE_ALLOC
1413                 bdb_entry_return( ei->bei_bdb, ei->bei_e, ei->bei_zseq );
1414 #else
1415                 bdb_entry_return( ei->bei_e );
1416 #endif
1417         }
1418         bdb_cache_entryinfo_destroy( ei );
1419 }
1420
1421 void
1422 bdb_cache_release_all( Cache *cache )
1423 {
1424         /* set cache write lock */
1425         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
1426         /* set lru mutex */
1427         ldap_pvt_thread_mutex_lock( &cache->c_lru_mutex );
1428
1429         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_release_all\n", 0, 0, 0 );
1430
1431         avl_free( cache->c_dntree.bei_kids, NULL );
1432         avl_free( cache->c_idtree, bdb_entryinfo_release );
1433         for (;cache->c_eifree;cache->c_eifree = cache->c_lruhead) {
1434                 cache->c_lruhead = cache->c_eifree->bei_lrunext;
1435                 bdb_cache_entryinfo_destroy(cache->c_eifree);
1436         }
1437         cache->c_cursize = 0;
1438         cache->c_eiused = 0;
1439         cache->c_leaves = 0;
1440         cache->c_idtree = NULL;
1441         cache->c_lruhead = NULL;
1442         cache->c_lrutail = NULL;
1443         cache->c_dntree.bei_kids = NULL;
1444
1445         /* free lru mutex */
1446         ldap_pvt_thread_mutex_unlock( &cache->c_lru_mutex );
1447         /* free cache write lock */
1448         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
1449 }
1450
1451 #ifdef LDAP_DEBUG
1452 #ifdef SLAPD_UNUSED
1453 static void
1454 bdb_lru_print( Cache *cache )
1455 {
1456         EntryInfo       *e;
1457
1458         fprintf( stderr, "LRU circle head: %p\n", (void *) cache->c_lruhead );
1459         fprintf( stderr, "LRU circle (tail forward):\n" );
1460         for ( e = cache->c_lrutail; ; ) {
1461                 fprintf( stderr, "\t%p, %p id %ld rdn \"%s\"\n",
1462                         (void *) e, (void *) e->bei_e, e->bei_id, e->bei_nrdn.bv_val );
1463                 e = e->bei_lrunext;
1464                 if ( e == cache->c_lrutail )
1465                         break;
1466         }
1467         fprintf( stderr, "LRU circle (tail backward):\n" );
1468         for ( e = cache->c_lrutail; ; ) {
1469                 fprintf( stderr, "\t%p, %p id %ld rdn \"%s\"\n",
1470                         (void *) e, (void *) e->bei_e, e->bei_id, e->bei_nrdn.bv_val );
1471                 e = e->bei_lruprev;
1472                 if ( e == cache->c_lrutail )
1473                         break;
1474         }
1475 }
1476 #endif
1477 #endif
1478
1479 static void
1480 bdb_reader_free( void *key, void *data )
1481 {
1482         /* DB_ENV *env = key; */
1483         DB_TXN *txn = data;
1484
1485         if ( txn ) TXN_ABORT( txn );
1486 }
1487
1488 /* free up any keys used by the main thread */
1489 void
1490 bdb_reader_flush( DB_ENV *env )
1491 {
1492         void *data;
1493         void *ctx = ldap_pvt_thread_pool_context();
1494
1495         if ( !ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
1496                 ldap_pvt_thread_pool_setkey( ctx, env, NULL, 0, NULL, NULL );
1497                 bdb_reader_free( env, data );
1498         }
1499 }
1500
1501 int
1502 bdb_reader_get( Operation *op, DB_ENV *env, DB_TXN **txn )
1503 {
1504         int i, rc;
1505         void *data;
1506         void *ctx;
1507
1508         if ( !env || !txn ) return -1;
1509
1510         /* If no op was provided, try to find the ctx anyway... */
1511         if ( op ) {
1512                 ctx = op->o_threadctx;
1513         } else {
1514                 ctx = ldap_pvt_thread_pool_context();
1515         }
1516
1517         /* Shouldn't happen unless we're single-threaded */
1518         if ( !ctx ) {
1519                 *txn = NULL;
1520                 return 0;
1521         }
1522
1523         if ( ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
1524                 for ( i=0, rc=1; rc != 0 && i<4; i++ ) {
1525                         rc = TXN_BEGIN( env, NULL, txn, DB_READ_COMMITTED );
1526                         if (rc) ldap_pvt_thread_yield();
1527                 }
1528                 if ( rc != 0) {
1529                         return rc;
1530                 }
1531                 data = *txn;
1532                 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, env,
1533                         data, bdb_reader_free, NULL, NULL ) ) ) {
1534                         TXN_ABORT( *txn );
1535                         Debug( LDAP_DEBUG_ANY, "bdb_reader_get: err %s(%d)\n",
1536                                 db_strerror(rc), rc, 0 );
1537
1538                         return rc;
1539                 }
1540         } else {
1541                 *txn = data;
1542         }
1543         return 0;
1544 }