]> git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/cache.c
1d708725b614cfbfb6e09dd8254c8d40819fdc22
[openldap] / 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         u_int32_t locker
198 )
199 {
200         EntryInfo *ei2 = NULL;
201
202         *res = NULL;
203
204         ei2 = bdb_cache_entryinfo_new();
205
206         ldap_pvt_thread_rdwr_wlock( &bdb->bi_cache.c_rwlock );
207         bdb_cache_entryinfo_lock( ei->bei_parent );
208
209         ei2->bei_id = ei->bei_id;
210         ei2->bei_parent = ei->bei_parent;
211 #ifdef BDB_HIER
212         ei2->bei_rdn = ei->bei_rdn;
213 #endif
214
215         /* Add to cache ID tree */
216         if (avl_insert( &bdb->bi_cache.c_idtree, ei2, bdb_id_cmp, avl_dup_error )) {
217                 EntryInfo *eix;
218                 eix = avl_find( bdb->bi_cache.c_idtree, ei2, bdb_id_cmp );
219                 bdb_cache_entryinfo_destroy( ei2 );
220                 ei2 = eix;
221 #ifdef BDB_HIER
222                 /* It got freed above because its value was
223                  * assigned to ei2.
224                  */
225                 ei->bei_rdn.bv_val = NULL;
226 #endif
227         } else {
228                 ber_dupbv( &ei2->bei_nrdn, &ei->bei_nrdn );
229                 avl_insert( &ei->bei_parent->bei_kids, ei2, bdb_rdn_cmp,
230                         avl_dup_error );
231         }
232
233         *res = ei2;
234         return 0;
235 }
236
237 /* Find the EntryInfo for the requested DN. If the DN cannot be found, return
238  * the info for its closest ancestor. *res should be NULL to process a
239  * complete DN starting from the tree root. Otherwise *res must be the
240  * immediate parent of the requested DN, and only the RDN will be searched.
241  * The EntryInfo is locked upon return and must be unlocked by the caller.
242  */
243 int
244 bdb_cache_find_ndn(
245         Operation       *op,
246         DB_TXN          *txn,
247         struct berval   *ndn,
248         EntryInfo       **res,
249         u_int32_t       locker
250 )
251 {
252         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
253         EntryInfo       ei, *eip, *ei2;
254         int rc = 0;
255         char *ptr;
256
257         /* this function is always called with normalized DN */
258         if ( *res ) {
259                 /* we're doing a onelevel search for an RDN */
260                 ei.bei_nrdn.bv_val = ndn->bv_val;
261                 ei.bei_nrdn.bv_len = dn_rdnlen( op->o_bd, ndn );
262                 eip = *res;
263         } else {
264                 /* we're searching a full DN from the root */
265                 ptr = ndn->bv_val + ndn->bv_len - op->o_bd->be_nsuffix[0].bv_len;
266                 ei.bei_nrdn.bv_val = ptr;
267                 ei.bei_nrdn.bv_len = op->o_bd->be_nsuffix[0].bv_len;
268                 eip = &bdb->bi_cache.c_dntree;
269         }
270         
271         for ( bdb_cache_entryinfo_lock( eip ); eip; ) {
272                 ei.bei_parent = eip;
273                 ei2 = (EntryInfo *)avl_find( eip->bei_kids, &ei, bdb_rdn_cmp );
274                 if ( !ei2 ) {
275                         int len = ei.bei_nrdn.bv_len;
276                                 
277                         ei.bei_nrdn.bv_len = ndn->bv_len - (ei.bei_nrdn.bv_val - ndn->bv_val);
278                         bdb_cache_entryinfo_unlock( eip );
279
280                         rc = bdb_dn2id( op, txn, &ei.bei_nrdn, &ei );
281                         if (rc) {
282                                 bdb_cache_entryinfo_lock( eip );
283                                 *res = eip;
284                                 return rc;
285                         }
286
287                         /* DN exists but needs to be added to cache */
288                         ei.bei_nrdn.bv_len = len;
289                         rc = bdb_entryinfo_add_internal( bdb, &ei, &ei2,
290                                 locker );
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 #endif
433
434 /* caller must have lru_mutex locked. mutex
435  * will be unlocked on return.
436  */
437 static void
438 bdb_cache_lru_add(
439         struct bdb_info *bdb,
440         u_int32_t       locker,
441         EntryInfo *ei
442 )
443 {
444         DB_LOCK         lock;
445
446         /* See if we're above the cache size limit */
447         if ( bdb->bi_cache.c_cursize > bdb->bi_cache.c_maxsize ) {
448                 EntryInfo *elru, *elprev;
449                 int i = 0;
450
451                 /* Look for an unused entry to remove */
452                 for (elru = bdb->bi_cache.c_lrutail; elru; elru = elprev, i++ ) {
453                         elprev = elru->bei_lruprev;
454
455                         /* Too many probes, not enough idle, give up */
456                         if (i > 10) break;
457
458                         /* If we can successfully writelock it, then
459                          * the object is idle.
460                          */
461                         if ( bdb_cache_entry_db_lock( bdb->bi_dbenv, locker, elru, 1, 1,
462                                 &lock ) == 0 ) {
463                                 /* If there's no entry, or this node is in
464                                  * the process of linking into the cache,
465                                  * skip it.
466                                  */
467                                 if ( !elru->bei_e || (elru->bei_state & CACHE_ENTRY_NOT_LINKED) ) {
468                                         bdb_cache_entry_db_unlock( bdb->bi_dbenv, &lock );
469                                         continue;
470                                 }
471                                 LRU_DELETE( &bdb->bi_cache, elru );
472                                 elru->bei_e->e_private = NULL;
473                                 bdb_entry_return( elru->bei_e );
474                                 elru->bei_e = NULL;
475                                 bdb_cache_entry_db_unlock( bdb->bi_dbenv, &lock );
476                                 --bdb->bi_cache.c_cursize;
477                                 if (bdb->bi_cache.c_cursize < bdb->bi_cache.c_maxsize)
478                                         break;
479                         }
480                 }
481         }
482         LRU_ADD( &bdb->bi_cache, ei );
483         ldap_pvt_thread_mutex_unlock( &bdb->bi_cache.lru_mutex );
484 }
485
486 /*
487  * cache_find_id - find an entry in the cache, given id.
488  * The entry is locked for Read upon return. Call with islocked TRUE if
489  * the supplied *eip was already locked.
490  */
491
492 int
493 bdb_cache_find_id(
494         Operation *op,
495         DB_TXN  *tid,
496         ID                              id,
497         EntryInfo       **eip,
498         int             islocked,
499         u_int32_t       locker,
500         DB_LOCK         *lock
501 )
502 {
503         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
504         Entry   *ep = NULL;
505         int     rc = 0;
506         EntryInfo ei;
507         int lru_del = 0;
508
509         ei.bei_id = id;
510
511         /* If we weren't given any info, see if we have it already cached */
512         if ( !*eip ) {
513 again:          ldap_pvt_thread_rdwr_rlock( &bdb->bi_cache.c_rwlock );
514                 *eip = (EntryInfo *) avl_find( bdb->bi_cache.c_idtree,
515                                         (caddr_t) &ei, bdb_id_cmp );
516                 if ( *eip ) {
517                         /* If the lock attempt fails, the info is in use */
518                         if ( ldap_pvt_thread_mutex_trylock(
519                                         &(*eip)->bei_kids_mutex )) {
520                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
521                                 /* If this node is being deleted, treat
522                                  * as if the delete has already finished
523                                  */
524                                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
525                                         return DB_NOTFOUND;
526                                 }
527                                 /* otherwise, wait for the info to free up */
528                                 ldap_pvt_thread_yield();
529                                 goto again;
530                         }
531                         /* If this info isn't hooked up to its parent yet,
532                          * unlock and wait for it to be fully initialized
533                          */
534                         if ( (*eip)->bei_state & CACHE_ENTRY_NOT_LINKED ) {
535                                 bdb_cache_entryinfo_unlock( *eip );
536                                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
537                                 ldap_pvt_thread_yield();
538                                 goto again;
539                         }
540                         islocked = 1;
541                 }
542                 ldap_pvt_thread_rdwr_runlock( &bdb->bi_cache.c_rwlock );
543         }
544
545         /* See if the ID exists in the database; add it to the cache if so */
546         if ( !*eip ) {
547 #ifndef BDB_HIER
548                 rc = bdb_id2entry( op->o_bd, tid, id, &ep );
549                 if ( rc == 0 ) {
550                         rc = bdb_cache_find_ndn( op, tid,
551                                 &ep->e_nname, eip, locker );
552                         if ( *eip )
553                                 islocked = 1;
554                         if ( rc ) {
555                                 bdb_entry_return( ep );
556                                 ep = NULL;
557                         }
558                 }
559 #else
560                 rc = hdb_cache_find_parent(op, tid, id, eip );
561                 if ( rc == 0 && *eip )
562                         islocked = 1;
563 #endif
564         }
565
566         /* Ok, we found the info, do we have the entry? */
567         if ( *eip && rc == 0 ) {
568                 if ( (*eip)->bei_state & CACHE_ENTRY_DELETED ) {
569                         rc = DB_NOTFOUND;
570                 } else {
571                         bdb_cache_entry_db_lock( bdb->bi_dbenv, locker,
572                                         *eip, 0, 0, lock );
573                         if ( !(*eip)->bei_e ) {
574                                 if (!ep) {
575                                         rc = bdb_id2entry( op->o_bd, tid, id, &ep );
576                                 }
577                                 if ( rc == 0 ) {
578                                         bdb_cache_entry_db_relock( bdb->bi_dbenv, locker,
579                                                 *eip, 1, 0, lock );
580                                         /* Make sure no other modifier beat us to it */
581                                         if ( (*eip)->bei_e ) {
582                                                 bdb_entry_return( ep );
583                                                 ep = NULL;
584                                         } else {
585                                                 ep->e_private = *eip;
586 #ifdef BDB_HIER
587                                                 bdb_fix_dn( ep, 0 );
588 #endif
589                                                 (*eip)->bei_e = ep;
590                                         }
591                                         bdb_cache_entry_db_relock( bdb->bi_dbenv, locker,
592                                                 *eip, 0, 0, lock );
593                                 }
594                         } else {
595                                 /* If we had the entry already, this item
596                                  * is on the LRU list.
597                                  */
598                                 lru_del = 1;
599 #ifdef BDB_HIER
600                                 rc = bdb_fix_dn( (*eip)->bei_e, 1 );
601                                 if ( rc ) {
602                                         bdb_cache_entry_db_relock( bdb->bi_dbenv,
603                                                 locker, *eip, 1, 0, lock );
604                                         /* check again in case other modifier did it already */
605                                         if ( bdb_fix_dn( (*eip)->bei_e, 1 ) )
606                                                 rc = bdb_fix_dn( (*eip)->bei_e, 2 );
607                                         bdb_cache_entry_db_relock( bdb->bi_dbenv,
608                                                 locker, *eip, 0, 0, lock );
609                                 }
610 #endif
611                         }
612                 }
613         }
614         if ( rc == 0 ) {
615                 /* set lru mutex */
616                 ldap_pvt_thread_mutex_lock( &bdb->bi_cache.lru_mutex );
617                 /* if entry is old, remove from old spot on LRU list */
618                 if ( lru_del ) {
619                         LRU_DELETE( &bdb->bi_cache, *eip );
620                 } else {
621                 /* if entry is new, bump cache size */
622                         bdb->bi_cache.c_cursize++;
623                 }
624                 /* lru_mutex is unlocked for us */
625                 bdb_cache_lru_add( bdb, locker, *eip );
626         }
627
628         if ( islocked ) {
629                 bdb_cache_entryinfo_unlock( *eip );
630         }
631         return rc;
632 }
633
634 int
635 bdb_cache_children(
636         Operation *op,
637         DB_TXN *txn,
638         Entry *e
639 )
640 {
641         int rc;
642
643         if ( BEI(e)->bei_kids ) {
644                 return 0;
645         }
646         if ( BEI(e)->bei_state & CACHE_ENTRY_NO_KIDS ) {
647                 return DB_NOTFOUND;
648         }
649         rc = bdb_dn2id_children( op, txn, e );
650         if ( rc == DB_NOTFOUND ) {
651                 BEI(e)->bei_state |= CACHE_ENTRY_NO_KIDS;
652         }
653         return rc;
654 }
655
656 /* Update the cache after a successful database Add. */
657 int
658 bdb_cache_add(
659         struct bdb_info *bdb,
660         EntryInfo *eip,
661         Entry *e,
662         struct berval *nrdn,
663         u_int32_t locker
664 )
665 {
666         EntryInfo *new, ei;
667         struct berval rdn = e->e_name;
668         int rc;
669
670         ei.bei_id = e->e_id;
671         ei.bei_parent = eip;
672         ei.bei_nrdn = *nrdn;
673 #ifdef BDB_HIER
674         if ( nrdn->bv_len != e->e_nname.bv_len ) {
675                 char *ptr = strchr( rdn.bv_val, ',' );
676                 rdn.bv_len = ptr - rdn.bv_val;
677         }
678         ber_dupbv( &ei.bei_rdn, &rdn );
679 #endif
680         rc = bdb_entryinfo_add_internal( bdb, &ei, &new, locker );
681         new->bei_e = e;
682         e->e_private = new;
683         new->bei_state = CACHE_ENTRY_NO_KIDS;
684         eip->bei_state &= ~CACHE_ENTRY_NO_KIDS;
685
686         /* set lru mutex */
687         ldap_pvt_thread_mutex_lock( &bdb->bi_cache.lru_mutex );
688         ++bdb->bi_cache.c_cursize;
689         /* lru_mutex is unlocked for us */
690         bdb_cache_lru_add( bdb, locker, new );
691
692         bdb_cache_entryinfo_unlock( eip );
693         ldap_pvt_thread_rdwr_wunlock( &bdb->bi_cache.c_rwlock );
694         return rc;
695 }
696
697 int
698 bdb_cache_modify(
699         Entry *e,
700         Attribute *newAttrs,
701         DB_ENV *env,
702         u_int32_t locker,
703         DB_LOCK *lock
704 )
705 {
706         EntryInfo *ei = BEI(e);
707         
708         /* Get write lock on data */
709         bdb_cache_entry_db_relock( env, locker, ei, 1, 0, lock );
710
711         /* If we've done repeated mods on a cached entry, then e_attrs
712          * is no longer contiguous with the entry, and must be freed.
713          */
714         if ( (void *)e->e_attrs != (void *)(e+1) ) {
715                 attrs_free( e->e_attrs );
716         }
717         e->e_attrs = newAttrs;
718
719         return 0;
720 }
721
722 /*
723  * Change the rdn in the entryinfo. Also move to a new parent if needed.
724  */
725 int
726 bdb_cache_modrdn(
727         Entry *e,
728         struct berval *nrdn,
729         Entry *new,
730         EntryInfo *ein,
731         DB_ENV *env,
732         u_int32_t locker,
733         DB_LOCK *lock
734 )
735 {
736         EntryInfo *ei = BEI(e), *pei;
737         struct berval rdn;
738         int rc = 0;
739
740         /* Get write lock on data */
741         bdb_cache_entry_db_relock( env, locker, ei, 1, 0, lock );
742
743         /* If we've done repeated mods on a cached entry, then e_attrs
744          * is no longer contiguous with the entry, and must be freed.
745          */
746         if ( (void *)e->e_attrs != (void *)(e+1) ) {
747                 attrs_free( e->e_attrs );
748         }
749         e->e_attrs = new->e_attrs;
750         if( e->e_nname.bv_val < e->e_bv.bv_val || e->e_nname.bv_val >
751                 e->e_bv.bv_val + e->e_bv.bv_len ) {
752                 ch_free(e->e_name.bv_val);
753                 ch_free(e->e_nname.bv_val);
754         }
755         e->e_name = new->e_name;
756         e->e_nname = new->e_nname;
757
758         /* Lock the parent's kids AVL tree */
759         pei = ei->bei_parent;
760         bdb_cache_entryinfo_lock( pei );
761         avl_delete( &pei->bei_kids, (caddr_t) ei, bdb_rdn_cmp );
762         free( ei->bei_nrdn.bv_val );
763         ber_dupbv( &ei->bei_nrdn, nrdn );
764 #ifdef BDB_HIER
765         free( ei->bei_rdn.bv_val );
766
767         rdn = e->e_name;
768         if ( nrdn->bv_len != e->e_nname.bv_len ) {
769                 char *ptr = strchr(rdn.bv_val, ',');
770                 rdn.bv_len = ptr - rdn.bv_val;
771         }
772         ber_dupbv( &ei->bei_rdn, &rdn );
773 #endif
774
775         if (!ein) {
776                 ein = ei->bei_parent;
777         } else {
778                 ei->bei_parent = ein;
779                 bdb_cache_entryinfo_unlock( pei );
780                 bdb_cache_entryinfo_lock( ein );
781         }
782 #ifdef BDB_HIER
783         { int max = ei->bei_modrdns;
784         /* Record the generation number of this change */
785                 for ( pei = ein; pei->bei_parent; pei = pei->bei_parent ) {
786                         if ( pei->bei_modrdns > max )
787                                 max = pei->bei_modrdns;
788                 }
789                 ei->bei_modrdns = max + 1;
790         }
791 #endif
792         avl_insert( &ein->bei_kids, ei, bdb_rdn_cmp, avl_dup_error );
793         bdb_cache_entryinfo_unlock( ein );
794         return rc;
795 }
796 /*
797  * cache_delete - delete the entry e from the cache. 
798  *
799  * returns:     0       e was deleted ok
800  *              1       e was not in the cache
801  *              -1      something bad happened
802  */
803 int
804 bdb_cache_delete(
805     Cache       *cache,
806     Entry               *e,
807     DB_ENV      *env,
808     u_int32_t   locker,
809     DB_LOCK     *lock
810 )
811 {
812         EntryInfo *ei = BEI(e);
813         int     rc;
814
815         assert( e->e_private );
816
817         /* Set this early, warn off any queriers */
818         ei->bei_state |= CACHE_ENTRY_DELETED;
819
820         /* Lock the entry's info */
821         bdb_cache_entryinfo_lock( ei );
822
823         /* Get write lock on the data */
824         bdb_cache_entry_db_relock( env, locker, ei, 1, 0, lock );
825
826         /* set cache write lock */
827         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
828
829         /* Lock the parent's kids tree */
830         bdb_cache_entryinfo_lock( ei->bei_parent );
831
832 #ifdef NEW_LOGGING
833         LDAP_LOG( CACHE, ENTRY, 
834                 "bdb_cache_delete: delete %ld.\n", e->e_id, 0, 0 );
835 #else
836         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_delete( %ld )\n",
837                 e->e_id, 0, 0 );
838 #endif
839
840         /* set lru mutex */
841         ldap_pvt_thread_mutex_lock( &cache->lru_mutex );
842         rc = bdb_cache_delete_internal( cache, e->e_private );
843         /* free lru mutex */
844         ldap_pvt_thread_mutex_unlock( &cache->lru_mutex );
845
846         /* free cache write lock */
847         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
848         bdb_cache_entryinfo_unlock( ei->bei_parent );
849
850         /* Leave entry info locked */
851
852         return( rc );
853 }
854
855 void
856 bdb_cache_delete_cleanup(
857         Entry *e
858 )
859 {
860         bdb_cache_entryinfo_unlock( BEI(e) );
861         bdb_cache_entryinfo_destroy( e->e_private );
862         e->e_private = NULL;
863         bdb_entry_return( e );
864 }
865         
866 static int
867 bdb_cache_delete_internal(
868     Cache       *cache,
869     EntryInfo           *e
870 )
871 {
872         int rc = 0;     /* return code */
873
874         /* dn tree */
875         if ( avl_delete( &e->bei_parent->bei_kids, (caddr_t) e, bdb_rdn_cmp ) == NULL )
876         {
877                 rc = -1;
878         }
879
880         /* id tree */
881         if ( avl_delete( &cache->c_idtree, (caddr_t) e, bdb_id_cmp ) == NULL )
882         {
883                 rc = -1;
884         }
885
886         if (rc != 0) {
887                 return rc;
888         }
889
890         /* lru */
891         LRU_DELETE( cache, e );
892         cache->c_cursize--;
893
894         /*
895          * flag entry to be freed later by a call to cache_return_entry()
896          */
897         e->bei_state |= CACHE_ENTRY_DELETED;
898
899         return( 0 );
900 }
901
902 static void
903 bdb_entryinfo_release( void *data )
904 {
905         EntryInfo *ei = (EntryInfo *)data;
906         if ( ei->bei_kids ) {
907                 avl_free( ei->bei_kids, NULL );
908         }
909         if ( ei->bei_e ) {
910                 ei->bei_e->e_private = NULL;
911                 bdb_entry_return( ei->bei_e );
912         }
913         bdb_cache_entryinfo_destroy( ei );
914 }
915
916 void
917 bdb_cache_release_all( Cache *cache )
918 {
919         /* set cache write lock */
920         ldap_pvt_thread_rdwr_wlock( &cache->c_rwlock );
921         /* set lru mutex */
922         ldap_pvt_thread_mutex_lock( &cache->lru_mutex );
923
924 #ifdef NEW_LOGGING
925         LDAP_LOG( CACHE, ENTRY, "bdb_cache_release_all: enter\n", 0, 0, 0 );
926 #else
927         Debug( LDAP_DEBUG_TRACE, "====> bdb_cache_release_all\n", 0, 0, 0 );
928 #endif
929
930         avl_free( cache->c_dntree.bei_kids, NULL );
931         avl_free( cache->c_idtree, bdb_entryinfo_release );
932         cache->c_lruhead = NULL;
933         cache->c_lrutail = NULL;
934
935         /* free lru mutex */
936         ldap_pvt_thread_mutex_unlock( &cache->lru_mutex );
937         /* free cache write lock */
938         ldap_pvt_thread_rdwr_wunlock( &cache->c_rwlock );
939 }
940
941 #ifdef LDAP_DEBUG
942 static void
943 bdb_lru_print( Cache *cache )
944 {
945         EntryInfo       *e;
946
947         fprintf( stderr, "LRU queue (head to tail):\n" );
948         for ( e = cache->c_lruhead; e != NULL; e = e->bei_lrunext ) {
949                 fprintf( stderr, "\trdn \"%20s\" id %ld\n",
950                         e->bei_nrdn.bv_val, e->bei_id );
951         }
952         fprintf( stderr, "LRU queue (tail to head):\n" );
953         for ( e = cache->c_lrutail; e != NULL; e = e->bei_lruprev ) {
954                 fprintf( stderr, "\trdn \"%20s\" id %ld\n",
955                         e->bei_nrdn.bv_val, e->bei_id );
956         }
957 }
958 #endif
959
960 #ifdef BDB_REUSE_LOCKERS
961 static void
962 bdb_locker_id_free( void *key, void *data )
963 {
964         DB_ENV *env = key;
965         int lockid = (int) data;
966         int rc;
967
968
969         rc = XLOCK_ID_FREE( env, lockid );
970         if ( rc == EINVAL ) {
971                 DB_LOCKREQ lr;
972 #ifdef NEW_LOGGING
973                 LDAP_LOG( BACK_BDB, ERR,
974                         "bdb_locker_id_free: %d err %s(%d)\n",
975                         lockid, db_strerror(rc), rc );
976 #else
977                 Debug( LDAP_DEBUG_ANY,
978                         "bdb_locker_id_free: %d err %s(%d)\n",
979                         lockid, db_strerror(rc), rc );
980 #endif
981                 memset( &lr, 0, sizeof(lr) );
982
983                 /* release all locks held by this locker. */
984                 lr.op = DB_LOCK_PUT_ALL;
985                 env->lock_vec( env, lockid, 0, &lr, 1, NULL );
986                 XLOCK_ID_FREE( env, lockid );
987         }
988 }
989
990 int
991 bdb_locker_id( Operation *op, DB_ENV *env, int *locker )
992 {
993         int i, rc, lockid;
994         void *data;
995         void *ctx;
996
997         if ( !env || !locker ) return -1;
998
999         /* If no op was provided, try to find the ctx anyway... */
1000         if ( op ) {
1001                 ctx = op->o_threadctx;
1002         } else {
1003                 ctx = ldap_pvt_thread_pool_context();
1004         }
1005
1006         /* Shouldn't happen unless we're single-threaded */
1007         if ( !ctx ) {
1008                 *locker = 0;
1009                 return 0;
1010         }
1011
1012         if ( ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
1013                 for ( i=0, rc=1; rc != 0 && i<4; i++ ) {
1014                         rc = XLOCK_ID( env, &lockid );
1015                         if (rc) ldap_pvt_thread_yield();
1016                 }
1017                 if ( rc != 0) {
1018                         return rc;
1019                 }
1020                 data = (void *)lockid;
1021                 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, env,
1022                         data, bdb_locker_id_free ) ) ) {
1023                         XLOCK_ID_FREE( env, lockid );
1024 #ifdef NEW_LOGGING
1025                         LDAP_LOG( BACK_BDB, ERR, "bdb_locker_id: err %s(%d)\n",
1026                                 db_strerror(rc), rc, 0 );
1027 #else
1028                         Debug( LDAP_DEBUG_ANY, "bdb_locker_id: err %s(%d)\n",
1029                                 db_strerror(rc), rc, 0 );
1030 #endif
1031
1032                         return rc;
1033                 }
1034         } else {
1035                 lockid = (int)data;
1036         }
1037         *locker = lockid;
1038         return 0;
1039 }
1040 #endif