Removed redundant spaces
[libcds.git] / cds / urcu / details / gpi.h
index 0f0de150b8876c5b65925c2100c923e363b31af5..71b310e58542e665b8ee120d2fcfbb4385c100ec 100644 (file)
@@ -1,12 +1,39 @@
-//$$CDS-header$$
+/*
+    This file is a part of libcds - Concurrent Data Structures library
 
-#ifndef _CDS_URCU_DETAILS_GPI_H
-#define _CDS_URCU_DETAILS_GPI_H
+    (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
+
+    Source code repo: http://github.com/khizmax/libcds/
+    Download: http://sourceforge.net/projects/libcds/files/
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef CDSLIB_URCU_DETAILS_GPI_H
+#define CDSLIB_URCU_DETAILS_GPI_H
 
 #include <mutex>
 #include <cds/urcu/details/gp.h>
 #include <cds/algo/backoff_strategy.h>
-#include <cds/lock/scoped_lock.h>
 
 namespace cds { namespace urcu {
 
@@ -61,7 +88,7 @@ namespace cds { namespace urcu {
         /// Returns singleton instance
         static general_instant * instance()
         {
-            return static_cast<general_instant *>( base_class::instance() );
+            return static_cast<general_instant *>( base_class::instance());
         }
 
         /// Checks if the singleton is created and ready to use
@@ -74,6 +101,7 @@ namespace cds { namespace urcu {
         //@cond
         general_instant()
         {}
+
         ~general_instant()
         {}
 
@@ -95,7 +123,7 @@ namespace cds { namespace urcu {
         /// Destroys singleton object
         static void Destruct( bool bDetachAll = false )
         {
-            if ( isUsed() ) {
+            if ( isUsed()) {
                 if ( bDetachAll )
                     instance()->m_ThreadList.detach_all();
                 delete instance();
@@ -106,7 +134,7 @@ namespace cds { namespace urcu {
     public:
         /// Retires \p p pointer
         /**
-            The method calls \ref synchronize to wait for the end of grace period
+            The method calls \p synchronize() to wait for the end of grace period
             and calls \p p disposer.
         */
         virtual void retire_ptr( retired_ptr& p )
@@ -131,16 +159,28 @@ namespace cds { namespace urcu {
             }
         }
 
+        /// Retires the pointer chain until \p Func returns \p nullptr retired pointer
+        template <typename Func>
+        void batch_retire( Func e )
+        {
+            retired_ptr p{ e() };
+            if ( p.m_p ) {
+                synchronize();
+                while ( p.m_p ) {
+                    retired_ptr pr( p );
+                    p = e();
+                    pr.free();
+                }
+            }
+        }
+
         /// Waits to finish a grace period
         void synchronize()
         {
-            CDS_ATOMIC::atomic_thread_fence( CDS_ATOMIC::memory_order_acquire );
-            {
-                cds::lock::scoped_lock<lock_type> sl( m_Lock );
-                flip_and_wait();
-                flip_and_wait();
-            }
-            CDS_ATOMIC::atomic_thread_fence( CDS_ATOMIC::memory_order_release );
+            assert( !thread_gc::is_locked());
+            std::unique_lock<lock_type> sl( m_Lock );
+            flip_and_wait();
+            flip_and_wait();
         }
 
         //@cond
@@ -152,6 +192,17 @@ namespace cds { namespace urcu {
         //@endcond
     };
 
+    /// User-space general-purpose RCU with immediate reclamation (stripped version)
+    /**
+        @headerfile cds/urcu/general_instant.h
+
+        This short version of \p general_instant is intended for stripping debug info.
+        If you use \p %general_instant with default template arguments you may use
+        this stripped version. All functionality of both classes are identical.
+    */
+    class general_instant_stripped: public general_instant<>
+    {};
+
 }} // namespace cds::urcu
 
-#endif // #ifndef _CDS_URCU_DETAILS_GPI_H
+#endif // #ifndef CDSLIB_URCU_DETAILS_GPI_H