]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/back-ldbm/cache.c
Code clean-up.
[openldap] / servers / slapd / back-ldbm / cache.c
index 0a2b3c97b1fba73891ec47c3da83aa19dc391433..fe88ed895d12137675094cd0729d164d6dcf5953 100644 (file)
@@ -22,6 +22,10 @@ struct ldbm_entry_info {
         * be hidden.
         */
        int             lei_state;      /* for the cache */
+#define        CACHE_ENTRY_UNDEFINED   0
+#define CACHE_ENTRY_CREATING   1
+#define CACHE_ENTRY_READY              2
+#define CACHE_ENTRY_DELETED            3
 
        int             lei_refcnt;     /* # threads ref'ing this entry */
        struct entry    *lei_lrunext;   /* for cache lru list */
@@ -34,48 +38,6 @@ static int   cache_delete_entry_internal(struct cache *cache, Entry *e);
 static void    lru_print(struct cache *cache);
 #endif
 
-/*
- * the cache has three entry points (ways to find things):
- *
- *     by entry        e.g., if you already have an entry from the cache
- *                     and want to delete it. (really by entry ptr)
- *     by dn           e.g., when looking for the base object of a search
- *     by id           e.g., for search candidates
- *
- * these correspond to three different avl trees that are maintained.
- */
-
-static int
-cache_entry_cmp( Entry *e1, Entry *e2 )
-{
-       return( e1 < e2 ? -1 : (e1 > e2 ? 1 : 0) );
-}
-
-static int
-cache_entrydn_cmp( Entry *e1, Entry *e2 )
-{
-       /* compare their normalized UPPERCASED dn's */
-       return( strcmp( e1->e_ndn, e2->e_ndn ) );
-}
-
-static int
-cache_entryid_cmp( Entry *e1, Entry *e2 )
-{
-       return( e1->e_id < e2->e_id ? -1 : (e1->e_id > e2->e_id ? 1 : 0) );
-}
-
-void
-cache_set_state( struct cache *cache, Entry *e, int state )
-{
-       /* set cache mutex */
-       ldap_pvt_thread_mutex_lock( &cache->c_mutex );
-
-       LEI(e)->lei_state = state;
-
-       /* free cache mutex */
-       ldap_pvt_thread_mutex_unlock( &cache->c_mutex );
-}
-
 static int
 cache_entry_rdwr_lock(Entry *e, int rw)
 {
@@ -129,7 +91,12 @@ cache_entry_private_init( Entry*e )
 {
        struct ldbm_entry_info *lei;
 
+#ifdef LDAP_DEBUG
+       assert( e->e_private == NULL );
+#endif
+
        if( e->e_private != NULL ) {
+               /* this should never happen */
                return 1;
        }
 
@@ -137,6 +104,7 @@ cache_entry_private_init( Entry*e )
 
        if( cache_entry_rdwr_init( e ) != 0 ) {
                free( LEI(e) );
+               e->e_private = NULL;
                return 1;
        } 
 
@@ -148,9 +116,9 @@ cache_entry_private_destroy( Entry*e )
 {
        struct ldbm_entry_info *lei;
 
-       if( e->e_private == NULL ) {
-               return 1;
-       }
+#ifdef LDAP_DEBUG
+       assert( e->e_private );
+#endif
 
        cache_entry_rdwr_destroy( e );
 
@@ -159,41 +127,53 @@ cache_entry_private_destroy( Entry*e )
        return 0;
 }
 
-static void
+void
 cache_return_entry_rw( struct cache *cache, Entry *e, int rw )
 {
-       Debug( LDAP_DEBUG_TRACE, "====> cache_return_entry_%s\n",
-               rw ? "w" : "r", 0, 0);
-
        /* set cache mutex */
        ldap_pvt_thread_mutex_lock( &cache->c_mutex );
 
+#ifdef LDAP_DEBUG
+       assert( e->e_private );
+#endif
+
        cache_entry_rdwr_unlock(e, rw);
 
-       if ( --LEI(e)->lei_refcnt == 0 &&
-               LEI(e)->lei_state == ENTRY_STATE_DELETED )
-       {
-               cache_entry_private_destroy( e );
-               entry_free( e );
+       LEI(e)->lei_refcnt--;
+
+       if ( LEI(e)->lei_state == CACHE_ENTRY_CREATING ) {
+               Debug( LDAP_DEBUG_TRACE,
+                       "====> cache_return_entry_%s( %ld ): created (%d)\n",
+                       rw ? "w" : "r", e->e_id, LEI(e)->lei_refcnt );
+
+               LEI(e)->lei_state = CACHE_ENTRY_READY;
+
+       } else if ( LEI(e)->lei_state == CACHE_ENTRY_DELETED ) {
+               if( LEI(e)->lei_refcnt > 0 ) {
+                       Debug( LDAP_DEBUG_TRACE,
+                               "====> cache_return_entry_%s( %ld ): delete pending (%d)\n",
+                               rw ? "w" : "r", e->e_id, LEI(e)->lei_refcnt );
+
+               } else {
+                       Debug( LDAP_DEBUG_TRACE,
+                               "====> cache_return_entry_%s( %ld ): deleted (%d)\n",
+                               rw ? "w" : "r", e->e_id, LEI(e)->lei_refcnt );
+
+                       cache_entry_private_destroy( e );
+                       entry_free( e );
+               }
+
+       } else {
+               Debug( LDAP_DEBUG_TRACE,
+                       "====> cache_return_entry_%s( %ld ): returned (%d)\n",
+                       rw ? "w" : "r", e->e_id, LEI(e)->lei_refcnt);
        }
 
+
        /* free cache mutex */
        ldap_pvt_thread_mutex_unlock( &cache->c_mutex );
 }
 
-void
-cache_return_entry_r( struct cache *cache, Entry *e )
-{
-       cache_return_entry_rw(cache, e, 0);
-}
-
-void
-cache_return_entry_w( struct cache *cache, Entry *e )
-{
-       cache_return_entry_rw(cache, e, 1);
-}
-
-
 #define LRU_DELETE( cache, e ) { \
        if ( LEI(e)->lei_lruprev != NULL ) { \
                LEI(LEI(e)->lei_lruprev)->lei_lrunext = LEI(e)->lei_lrunext; \
@@ -229,7 +209,6 @@ int
 cache_add_entry_rw(
     struct cache       *cache,
     Entry              *e,
-    int                        state,
        int             rw
 )
 {
@@ -239,26 +218,23 @@ cache_add_entry_rw(
        /* set cache mutex */
        ldap_pvt_thread_mutex_lock( &cache->c_mutex );
 
-       if ( e->e_private != NULL ) {
-               Debug( LDAP_DEBUG_ANY,
-                       "====> cache_add_entry: entry %20s id %lu already cached.\n",
-                   e->e_dn, e->e_id, 0 );
-               return( -1 );
-       }
+#ifdef LDAP_DEBUG
+       assert( e->e_private == NULL );
+#endif
 
        if( cache_entry_private_init(e) != 0 ) {
                Debug( LDAP_DEBUG_ANY,
-                       "====> cache_add_entry: entry %20s id %lu: private init failed!\n",
-                   e->e_dn, e->e_id, 0 );
+                       "====> cache_add_entry( %ld ): \"%s\": private init failed!\n",
+                   e->e_id, e->e_dn, 0 );
                return( -1 );
        }
 
        if ( avl_insert( &cache->c_dntree, (caddr_t) e,
-               cache_entrydn_cmp, avl_dup_error ) != 0 )
+               entry_dn_cmp, avl_dup_error ) != 0 )
        {
                Debug( LDAP_DEBUG_TRACE,
-                       "====> cache_add_entry: entry %20s id %lu already in dn cache\n",
-                   e->e_dn, e->e_id, 0 );
+                       "====> cache_add_entry( %ld ): \"%s\": already in dn cache\n",
+                   e->e_id, e->e_dn, 0 );
 
                cache_entry_private_destroy(e);
 
@@ -269,15 +245,16 @@ cache_add_entry_rw(
 
        /* id tree */
        if ( avl_insert( &cache->c_idtree, (caddr_t) e,
-               cache_entryid_cmp, avl_dup_error ) != 0 )
+               entry_id_cmp, avl_dup_error ) != 0 )
        {
                Debug( LDAP_DEBUG_ANY,
-                       "====> entry %20s id %lu already in id cache\n",
-                   e->e_dn, e->e_id, 0 );
+                       "====> cache_add_entry( %ld ): \"%s\": already in id cache\n",
+                   e->e_id, e->e_dn, 0 );
+
 
                /* delete from dn tree inserted above */
                if ( avl_delete( &cache->c_dntree, (caddr_t) e,
-                       cache_entrydn_cmp ) == NULL )
+                       entry_dn_cmp ) == NULL )
                {
                        Debug( LDAP_DEBUG_ANY, "====> can't delete from dn cache\n",
                            0, 0, 0 );
@@ -292,7 +269,9 @@ cache_add_entry_rw(
 
        cache_entry_rdwr_lock( e, rw );
 
-       LEI(e)->lei_state = state;
+       /* put the entry into 'CREATING' state */
+       /* will be marked after when entry is returned */
+       LEI(e)->lei_state = CACHE_ENTRY_CREATING;
        LEI(e)->lei_refcnt = 1;
 
        /* lru */
@@ -326,8 +305,9 @@ cache_add_entry_rw(
                        e = cache->c_lrutail;
 
                        /* delete from cache and lru q */
+                       /* XXX do we need rc ? */
                        rc = cache_delete_entry_internal( cache, e );
-
+                       cache_entry_private_destroy( e );
                        entry_free( e );
                }
        }
@@ -355,19 +335,16 @@ cache_update_entry(
        /* set cache mutex */
        ldap_pvt_thread_mutex_lock( &cache->c_mutex );
 
-       if ( e->e_private == NULL ) {
-               Debug( LDAP_DEBUG_ANY,
-                       "====> cache_update_entry: entry %20s id %lu no private data.\n",
-                   e->e_dn, e->e_id, 0 );
-               return( -1 );
-       }
+#ifdef LDAP_DEBUG
+       assert( e->e_private );
+#endif
 
        if ( avl_insert( &cache->c_dntree, (caddr_t) e,
-               cache_entrydn_cmp, avl_dup_error ) != 0 )
+               entry_dn_cmp, avl_dup_error ) != 0 )
        {
                Debug( LDAP_DEBUG_TRACE,
-                       "====> cache_add_entry: entry %20s id %lu already in dn cache\n",
-                   e->e_dn, e->e_id, 0 );
+                       "====> cache_update_entry( %ld ): \"%s\": already in dn cache\n",
+                   e->e_id, e->e_dn, 0 );
 
                /* free cache mutex */
                ldap_pvt_thread_mutex_unlock( &cache->c_mutex );
@@ -376,15 +353,15 @@ cache_update_entry(
 
        /* id tree */
        if ( avl_insert( &cache->c_idtree, (caddr_t) e,
-               cache_entryid_cmp, avl_dup_error ) != 0 )
+               entry_id_cmp, avl_dup_error ) != 0 )
        {
                Debug( LDAP_DEBUG_ANY,
-                       "====> entry %20s id %lu already in id cache\n",
-                   e->e_dn, e->e_id, 0 );
+                       "====> cache_update_entry( %ld ): \"%s\": already in id cache\n",
+                   e->e_id, e->e_dn, 0 );
 
                /* delete from dn tree inserted above */
                if ( avl_delete( &cache->c_dntree, (caddr_t) e,
-                       cache_entrydn_cmp ) == NULL )
+                       entry_dn_cmp ) == NULL )
                {
                        Debug( LDAP_DEBUG_ANY, "====> can't delete from dn cache\n",
                            0, 0, 0 );
@@ -395,6 +372,11 @@ cache_update_entry(
                return( -1 );
        }
 
+
+       /* put the entry into 'CREATING' state */
+       /* will be marked after when entry is returned */
+       LEI(e)->lei_state = CACHE_ENTRY_CREATING;
+
        /* lru */
        LRU_ADD( cache, e );
        if ( ++cache->c_cursize > cache->c_maxsize ) {
@@ -426,8 +408,9 @@ cache_update_entry(
                        e = cache->c_lrutail;
 
                        /* delete from cache and lru q */
+                       /* XXX do we need rc ? */
                        rc = cache_delete_entry_internal( cache, e );
-
+                       cache_entry_private_destroy( e );
                        entry_free( e );
                }
        }
@@ -459,7 +442,7 @@ cache_find_entry_dn2id(
        e.e_ndn = dn_normalize_case( ch_strdup( dn ) );
 
        if ( (ep = (Entry *) avl_find( cache->c_dntree, (caddr_t) &e,
-               cache_entrydn_cmp )) != NULL )
+               entry_dn_cmp )) != NULL )
        {
                /*
                 * ep now points to an unlocked entry
@@ -468,20 +451,29 @@ cache_find_entry_dn2id(
                 */
                free(e.e_ndn);
 
-               Debug(LDAP_DEBUG_TRACE, "====> cache_find_entry_dn2id: found dn: %s\n",
-                       dn, 0, 0);
-
+#ifdef LDAP_DEBUG
+               assert( ep->e_private );
+#endif
                /*
                 * entry is deleted or not fully created yet
                 */
-               if ( LEI(ep)->lei_state == ENTRY_STATE_DELETED ||
-                       LEI(ep)->lei_state == ENTRY_STATE_CREATING )
-               {
+               if ( LEI(ep)->lei_state != CACHE_ENTRY_READY ) {
+#ifdef LDAP_DEBUG
+                       assert(LEI(ep)->lei_state != CACHE_ENTRY_UNDEFINED);
+#endif
+                       Debug(LDAP_DEBUG_TRACE,
+                               "====> cache_find_entry_dn2id(\"%s\"): %ld (not ready) %d\n",
+                               dn, ep->e_id, LEI(ep)->lei_state);
+
                        /* free cache mutex */
                        ldap_pvt_thread_mutex_unlock( &cache->c_mutex );
                        return( NOID );
                }
 
+               Debug(LDAP_DEBUG_TRACE,
+                       "====> cache_find_entry_dn2id(\"%s\"): %ld\n",
+                       dn, ep->e_id, 0);
+
                /* lru */
                LRU_DELETE( cache, ep );
                LRU_ADD( cache, ep );
@@ -524,23 +516,31 @@ try_again:
        ldap_pvt_thread_mutex_lock( &cache->c_mutex );
 
        if ( (ep = (Entry *) avl_find( cache->c_idtree, (caddr_t) &e,
-               cache_entryid_cmp )) != NULL )
+               entry_id_cmp )) != NULL )
        {
-               Debug(LDAP_DEBUG_TRACE,
-                       "====> cache_find_entry_dn2id: found id: %ld rw: %d\n",
-                       id, rw, 0);
-
+#ifdef LDAP_DEBUG
+               assert( ep->e_private );
+#endif
                /*
                 * entry is deleted or not fully created yet
                 */
-               if ( LEI(ep)->lei_state == ENTRY_STATE_DELETED ||
-                       LEI(ep)->lei_state == ENTRY_STATE_CREATING )
-               {
+               if ( LEI(ep)->lei_state != CACHE_ENTRY_READY ) {
+#ifdef LDAP_DEBUG
+                       assert(LEI(ep)->lei_state != CACHE_ENTRY_UNDEFINED);
+#endif
+                       Debug(LDAP_DEBUG_TRACE,
+                               "====> cache_find_entry_id( %ld ): %ld (not ready) %d\n",
+                               id, ep->e_id, LEI(ep)->lei_state);
+
                        /* free cache mutex */
                        ldap_pvt_thread_mutex_unlock( &cache->c_mutex );
                        return( NULL );
                }
 
+               Debug(LDAP_DEBUG_TRACE,
+                       "====> cache_find_entry_id( %ld, %s ) \"%s\" (found)\n",
+                       id, rw ? "w" : "r", ep->e_dn);
+
                /* acquire reader lock */
                if ( cache_entry_rdwr_trylock(ep, rw) == LDAP_PVT_THREAD_EBUSY ) {
                        /* could not acquire entry lock...
@@ -591,11 +591,16 @@ cache_delete_entry(
 {
        int     rc;
 
-       Debug( LDAP_DEBUG_TRACE, "====> cache_delete_entry:\n", 0, 0, 0 );
-
        /* set cache mutex */
        ldap_pvt_thread_mutex_lock( &cache->c_mutex );
 
+#ifdef LDAP_DEBUG
+       assert( e->e_private );
+#endif
+
+       Debug( LDAP_DEBUG_TRACE, "====> cache_delete_entry( %ld )\n",
+               e->e_id, 0, 0 );
+
        rc = cache_delete_entry_internal( cache, e );
 
        /* free cache mutex */
@@ -612,14 +617,14 @@ cache_delete_entry_internal(
        int rc = 0;     /* return code */
 
        /* dn tree */
-       if ( avl_delete( &cache->c_dntree, (caddr_t) e, cache_entrydn_cmp )
+       if ( avl_delete( &cache->c_dntree, (caddr_t) e, entry_dn_cmp )
                == NULL )
        {
                rc = -1;
        }
 
        /* id tree */
-       if ( avl_delete( &cache->c_idtree, (caddr_t) e, cache_entryid_cmp )
+       if ( avl_delete( &cache->c_idtree, (caddr_t) e, entry_id_cmp )
                == NULL )
        {
                rc = -1;
@@ -636,7 +641,7 @@ cache_delete_entry_internal(
        /*
         * flag entry to be freed later by a call to cache_return_entry()
         */
-       LEI(e)->lei_state = ENTRY_STATE_DELETED;
+       LEI(e)->lei_state = CACHE_ENTRY_DELETED;
 
        return( 0 );
 }
@@ -650,13 +655,13 @@ lru_print( struct cache *cache )
 
        fprintf( stderr, "LRU queue (head to tail):\n" );
        for ( e = cache->c_lruhead; e != NULL; e = LEI(e)->lei_lrunext ) {
-               fprintf( stderr, "\tdn %20s id %lu refcnt %d\n", e->e_dn,
-                   e->e_id, LEI(e)->lei_refcnt );
+               fprintf( stderr, "\tdn \"%20s\" id %ld refcnt %d\n",
+                       e->e_dn, e->e_id, LEI(e)->lei_refcnt );
        }
        fprintf( stderr, "LRU queue (tail to head):\n" );
        for ( e = cache->c_lrutail; e != NULL; e = LEI(e)->lei_lruprev ) {
-               fprintf( stderr, "\tdn %20s id %lu refcnt %d\n", e->e_dn,
-                   e->e_id, LEI(e)->lei_refcnt );
+               fprintf( stderr, "\tdn \"%20s\" id %ld refcnt %d\n",
+                       e->e_dn, e->e_id, LEI(e)->lei_refcnt );
        }
 }