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 /*
   4  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #include "portable.h"
   9
  10 #include <stdio.h>
  11
  12 #include <ac/errno.h>
  13 #include <ac/string.h>
  14 #include <ac/socket.h>
  15
  16 #include "slap.h"
  17
  18 #include "back-bdb.h"
  19
  20 static int      bdb_cache_delete_internal(Cache *cache, EntryInfo *e);
  21 #ifdef LDAP_DEBUG
  22 static void     bdb_lru_print(Cache *cache);
  23 #endif
  24
  25 static EntryInfo *
  26 bdb_cache_entryinfo_new( )
  27 {
  28         EntryInfo *ei;
  29
  30         ei = ch_calloc(1, sizeof(struct bdb_entry_info));
  31         ldap_pvt_thread_mutex_init( &ei->bei_kids_mutex );
  32
  33         return ei;
  34 }
  35
  36 /* Atomically release and reacquire a lock */
  37 int
  38 bdb_cache_entry_db_relock(
  39         DB_ENV *env,
  40         u_int32_t locker,
  41         EntryInfo *ei,
  42         int rw,
  43         int tryOnly,
  44         DB_LOCK *lock )
  45 {
  46 #ifdef NO_THREADS
  47         return 0;
  48 #else
  49         int     rc;
  50         DBT     lockobj;
  51         DB_LOCKREQ list[2];
  52
  53         if ( !lock ) return 0;
  54
  55         lockobj.data = ei;
  56         lockobj.size = sizeof(ei->bei_parent) + sizeof(ei->bei_id);
  57
  58         list[0].op = DB_LOCK_PUT;
  59         list[0].lock = *lock;
  60         list[1].op = DB_LOCK_GET;
  61         list[1].lock = *lock;
  62         list[1].mode = rw ? DB_LOCK_WRITE : DB_LOCK_READ;
  63         list[1].obj = &lockobj;
  64         rc = env->lock_vec(env, locker, tryOnly ? DB_LOCK_NOWAIT : 0,
  65                 list, 2, NULL );
  66
  67         if (rc) {
  68 #ifdef NEW_LOGGING
  69                 LDAP_LOG( CACHE, DETAIL1,
  70                         "bdb_cache_entry_db_relock: entry %ld, rw %d, rc %d\n",
  71                         ei->bei_id, rw, rc );
  72 #else
  73                 Debug( LDAP_DEBUG_TRACE,
  74                         "bdb_cache_entry_db_relock: entry %ld, rw %d, rc %d\n",
  75                         ei->bei_id, rw, rc );
  76 #endif
  77         } else {
  78                 *lock = list[1].lock;
  79         }
  80         return rc;
  81 #endif
  82 }
  83 static int
  84 bdb_cache_entry_db_lock
  85 ( DB_ENV *env, u_int32_t locker, EntryInfo *ei, int rw, int tryOnly, DB_LOCK *lock )
  86 {
  87 #ifdef NO_THREADS
  88         return 0;
  89 #else
  90         int       rc;
  91         DBT       lockobj;
  92         int       db_rw;
  93
  94         if ( !lock ) return 0;
  95
  96         if (rw)
  97                 db_rw = DB_LOCK_WRITE;
  98         else
  99                 db_rw = DB_LOCK_READ;
 100
 101         lockobj.data = ei;
 102         lockobj.size = sizeof(ei->bei_parent) + sizeof(ei->bei_id);
 103
 104         rc = LOCK_GET(env, locker, tryOnly ? DB_LOCK_NOWAIT : 0,
 105                                         &lockobj, db_rw, lock);
 106         if (rc) {
 107 #ifdef NEW_LOGGING
 108                 LDAP_LOG( CACHE, DETAIL1,
 109                         "bdb_cache_entry_db_lock: entry %ld, rw %d, rc %d\n",
 110                         ei->bei_id, rw, rc );
 111 #else
 112                 Debug( LDAP_DEBUG_TRACE,
 113                         "bdb_cache_entry_db_lock: entry %ld, rw %d, rc %d\n",
 114                         ei->bei_id, rw, rc );
 115 #endif
 116         }
 117         return rc;
 118 #endif /* NO_THREADS */
 119 }
 120
 121 int
 122 bdb_cache_entry_db_unlock
 123 ( DB_ENV *env, DB_LOCK *lock )
 124 {
 125 #ifdef NO_THREADS
 126         return 0;
 127 #else
 128         int rc;
 129
 130         rc = LOCK_PUT ( env, lock );
 131         return rc;
 132 #endif
 133 }
 134
 135 static int
 136 bdb_cache_entryinfo_destroy( EntryInfo *e )
 137 {
 138         ldap_pvt_thread_mutex_destroy( &e->bei_kids_mutex );
 139         free( e->bei_nrdn.bv_val );
 140 #ifdef BDB_HIER
 141         free( e->bei_rdn.bv_val );
 142 #endif
 143         free( e );
 144         return 0;
 145 }
 146
 147 #define LRU_DELETE( cache, ei ) do { \
 148         if ( (ei)->bei_lruprev != NULL ) { \
 149                 (ei)->bei_lruprev->bei_lrunext = (ei)->bei_lrunext; \
 150         } else { \
 151                 (cache)->c_lruhead = (ei)->bei_lrunext; \
 152         } \
 153         if ( (ei)->bei_lrunext != NULL ) { \
 154                 (ei)->bei_lrunext->bei_lruprev = (ei)->bei_lruprev; \
 155         } else { \
 156                 (cache)->c_lrutail = (ei)->bei_lruprev; \
 157         } \
 158 } while(0)
 159
 160 #define LRU_ADD( cache, ei ) do { \
 161         (ei)->bei_lrunext = (cache)->c_lruhead; \
 162         if ( (ei)->bei_lrunext != NULL ) { \
 163                 (ei)->bei_lrunext->bei_lruprev = (ei); \
 164         } \
 165         (cache)->c_lruhead = (ei); \
 166         (ei)->bei_lruprev = NULL; \
 167         if ( (cache)->c_lrutail == NULL ) { \
 168                 (cache)->c_lrutail = (ei); \
 169         } \
 170 } while(0)
 171
 172 /* Do a length-ordered sort on normalized RDNs */
 173 static int
 174 bdb_rdn_cmp( const void *v_e1, const void *v_e2 )
 175 {
 176         const EntryInfo *e1 = v_e1, *e2 = v_e2;
 177         int rc = e1->bei_nrdn.bv_len - e2->bei_nrdn.bv_len;
 178         if (rc == 0) rc = strncmp( e1->bei_nrdn.bv_val, e2->bei_nrdn.bv_val,
 179                 e1->bei_nrdn.bv_len );
 180         return rc;
 181 }
 182
 183 static int
 184 bdb_id_cmp( const void *v_e1, const void *v_e2 )
 185 {
 186         const EntryInfo *e1 = v_e1, *e2 = v_e2;
 187         return e1->bei_id - e2->bei_id;
 188 }
 189
 190 /* Create an entryinfo in the cache. Caller must release the locks later.
 191  */
 192 static int
 193 bdb_entryinfo_add_internal(
 194         struct bdb_info *bdb,
 195         EntryInfo *ei,
 196         EntryInfo **res
 197 )
 198 {
 199         EntryInfo *ei2 = NULL;
 200
 201         *res = NULL;
 202
 203         ei2 = bdb_cache_entryinfo_new();
 204
 205         ldap_pvt_thread_rdwr_wlock( &bdb->bi_cache.c_rwlock );
 206         bdb_cache_entryinfo_lock( ei->bei_parent );
 207
 208         ei2->bei_id = ei->bei_id;
 209         ei2->bei_parent = ei->bei_parent;
 210 #ifdef BDB_HIER
 211         ei2->bei_rdn = ei->bei_rdn;
 212 #endif
 213
 214         /* Add to cache ID tree */
 215         if (avl_insert( &bdb->bi_cache.c_idtree, ei2, bdb_id_cmp, avl_dup_error )) {
 216                 EntryInfo *eix;
 217                 eix = avl_find( bdb->bi_cache.c_idtree, ei2, bdb_id_cmp );
 218                 bdb_cache_entryinfo_destroy( ei2 );
 219                 ei2 = eix;
 220 #ifdef BDB_HIER
 221                 /* It got freed above because its value was
 222                  * assigned to ei2.
 223                  */
 224                 ei->bei_rdn.bv_val = NULL;
 225 #endif
 226         } else {
 227                 ber_dupbv( &ei2->bei_nrdn, &ei->bei_nrdn );
 228                 avl_insert( &ei->bei_parent->bei_kids, ei2, bdb_rdn_cmp,
 229                         avl_dup_error );
 230 #ifdef BDB_HIER
 231                 ei->bei_parent->bei_ckids++;
 232 #endif
 233         }
 234
 235         *res = ei2;
 236         return 0;
 237 }
 238
 239 /* Find the EntryInfo for the requested DN. If the DN cannot be found, return
 240  * the info for its closest ancestor. *res should be NULL to process a
 241  * complete DN starting from the tree root. Otherwise *res must be the
 242  * immediate parent of the requested DN, and only the RDN will be searched.
 243  * The EntryInfo is locked upon return and must be unlocked by the caller.
 244  */
 245 int
 246 bdb_cache_find_ndn(
 247         Operation       *op,
 248         DB_TXN          *txn,
 249         struct berval   *ndn,
 250         EntryInfo       **res
 251 )
 252 {
 253         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 254         EntryInfo       ei, *eip, *ei2;
 255         int rc = 0;
 256         char *ptr;
 257
 258         /* this function is always called with normalized DN */
 259         if ( *res ) {
 260                 /* we're doing a onelevel search for an RDN */
 261                 ei.bei_nrdn.bv_val = ndn->bv_val;
 262                 ei.bei_nrdn.bv_len = dn_rdnlen( op->o_bd, ndn );
 263                 eip = *res;
 264         } else {
 265                 /* we're searching a full DN from the root */
 266                 ptr = ndn->bv_val + ndn->bv_len - op->o_bd->be_nsuffix[0].bv_len;
 267                 ei.bei_nrdn.bv_val = ptr;
 268                 ei.bei_nrdn.bv_len = op->o_bd->be_nsuffix[0].bv_len;
 269                 eip = &bdb->bi_cache.c_dntree;
 270         }
 271
 272         for ( bdb_cache_entryinfo_lock( eip ); eip; ) {
 273                 ei.bei_parent = eip;
 274                 ei2 = (EntryInfo *)avl_find( eip->bei_kids, &ei, bdb_rdn_cmp );
 275                 if ( !ei2 ) {
 276                         int len = ei.bei_nrdn.bv_len;
 277
 278                         ei.bei_nrdn.bv_len = ndn->bv_len - (ei.bei_nrdn.bv_val - ndn->bv_val);
 279                         bdb_cache_entryinfo_unlock( eip );
 280
 281                         rc = bdb_dn2id( op, txn, &ei.bei_nrdn, &ei );
 282                         if (rc) {
 283                                 bdb_cache_entryinfo_lock( eip );
 284                                 *res = eip;
 285                                 return rc;
 286                         }
 287
 288                         /* DN exists but needs to be added to cache */
 289                         ei.bei_nrdn.bv_len = len;
 290                         rc = bdb_entryinfo_add_internal( bdb, &ei, &ei2 );
 291                         /* add_internal left eip and c_rwlock locked */
 292                         ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 293                         if ( rc ) {
 294                                 *res = eip;
 295                                 return rc;
 296                         }
 297                 } else if ( ei2->bei_state & CACHE_ENTRY_DELETED ) {
 298                         /* In the midst of deleting? Give it a chance to
 299                          * complete.
 300                          */
 301                         bdb_cache_entryinfo_unlock( eip );
 302                         ldap_pvt_thread_yield();
 303                         bdb_cache_entryinfo_lock( eip );
 304                         *res = eip;
 305                         return DB_NOTFOUND;
 306                 }
 307                 bdb_cache_entryinfo_unlock( eip );
 308                 bdb_cache_entryinfo_lock( ei2 );
 309
 310                 eip = ei2;
 311
 312                 /* Advance to next lower RDN */
 313                 for (ptr = ei.bei_nrdn.bv_val - 2; ptr > ndn->bv_val
 314                         && !DN_SEPARATOR(*ptr); ptr--);
 315                 if ( ptr >= ndn->bv_val ) {
 316                         if (DN_SEPARATOR(*ptr)) ptr++;
 317                         ei.bei_nrdn.bv_len = ei.bei_nrdn.bv_val - ptr - 1;
 318                         ei.bei_nrdn.bv_val = ptr;
 319                 }
 320                 if ( ptr < ndn->bv_val ) {
 321                         *res = eip;
 322                         break;
 323                 }
 324         }
 325
 326         return rc;
 327 }
 328
 329 #ifdef BDB_HIER
 330 /* Walk up the tree from a child node, looking for an ID that's already
 331  * been linked into the cache.
 332  */
 333 static int
 334 hdb_cache_find_parent(
 335         Operation *op,
 336         DB_TXN *txn,
 337         ID id,
 338         EntryInfo **res
 339 )
 340 {
 341         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 342         EntryInfo ei, eip, *ei2 = NULL, *ein = NULL, *eir = NULL;
 343         char ndn[SLAP_LDAPDN_MAXLEN];
 344         ID parent;
 345         int rc;
 346         int addlru = 1;
 347
 348         ei.bei_id = id;
 349         ei.bei_kids = NULL;
 350
 351         for (;;) {
 352                 rc = hdb_dn2id_parent( op, txn, &ei, &eip.bei_id );
 353                 if ( rc ) break;
 354
 355                 /* Save the previous node, if any */
 356                 ei2 = ein;
 357
 358                 /* Create a new node for the current ID */
 359                 ein = bdb_cache_entryinfo_new();
 360                 ein->bei_id = ei.bei_id;
 361                 ein->bei_kids = ei.bei_kids;
 362                 ein->bei_nrdn = ei.bei_nrdn;
 363                 ein->bei_rdn = ei.bei_rdn;
 364
 365                 /* This node is not fully connected yet */
 366                 ein->bei_state = CACHE_ENTRY_NOT_LINKED;
 367
 368                 /* Insert this node into the ID tree */
 369                 ldap_pvt_thread_rdwr_wlock( &bdb->bi_cache.c_rwlock );
 370                 if ( avl_insert( &bdb->bi_cache.c_idtree, (caddr_t)ein,
 371                         bdb_id_cmp, avl_dup_error ) ) {
 372
 373                         /* Someone else created this node just before us.
 374                          * Free our new copy and use the existing one.
 375                          */
 376                         bdb_cache_entryinfo_destroy( ein );
 377                         ein = (EntryInfo *)avl_find( bdb->bi_cache.c_idtree,
 378                                 (caddr_t) &ei, bdb_id_cmp );
 379
 380                         /* Link in any kids we've already processed */
 381                         if ( ei2 ) {
 382                                 bdb_cache_entryinfo_lock( ein );
 383                                 avl_insert( &ein->bei_kids, (caddr_t)ei2,
 384                                         bdb_rdn_cmp, avl_dup_error );
 385                                 bdb_cache_entryinfo_unlock( ein );
 386                         }
 387
 388                         if ( !eir ) {
 389                                 addlru = 0;
 390                         }
 391                 }
 392
 393                 /* If this is the first time, save this node
 394                  * to be returned later.
 395                  */
 396                 if ( eir == NULL ) eir = ein;
 397
 398                 /* If there was a previous node, link it to this one */
 399                 if ( ei2 ) ei2->bei_parent = ein;
 400
 401                 /* Look for this node's parent */
 402                 if ( eip.bei_id ) {
 403                         ei2 = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 404                                         (caddr_t) &eip, bdb_id_cmp );
 405                 } else {
 406                         ei2 = &bdb->bi_cache.c_dntree;
 407                 }
 408                 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 409
 410                 /* Got the parent, link in and we're done. */
 411                 if ( ei2 ) {
 412                         bdb_cache_entryinfo_lock( ei2 );
 413                         ein->bei_parent = ei2;
 414                         avl_insert( &ei2->bei_kids, (caddr_t)ein, bdb_rdn_cmp,
 415                                 avl_dup_error);
 416                         bdb_cache_entryinfo_unlock( ei2 );
 417                         bdb_cache_entryinfo_lock( eir );
 418
 419                         /* Reset all the state info */
 420                         for (ein = eir; ein != ei2; ein=ein->bei_parent)
 421                                 ein->bei_state &= ~CACHE_ENTRY_NOT_LINKED;
 422                         *res = eir;
 423                         break;
 424                 }
 425                 ei.bei_kids = NULL;
 426                 ei.bei_id = eip.bei_id;
 427                 avl_insert( &ei.bei_kids, (caddr_t)ein, bdb_rdn_cmp,
 428                         avl_dup_error );
 429         }
 430         return rc;
 431 }
 432
 433 int hdb_entryinfo_load(
 434         struct bdb_info *bdb,
 435         EntryInfo *ei,
 436         EntryInfo **res )
 437 {
 438         EntryInfo *ei2;
 439         int rc;
 440
 441         bdb_cache_entryinfo_lock( ei->bei_parent );
 442         ei2 = (EntryInfo *)avl_find( ei->bei_parent->bei_kids, ei, bdb_rdn_cmp );
 443         bdb_cache_entryinfo_unlock( ei->bei_parent );
 444         if ( !ei2 ) {
 445                 rc = bdb_entryinfo_add_internal( bdb, ei, res );
 446                 bdb_cache_entryinfo_unlock( ei->bei_parent );
 447                 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 448         } else {
 449                 *res = ei2;
 450                 free( ei->bei_rdn.bv_val );
 451                 return 0;
 452         }
 453         return rc;
 454 }
 455 #endif
 456
 457 /* caller must have lru_mutex locked. mutex
 458  * will be unlocked on return.
 459  */
 460 static void
 461 bdb_cache_lru_add(
 462         struct bdb_info *bdb,
 463         u_int32_t       locker,
 464         EntryInfo *ei
 465 )
 466 {
 467         DB_LOCK         lock;
 468
 469         /* See if we're above the cache size limit */
 470         if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize ) {
 471                 EntryInfo *elru, *elprev;
 472                 int i = 0;
 473
 474                 /* Look for an unused entry to remove */
 475                 for (elru = bdb->bi_cache.c_lrutail; elru; elru = elprev, i++ ) {
 476                         elprev = elru->bei_lruprev;
 477
 478                         /* Too many probes, not enough idle, give up */
 479                         if (i > 10) break;
 480
 481                         /* If we can successfully writelock it, then
 482                          * the object is idle.
 483                          */
 484                         if ( bdb_cache_entry_db_lock( bdb->bi_dbenv, locker, elru, 1, 1,
 485                                 &lock ) == 0 ) {
 486                                 /* If there's no entry, or this node is in
 487                                  * the process of linking into the cache,
 488                                  * skip it.
 489                                  */
 490                                 if ( !elru->bei_e || (elru->bei_state & CACHE_ENTRY_NOT_LINKED) ) {
 491                                         bdb_cache_entry_db_unlock( bdb->bi_dbenv, &lock );
 492                                         continue;
 493                                 }
 494                                 LRU_DELETE( &bdb->bi_cache, elru );
 495                                 elru->bei_e->e_private = NULL;
 496                                 bdb_entry_return( elru->bei_e );
 497                                 elru->bei_e = NULL;
 498                                 bdb_cache_entry_db_unlock( bdb->bi_dbenv, &lock );
 499                                 --bdb->bi_cache.c_cursize;
 500                                 if (bdb->bi_cache.c_cursize < bdb->bi_cache.c_maxsize)
 501                                         break;
 502                         }
 503                 }
 504         }
 505         LRU_ADD( &bdb->bi_cache, ei );
 506         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.lru_mutex );
 507 }
 508
 509 /*
 510  * cache_find_id - find an entry in the cache, given id.
 511  * The entry is locked for Read upon return. Call with islocked TRUE if
 512  * the supplied *eip was already locked.
 513  */
 514
 515 int
 516 bdb_cache_find_id(
 517         Operation *op,
 518         DB_TXN  *tid,
 519         ID                              id,
 520         EntryInfo       **eip,
 521         int             islocked,
 522         u_int32_t       locker,
 523         DB_LOCK         *lock
 524 )
 525 {
 526         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 527         Entry   *ep = NULL;
 528         int     rc = 0;
 529         EntryInfo ei;
 530         int lru_del = 0;
 531
 532         ei.bei_id = id;
 533
 534         /* If we weren't given any info, see if we have it already cached */
 535         if ( !*eip ) {
 536 again:          ldap_pvt_thread_rdwr_rlock( &bdb->bi_cache.c_rwlock );
 537                 *eip = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
 538                                         (caddr_t) &ei, bdb_id_cmp );
 539                 if ( *eip ) {
 540                         /* If the lock attempt fails, the info is in use */
 541                         if ( ldap_pvt_thread_mutex_trylock(
 542                                         &(*eip)->bei_kids_mutex )) {
 543                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 544                                 /* If this node is being deleted, treat
 545                                  * as if the delete has already finished
 546                                  */
 547                                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 548                                         return DB_NOTFOUND;
 549                                 }
 550                                 /* otherwise, wait for the info to free up */
 551                                 ldap_pvt_thread_yield();
 552                                 goto again;
 553                         }
 554                         /* If this info isn't hooked up to its parent yet,
 555                          * unlock and wait for it to be fully initialized
 556                          */
 557                         if ( (*eip)->bei_state & CACHE_ENTRY_NOT_LINKED ) {
 558                                 bdb_cache_entryinfo_unlock( *eip );
 559                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 560                                 ldap_pvt_thread_yield();
 561                                 goto again;
 562                         }
 563                         islocked = 1;
 564                 }
 565                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
 566         }
 567
 568         /* See if the ID exists in the database; add it to the cache if so */
 569         if ( !*eip ) {
 570 #ifndef BDB_HIER
 571                 rc = bdb_id2entry( op->o_bd, tid, id, &ep );
 572                 if ( rc == 0 ) {
 573                         rc = bdb_cache_find_ndn( op, tid,
 574                                 &ep->e_nname, eip );
 575                         if ( *eip )
 576                                 islocked = 1;
 577                         if ( rc ) {
 578                                 bdb_entry_return( ep );
 579                                 ep = NULL;
 580                         }
 581                 }
 582 #else
 583                 rc = hdb_cache_find_parent(op, tid, id, eip );
 584                 if ( rc == 0 && *eip )
 585                         islocked = 1;
 586 #endif
 587         }
 588
 589         /* Ok, we found the info, do we have the entry? */
 590         if ( *eip && rc == 0 ) {
 591                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
 592                         rc = DB_NOTFOUND;
 593                 } else {
 594                         bdb_cache_entry_db_lock( bdb->bi_dbenv, locker,
 595                                         *eip, 0, 0, lock );
 596                         if ( !(*eip)->bei_e ) {
 597                                 if (!ep) {
 598                                         rc = bdb_id2entry( op->o_bd, tid, id, &ep );
 599                                 }
 600                                 if ( rc == 0 ) {
 601                                         bdb_cache_entry_db_relock( bdb->bi_dbenv, locker,
 602                                                 *eip, 1, 0, lock );
 603                                         /* Make sure no other modifier beat us to it */
 604                                         if ( (*eip)->bei_e ) {
 605                                                 bdb_entry_return( ep );
 606                                                 ep = NULL;
 607                                         } else {
 608                                                 ep->e_private = *eip;
 609 #ifdef BDB_HIER
 610                                                 bdb_fix_dn( ep, 0 );
 611 #endif
 612                                                 (*eip)->bei_e = ep;
 613                                         }
 614                                         bdb_cache_entry_db_relock( bdb->bi_dbenv, locker,
 615                                                 *eip, 0, 0, lock );
 616                                 }
 617                         } else {
 618                                 /* If we had the entry already, this item
 619                                  * is on the LRU list.
 620                                  */
 621                                 lru_del = 1;
 622 #ifdef BDB_HIER
 623                                 rc = bdb_fix_dn( (*eip)->bei_e, 1 );
 624                                 if ( rc ) {
 625                                         bdb_cache_entry_db_relock( bdb->bi_dbenv,
 626                                                 locker, *eip, 1, 0, lock );
 627                                         /* check again in case other modifier did it already */
 628                                         if ( bdb_fix_dn( (*eip)->bei_e, 1 ) )
 629                                                 rc = bdb_fix_dn( (*eip)->bei_e, 2 );
 630                                         bdb_cache_entry_db_relock( bdb->bi_dbenv,
 631                                                 locker, *eip, 0, 0, lock );
 632                                 }
 633 #endif
 634                         }
 635                 }
 636         }
 637         if ( rc == 0 ) {
 638                 /* set lru mutex */
 639                 ldap_pvt_thread_mutex_lock( &bdb->bi_cache.lru_mutex );
 640                 /* if entry is old, remove from old spot on LRU list */
 641                 if ( lru_del ) {
 642                         LRU_DELETE( &bdb->bi_cache, *eip );
 643                 } else {
 644                 /* if entry is new, bump cache size */
 645                         bdb->bi_cache.c_cursize++;
 646                 }
 647                 /* lru_mutex is unlocked for us */
 648                 bdb_cache_lru_add( bdb, locker, *eip );
 649         }
 650
 651         if ( islocked ) {
 652                 bdb_cache_entryinfo_unlock( *eip );
 653         }
 654         return rc;
 655 }
 656
 657 int
 658 bdb_cache_children(
 659         Operation *op,
 660         DB_TXN *txn,
 661         Entry *e
 662 )
 663 {
 664         int rc;
 665
 666         if ( BEI(e)->bei_kids ) {
 667                 return 0;
 668         }
 669         if ( BEI(e)->bei_state & CACHE_ENTRY_NO_KIDS ) {
 670                 return DB_NOTFOUND;
 671         }
 672         rc = bdb_dn2id_children( op, txn, e );
 673         if ( rc == DB_NOTFOUND ) {
 674                 BEI(e)->bei_state |= CACHE_ENTRY_NO_KIDS;
 675         }
 676         return rc;
 677 }
 678
 679 /* Update the cache after a successful database Add. */
 680 int
 681 bdb_cache_add(
 682         struct bdb_info *bdb,
 683         EntryInfo *eip,
 684         Entry *e,
 685         struct berval *nrdn,
 686         u_int32_t locker
 687 )
 688 {
 689         EntryInfo *new, ei;
 690         struct berval rdn = e->e_name;
 691         int rc;
 692
 693         ei.bei_id = e->e_id;
 694         ei.bei_parent = eip;
 695         ei.bei_nrdn = *nrdn;
 696 #ifdef BDB_HIER
 697         if ( nrdn->bv_len != e->e_nname.bv_len ) {
 698                 char *ptr = strchr( rdn.bv_val, ',' );
 699                 rdn.bv_len = ptr - rdn.bv_val;
 700         }
 701         ber_dupbv( &ei.bei_rdn, &rdn );
 702         if ( eip->bei_dkids ) eip->bei_dkids++;
 703 #endif
 704         rc = bdb_entryinfo_add_internal( bdb, &ei, &new );
 705         new->bei_e = e;
 706         e->e_private = new;
 707         new->bei_state = CACHE_ENTRY_NO_KIDS;
 708         eip->bei_state &= ~CACHE_ENTRY_NO_KIDS;
 709
 710         /* set lru mutex */
 711         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.lru_mutex );
 712         ++bdb->bi_cache.c_cursize;
 713         /* lru_mutex is unlocked for us */
 714         bdb_cache_lru_add( bdb, locker, new );
 715
 716         bdb_cache_entryinfo_unlock( eip );
 717         ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
 718         return rc;
 719 }
 720
 721 int
 722 bdb_cache_modify(
 723         Entry *e,
 724         Attribute *newAttrs,
 725         DB_ENV *env,
 726         u_int32_t locker,
 727         DB_LOCK *lock
 728 )
 729 {
 730         EntryInfo *ei = BEI(e);
 731
 732         /* Get write lock on data */
 733         bdb_cache_entry_db_relock( env, locker, ei, 1, 0, lock );
 734
 735         /* If we've done repeated mods on a cached entry, then e_attrs
 736          * is no longer contiguous with the entry, and must be freed.
 737          */
 738         if ( (void *)e->e_attrs != (void *)(e+1) ) {
 739                 attrs_free( e->e_attrs );
 740         }
 741         e->e_attrs = newAttrs;
 742
 743         return 0;
 744 }
 745
 746 /*
 747  * Change the rdn in the entryinfo. Also move to a new parent if needed.
 748  */
 749 int
 750 bdb_cache_modrdn(
 751         Entry *e,
 752         struct berval *nrdn,
 753         Entry *new,
 754         EntryInfo *ein,
 755         DB_ENV *env,
 756         u_int32_t locker,
 757         DB_LOCK *lock
 758 )
 759 {
 760         EntryInfo *ei = BEI(e), *pei;
 761         struct berval rdn;
 762         int rc = 0;
 763
 764         /* Get write lock on data */
 765         bdb_cache_entry_db_relock( env, locker, ei, 1, 0, lock );
 766
 767         /* If we've done repeated mods on a cached entry, then e_attrs
 768          * is no longer contiguous with the entry, and must be freed.
 769          */
 770         if ( (void *)e->e_attrs != (void *)(e+1) ) {
 771                 attrs_free( e->e_attrs );
 772         }
 773         e->e_attrs = new->e_attrs;
 774         if( e->e_nname.bv_val < e->e_bv.bv_val || e->e_nname.bv_val >
 775                 e->e_bv.bv_val + e->e_bv.bv_len ) {
 776                 ch_free(e->e_name.bv_val);
 777                 ch_free(e->e_nname.bv_val);
 778         }
 779         e->e_name = new->e_name;
 780         e->e_nname = new->e_nname;
 781
 782         /* Lock the parent's kids AVL tree */
 783         pei = ei->bei_parent;
 784         bdb_cache_entryinfo_lock( pei );
 785         avl_delete( &pei->bei_kids, (caddr_t) ei, bdb_rdn_cmp );
 786         free( ei->bei_nrdn.bv_val );
 787         ber_dupbv( &ei->bei_nrdn, nrdn );
 788 #ifdef BDB_HIER
 789         free( ei->bei_rdn.bv_val );
 790
 791         rdn = e->e_name;
 792         if ( nrdn->bv_len != e->e_nname.bv_len ) {
 793                 char *ptr = strchr(rdn.bv_val, ',');
 794                 rdn.bv_len = ptr - rdn.bv_val;
 795         }
 796         ber_dupbv( &ei->bei_rdn, &rdn );
 797 #endif
 798
 799         if (!ein) {
 800                 ein = ei->bei_parent;
 801         } else {
 802                 ei->bei_parent = ein;
 803                 bdb_cache_entryinfo_unlock( pei );
 804                 bdb_cache_entryinfo_lock( ein );
 805         }
 806 #ifdef BDB_HIER
 807         { int max = ei->bei_modrdns;
 808         /* Record the generation number of this change */
 809                 for ( pei = ein; pei->bei_parent; pei = pei->bei_parent ) {
 810                         if ( pei->bei_modrdns > max )
 811                                 max = pei->bei_modrdns;
 812                 }
 813                 ei->bei_modrdns = max + 1;
 814         }
 815 #endif
 816         avl_insert( &ein->bei_kids, ei, bdb_rdn_cmp, avl_dup_error );
 817         bdb_cache_entryinfo_unlock( ein );
 818         return rc;
 819 }
 820 /*
 821  * cache_delete - delete the entry e from the cache.
 822  *
 823  * returns:     0       e was deleted ok
 824  *              1       e was not in the cache
 825  *              -1      something bad happened
 826  */
 827 int
 828 bdb_cache_delete(
 829     Cache       *cache,
 830     Entry               *e,
 831     DB_ENV      *env,
 832     u_int32_t   locker,
 833     DB_LOCK     *lock
 834 )
 835 {
 836         EntryInfo *ei = BEI(e);
 837         int     rc;
 838
 839         assert( e->e_private );
 840
 841         /* Set this early, warn off any queriers */
 842         ei->bei_state |= CACHE_ENTRY_DELETED;
 843
 844         /* Lock the entry's info */
 845         bdb_cache_entryinfo_lock( ei );
 846
 847         /* Get write lock on the data */
 848         bdb_cache_entry_db_relock( env, locker, ei, 1, 0, lock );
 849
 850         /* set cache write lock */
 851         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
 852
 853         /* Lock the parent's kids tree */
 854         bdb_cache_entryinfo_lock( ei->bei_parent );
 855
 856 #ifdef NEW_LOGGING
 857         LDAP_LOG( CACHE, ENTRY,
 858                 "bdb_cache_delete: delete %ld.\n", e->e_id, 0, 0 );
 859 #else
 860         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_delete( %ld )\n",
 861                 e->e_id, 0, 0 );
 862 #endif
 863
 864         /* set lru mutex */
 865         ldap_pvt_thread_mutex_lock( &cache->lru_mutex );
 866         rc = bdb_cache_delete_internal( cache, e->e_private );
 867         /* free lru mutex */
 868         ldap_pvt_thread_mutex_unlock( &cache->lru_mutex );
 869
 870         /* free cache write lock */
 871         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
 872         bdb_cache_entryinfo_unlock( ei->bei_parent );
 873
 874         /* Leave entry info locked */
 875
 876         return( rc );
 877 }
 878
 879 void
 880 bdb_cache_delete_cleanup(
 881         Entry *e
 882 )
 883 {
 884         bdb_cache_entryinfo_unlock( BEI(e) );
 885         bdb_cache_entryinfo_destroy( e->e_private );
 886         e->e_private = NULL;
 887         bdb_entry_return( e );
 888 }
 889
 890 static int
 891 bdb_cache_delete_internal(
 892     Cache       *cache,
 893     EntryInfo           *e
 894 )
 895 {
 896         int rc = 0;     /* return code */
 897
 898 #ifdef BDB_HIER
 899         e->bei_parent->bei_ckids--;
 900         if ( e->bei_parent->bei_dkids ) e->bei_parent->bei_dkids--;
 901 #endif
 902         /* dn tree */
 903         if ( avl_delete( &e->bei_parent->bei_kids, (caddr_t) e, bdb_rdn_cmp ) == NULL )
 904         {
 905                 rc = -1;
 906         }
 907
 908         /* id tree */
 909         if ( avl_delete( &cache->c_idtree, (caddr_t) e, bdb_id_cmp ) == NULL )
 910         {
 911                 rc = -1;
 912         }
 913
 914         if (rc != 0) {
 915                 return rc;
 916         }
 917
 918         /* lru */
 919         LRU_DELETE( cache, e );
 920         cache->c_cursize--;
 921
 922         /*
 923          * flag entry to be freed later by a call to cache_return_entry()
 924          */
 925         e->bei_state |= CACHE_ENTRY_DELETED;
 926
 927         return( 0 );
 928 }
 929
 930 static void
 931 bdb_entryinfo_release( void *data )
 932 {
 933         EntryInfo *ei = (EntryInfo *)data;
 934         if ( ei->bei_kids ) {
 935                 avl_free( ei->bei_kids, NULL );
 936         }
 937         if ( ei->bei_e ) {
 938                 ei->bei_e->e_private = NULL;
 939                 bdb_entry_return( ei->bei_e );
 940         }
 941         bdb_cache_entryinfo_destroy( ei );
 942 }
 943
 944 void
 945 bdb_cache_release_all( Cache *cache )
 946 {
 947         /* set cache write lock */
 948         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
 949         /* set lru mutex */
 950         ldap_pvt_thread_mutex_lock( &cache->lru_mutex );
 951
 952 #ifdef NEW_LOGGING
 953         LDAP_LOG( CACHE, ENTRY, "bdb_cache_release_all: enter\n", 0, 0, 0 );
 954 #else
 955         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_release_all\n", 0, 0, 0 );
 956 #endif
 957
 958         avl_free( cache->c_dntree.bei_kids, NULL );
 959         avl_free( cache->c_idtree, bdb_entryinfo_release );
 960         cache->c_lruhead = NULL;
 961         cache->c_lrutail = NULL;
 962
 963         /* free lru mutex */
 964         ldap_pvt_thread_mutex_unlock( &cache->lru_mutex );
 965         /* free cache write lock */
 966         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
 967 }
 968
 969 #ifdef LDAP_DEBUG
 970 static void
 971 bdb_lru_print( Cache *cache )
 972 {
 973         EntryInfo       *e;
 974
 975         fprintf( stderr, "LRU queue (head to tail):\n" );
 976         for ( e = cache->c_lruhead; e != NULL; e = e->bei_lrunext ) {
 977                 fprintf( stderr, "\trdn \"%20s\" id %ld\n",
 978                         e->bei_nrdn.bv_val, e->bei_id );
 979         }
 980         fprintf( stderr, "LRU queue (tail to head):\n" );
 981         for ( e = cache->c_lrutail; e != NULL; e = e->bei_lruprev ) {
 982                 fprintf( stderr, "\trdn \"%20s\" id %ld\n",
 983                         e->bei_nrdn.bv_val, e->bei_id );
 984         }
 985 }
 986 #endif
 987
 988 #ifdef BDB_REUSE_LOCKERS
 989 static void
 990 bdb_locker_id_free( void *key, void *data )
 991 {
 992         DB_ENV *env = key;
 993         int lockid = (int) data;
 994         int rc;
 995
 996
 997         rc = XLOCK_ID_FREE( env, lockid );
 998         if ( rc == EINVAL ) {
 999                 DB_LOCKREQ lr;
1000 #ifdef NEW_LOGGING
1001                 LDAP_LOG( BACK_BDB, ERR,
1002                         "bdb_locker_id_free: %d err %s(%d)\n",
1003                         lockid, db_strerror(rc), rc );
1004 #else
1005                 Debug( LDAP_DEBUG_ANY,
1006                         "bdb_locker_id_free: %d err %s(%d)\n",
1007                         lockid, db_strerror(rc), rc );
1008 #endif
1009                 memset( &lr, 0, sizeof(lr) );
1010
1011                 /* release all locks held by this locker. */
1012                 lr.op = DB_LOCK_PUT_ALL;
1013                 env->lock_vec( env, lockid, 0, &lr, 1, NULL );
1014                 XLOCK_ID_FREE( env, lockid );
1015         }
1016 }
1017
1018 int
1019 bdb_locker_id( Operation *op, DB_ENV *env, int *locker )
1020 {
1021         int i, rc, lockid;
1022         void *data;
1023         void *ctx;
1024
1025         if ( !env || !locker ) return -1;
1026
1027         /* If no op was provided, try to find the ctx anyway... */
1028         if ( op ) {
1029                 ctx = op->o_threadctx;
1030         } else {
1031                 ctx = ldap_pvt_thread_pool_context();
1032         }
1033
1034         /* Shouldn't happen unless we're single-threaded */
1035         if ( !ctx ) {
1036                 *locker = 0;
1037                 return 0;
1038         }
1039
1040         if ( ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
1041                 for ( i=0, rc=1; rc != 0 && i<4; i++ ) {
1042                         rc = XLOCK_ID( env, &lockid );
1043                         if (rc) ldap_pvt_thread_yield();
1044                 }
1045                 if ( rc != 0) {
1046                         return rc;
1047                 }
1048                 data = (void *)lockid;
1049                 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, env,
1050                         data, bdb_locker_id_free ) ) ) {
1051                         XLOCK_ID_FREE( env, lockid );
1052 #ifdef NEW_LOGGING
1053                         LDAP_LOG( BACK_BDB, ERR, "bdb_locker_id: err %s(%d)\n",
1054                                 db_strerror(rc), rc, 0 );
1055 #else
1056                         Debug( LDAP_DEBUG_ANY, "bdb_locker_id: err %s(%d)\n",
1057                                 db_strerror(rc), rc, 0 );
1058 #endif
1059
1060                         return rc;
1061                 }
1062         } else {
1063                 lockid = (int)data;
1064         }
1065         *locker = lockid;
1066         return 0;
1067 }
1068 #endif