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