CMake build system introduced (issue #9)
[libcds.git] / src / hp_gc.cpp
index 5bfbee4f3b8d1f7a667f46dc5c7fa38d436c490d..1516679059732e97a17850696434368dee78c63c 100644 (file)
@@ -9,7 +9,7 @@
         2008.02.10    Maxim.Khiszinsky    Created
 */
 
-#include <cds/gc/hp/hp.h>
+#include <cds/gc/details/hp.h>
 
 #include <algorithm>    // std::sort
 #include "hp_const.h"
@@ -17,7 +17,7 @@
 #define    CDS_HAZARDPTR_STATISTIC( _x )    if ( m_bStatEnabled ) { _x; }
 
 namespace cds { namespace gc {
-    namespace hzp {
+    namespace hp {
 
         /// Max array size of retired pointers
         static const size_t c_nMaxRetireNodeCount = c_nHazardPointerPerThread * c_nMaxThreadCount * 2;
@@ -59,7 +59,7 @@ namespace cds { namespace gc {
         GarbageCollector::~GarbageCollector()
         {
             CDS_DEBUG_ONLY( const cds::OS::ThreadId nullThreadId = cds::OS::c_NullThreadId; )
-            CDS_DEBUG_ONLY( const cds::OS::ThreadId mainThreadId = cds::OS::getCurrentThreadId() ;)
+            CDS_DEBUG_ONLY( const cds::OS::ThreadId mainThreadId = cds::OS::get_current_thread_id() ;)
 
             hplist_node * pHead = m_pListHead.load( atomics::memory_order_relaxed );
             m_pListHead.store( nullptr, atomics::memory_order_relaxed );
@@ -68,13 +68,13 @@ namespace cds { namespace gc {
             for ( hplist_node * hprec = pHead; hprec; hprec = pNext ) {
                 assert( hprec->m_idOwner.load( atomics::memory_order_relaxed ) == nullThreadId
                     || hprec->m_idOwner.load( atomics::memory_order_relaxed ) == mainThreadId
-                    || !cds::OS::isThreadAlive( hprec->m_idOwner.load( atomics::memory_order_relaxed ) )
+                    || !cds::OS::is_thread_alive( hprec->m_idOwner.load( atomics::memory_order_relaxed ) )
                 );
                 details::retired_vector& vect = hprec->m_arrRetired;
                 details::retired_vector::iterator itRetired = vect.begin();
                 details::retired_vector::iterator itRetiredEnd = vect.end();
                 while ( itRetired != itRetiredEnd ) {
-                    DeletePtr( *itRetired );
+                    itRetired->free();
                     ++itRetired;
                 }
                 vect.clear();
@@ -86,30 +86,24 @@ namespace cds { namespace gc {
 
         inline GarbageCollector::hplist_node * GarbageCollector::NewHPRec()
         {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_AllocNewHPRec );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_AllocNewHPRec )
             return new hplist_node( *this );
         }
 
         inline void GarbageCollector::DeleteHPRec( hplist_node * pNode )
         {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_DeleteHPRec );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_DeleteHPRec )
             assert( pNode->m_arrRetired.size() == 0 );
             delete pNode;
         }
 
-        inline void GarbageCollector::DeletePtr( details::retired_ptr& p )
+        details::hp_record * GarbageCollector::alloc_hp_record()
         {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_DeletedNode );
-            p.free();
-        }
-
-        details::HPRec * GarbageCollector::AllocateHPRec()
-        {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_AllocHPRec );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_AllocHPRec )
 
             hplist_node * hprec;
             const cds::OS::ThreadId nullThreadId = cds::OS::c_NullThreadId;
-            const cds::OS::ThreadId curThreadId  = cds::OS::getCurrentThreadId();
+            const cds::OS::ThreadId curThreadId  = cds::OS::get_current_thread_id();
 
             // First try to reuse a retired (non-active) HP record
             for ( hprec = m_pListHead.load( atomics::memory_order_acquire ); hprec; hprec = hprec->m_pNextNode ) {
@@ -136,13 +130,14 @@ namespace cds { namespace gc {
             return hprec;
         }
 
-        void GarbageCollector::RetireHPRec( details::HPRec * pRec )
+        void GarbageCollector::free_hp_record( details::hp_record * pRec )
         {
             assert( pRec != nullptr );
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_RetireHPRec );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_RetireHPRec )
 
             pRec->clear();
             Scan( pRec );
+            HelpScan( pRec );
             hplist_node * pNode = static_cast<hplist_node *>( pRec );
             pNode->m_idOwner.store( cds::OS::c_NullThreadId, atomics::memory_order_release );
         }
@@ -154,14 +149,14 @@ namespace cds { namespace gc {
             for ( hplist_node * hprec = m_pListHead.load(atomics::memory_order_acquire); hprec; hprec = pNext ) {
                 pNext = hprec->m_pNextNode;
                 if ( hprec->m_idOwner.load(atomics::memory_order_relaxed) != nullThreadId ) {
-                    RetireHPRec( hprec );
+                    free_hp_record( hprec );
                 }
             }
         }
 
-        void GarbageCollector::classic_scan( details::HPRec * pRec )
+        void GarbageCollector::classic_scan( details::hp_record * pRec )
         {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_ScanCallCount );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_ScanCallCount )
 
             std::vector< void * >   plist;
             plist.reserve( m_nMaxThreadCount * m_nHazardPointerCount );
@@ -189,25 +184,30 @@ namespace cds { namespace gc {
             details::retired_vector::iterator itRetired     = arrRetired.begin();
             details::retired_vector::iterator itRetiredEnd  = arrRetired.end();
             // arrRetired is not a std::vector!
-            // clear is just set up item counter to 0, the items is not destroying
+            // clear() is just set up item counter to 0, the items is not destroyed
             arrRetired.clear();
 
-            std::vector< void * >::iterator itBegin = plist.begin();
-            std::vector< void * >::iterator itEnd = plist.end();
-            while ( itRetired != itRetiredEnd ) {
-                if ( std::binary_search( itBegin, itEnd, itRetired->m_p) ) {
-                    CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_DeferredNode );
-                    arrRetired.push( *itRetired );
+            {
+                std::vector< void * >::iterator itBegin = plist.begin();
+                std::vector< void * >::iterator itEnd = plist.end();
+                size_t nDeferredCount = 0;
+                while ( itRetired != itRetiredEnd ) {
+                    if ( std::binary_search( itBegin, itEnd, itRetired->m_p ) ) {
+                        arrRetired.push( *itRetired );
+                        ++nDeferredCount;
+                    }
+                    else
+                        itRetired->free();
+                    ++itRetired;
                 }
-                else
-                    DeletePtr( *itRetired );
-                ++itRetired;
+                CDS_HAZARDPTR_STATISTIC( m_Stat.m_DeferredNode += nDeferredCount )
+                CDS_HAZARDPTR_STATISTIC( m_Stat.m_DeletedNode += (itRetiredEnd - arrRetired.begin()) - nDeferredCount )
             }
         }
 
-        void GarbageCollector::inplace_scan( details::HPRec * pRec )
+        void GarbageCollector::inplace_scan( details::hp_record * pRec )
         {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_ScanCallCount );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_ScanCallCount )
 
             // In-place scan algo uses LSB of retired ptr as a mark for internal purposes.
             // It is correct if all retired pointers are ar least 2-byte aligned (LSB is zero).
@@ -217,8 +217,8 @@ namespace cds { namespace gc {
             // LSB is used for marking pointers that cannot be deleted yet
             details::retired_vector::iterator itRetired     = pRec->m_arrRetired.begin();
             details::retired_vector::iterator itRetiredEnd  = pRec->m_arrRetired.end();
-            for ( details::retired_vector::iterator it = itRetired; it != itRetiredEnd; ++it ) {
-                if ( reinterpret_cast<ptr_atomic_t>(it->m_p) & 1 ) {
+            for ( auto it = itRetired; it != itRetiredEnd; ++it ) {
+                if ( it->m_n & 1 ) {
                     // found a pointer with LSB bit set - use classic_scan
                     classic_scan( pRec );
                     return;
@@ -228,51 +228,72 @@ namespace cds { namespace gc {
             // Sort retired pointer array
             std::sort( itRetired, itRetiredEnd, cds::gc::details::retired_ptr::less );
 
-            // Search guarded pointers in retired array
-
-            hplist_node * pNode = m_pListHead.load(atomics::memory_order_acquire);
+            // Check double free
+            /*
+            {
+                auto it = itRetired;
+                auto itPrev = it;
+                while ( ++it != itRetiredEnd ) {
+                    if ( it->m_p == itPrev->m_p )
+                        throw std::runtime_error( "Double free" );
+                    itPrev = it;
+                }
+            }
+            */
 
-            while ( pNode ) {
-                for ( size_t i = 0; i < m_nHazardPointerCount; ++i ) {
-                    void * hptr = pNode->m_hzp[i];
-                    if ( hptr ) {
-                        details::retired_ptr    dummyRetired;
-                        dummyRetired.m_p = hptr;
-                        details::retired_vector::iterator it = std::lower_bound( itRetired, itRetiredEnd, dummyRetired, cds::gc::details::retired_ptr::less );
-                        if ( it != itRetiredEnd && it->m_p == hptr )  {
-                            // Mark retired pointer as guarded
-                            it->m_p = reinterpret_cast<void *>(reinterpret_cast<ptr_atomic_t>(it->m_p ) | 1);
+            // Search guarded pointers in retired array
+            hplist_node * pNode = m_pListHead.load( atomics::memory_order_acquire );
+
+            {
+                details::retired_ptr dummyRetired;
+                while ( pNode ) {
+                    if ( !pNode->m_bFree.load( atomics::memory_order_acquire ) ) {
+                        for ( size_t i = 0; i < m_nHazardPointerCount; ++i ) {
+                            void * hptr = pNode->m_hzp[i];
+                            if ( hptr ) {
+                                dummyRetired.m_p = hptr;
+                                details::retired_vector::iterator it = std::lower_bound( itRetired, itRetiredEnd, dummyRetired, cds::gc::details::retired_ptr::less );
+                                if ( it != itRetiredEnd && it->m_p == hptr ) {
+                                    // Mark retired pointer as guarded
+                                    it->m_n |= 1;
+                                }
+                            }
                         }
                     }
+                    pNode = pNode->m_pNextNode;
                 }
-                pNode = pNode->m_pNextNode;
             }
 
             // Move all marked pointers to head of array
-            details::retired_vector::iterator itInsert = itRetired;
-            for ( details::retired_vector::iterator it = itRetired; it != itRetiredEnd; ++it ) {
-                if ( reinterpret_cast<ptr_atomic_t>(it->m_p) & 1 ) {
-                    it->m_p = reinterpret_cast<void *>(reinterpret_cast<ptr_atomic_t>(it->m_p ) & ~1);
-                    *itInsert = *it;
-                    ++itInsert;
-                    CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_DeferredNode );
-                }
-                else {
-                    // Retired pointer may be freed
-                    DeletePtr( *it );
+            {
+                auto itInsert = itRetired;
+                for ( auto it = itRetired; it != itRetiredEnd; ++it ) {
+                    if ( it->m_n & 1 ) {
+                        it->m_n &= ~1;
+                        if ( itInsert != it )
+                            *itInsert = *it;
+                        ++itInsert;
+                    }
+                    else {
+                        // Retired pointer may be freed
+                        it->free();
+                    }
                 }
+                const size_t nDeferred = itInsert - itRetired;
+                pRec->m_arrRetired.size( nDeferred );
+                CDS_HAZARDPTR_STATISTIC( m_Stat.m_DeferredNode += nDeferred )
+                CDS_HAZARDPTR_STATISTIC( m_Stat.m_DeletedNode += (itRetiredEnd - itRetired) - nDeferred )
             }
-            pRec->m_arrRetired.size( itInsert - itRetired );
         }
 
-        void GarbageCollector::HelpScan( details::HPRec * pThis )
+        void GarbageCollector::HelpScan( details::hp_record * pThis )
         {
-            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_HelpScanCallCount );
+            CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_HelpScanCallCount )
 
-            assert( static_cast<hplist_node *>(pThis)->m_idOwner.load(atomics::memory_order_relaxed) == cds::OS::getCurrentThreadId() );
+            assert( static_cast<hplist_node *>(pThis)->m_idOwner.load(atomics::memory_order_relaxed) == cds::OS::get_current_thread_id() );
 
             const cds::OS::ThreadId nullThreadId = cds::OS::c_NullThreadId;
-            const cds::OS::ThreadId curThreadId = cds::OS::getCurrentThreadId();
+            const cds::OS::ThreadId curThreadId = cds::OS::get_current_thread_id();
             for ( hplist_node * hprec = m_pListHead.load(atomics::memory_order_acquire); hprec; hprec = hprec->m_pNextNode ) {
 
                 // If m_bFree == true then hprec->m_arrRetired is empty - we don't need to see it
@@ -283,7 +304,7 @@ namespace cds { namespace gc {
                 // Several threads may work concurrently so we use atomic technique only.
                 {
                     cds::OS::ThreadId curOwner = hprec->m_idOwner.load(atomics::memory_order_acquire);
-                    if ( curOwner == nullThreadId || !cds::OS::isThreadAlive( curOwner )) {
+                    if ( curOwner == nullThreadId || !cds::OS::is_thread_alive( curOwner )) {
                         if ( !hprec->m_idOwner.compare_exchange_strong( curOwner, curThreadId, atomics::memory_order_release, atomics::memory_order_relaxed ))
                             continue;
                     }
@@ -294,7 +315,7 @@ namespace cds { namespace gc {
                     }
                 }
 
-                // We own the thread successfully. Now, we can see whether HPRec has retired pointers.
+                // We own the thread successfully. Now, we can see whether hp_record has retired pointers.
                 // If it has ones then we move to pThis that is private for current thread.
                 details::retired_vector& src = hprec->m_arrRetired;
                 details::retired_vector& dest = pThis->m_arrRetired;
@@ -304,7 +325,7 @@ namespace cds { namespace gc {
                 while ( itRetired != itRetiredEnd ) {
                     dest.push( *itRetired );
                     if ( dest.isFull()) {
-                        CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_CallScanFromHelpScan );
+                        CDS_HAZARDPTR_STATISTIC( ++m_Stat.m_CallScanFromHelpScan )
                         Scan( pThis );
                     }
                     ++itRetired;
@@ -313,6 +334,8 @@ namespace cds { namespace gc {
 
                 hprec->m_bFree.store(true, atomics::memory_order_release);
                 hprec->m_idOwner.store( nullThreadId, atomics::memory_order_release );
+
+                Scan( pThis );
             }
         }
 
@@ -360,5 +383,5 @@ namespace cds { namespace gc {
         }
 
 
-    } //namespace hzp
+    } //namespace hp
 }} // namespace cds::gc