Added stripped classes for uRCU implementations

[libcds.git] / cds / urcu / general_instant.h

diff --git a/cds/urcu/general_instant.h b/cds/urcu/general_instant.h
index c0c128cdb5b2d1805d6f93919c3be52fd85598a9..6dca6a684e6a94c16981ca4a5a464404b5fe9201 100644 (file)
--- a/cds/urcu/general_instant.h
+++ b/cds/urcu/general_instant.h
@@ -1,7 +1,35 @@
-//$$CDS-header$$
-
-#ifndef _CDS_URCU_GENERAL_INSTANT_H
-#define _CDS_URCU_GENERAL_INSTANT_H
+/*
+    This file is a part of libcds - Concurrent Data Structures library
+
+    (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_GENERAL_INSTANT_H
+#define CDSLIB_URCU_GENERAL_INSTANT_H
 
 #include <cds/urcu/details/gpi.h>
 
@@ -10,11 +38,11 @@ namespace cds { namespace urcu {
     /// User-space general-purpose RCU with immediate reclamation
     /** @anchor cds_urcu_general_instant_gc
 
-        This is a wrapper around general_instant class used for metaprogramming.
+        This is a wrapper around \p general_instant class.
 
         Template arguments:
         - \p Lock - mutex type, default is \p std::mutex
-        - \p Backoff - back-off schema, default is cds::backoff::Default
+        - \p Backoff - back-off schema, default is \p cds::backoff::Default
     */
     template <
 #ifdef CDS_DOXGEN_INVOKED
@@ -96,6 +124,13 @@ namespace cds { namespace urcu {
             rcu_implementation::instance()->batch_retire( itFirst, itLast );
         }
 
+        /// Retires the pointer chain until \p Func returns \p nullptr retired pointer
+        template <typename Func>
+        static void batch_retire( Func e )
+        {
+            rcu_implementation::instance()->batch_retire( e );
+        }
+
         /// Acquires access lock (so called RCU reader-side lock)
         /**
             For safety reasons, it is better to use \ref scoped_lock class for locking/unlocking
@@ -133,6 +168,12 @@ namespace cds { namespace urcu {
         {}
     };
 
+    //@cond
+    template<>
+    class gc< general_instant_stripped >: public gc< general_instant<>>
+    {};
+    //@endcond
+
 }} // namespace cds::urcu
 
-#endif // #ifndef _CDS_URCU_GENERAL_INSTANT_H
+#endif // #ifndef CDSLIB_URCU_GENERAL_INSTANT_H