2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
6 Source code repo: http://github.com/khizmax/libcds/
7 Download: http://sourceforge.net/projects/libcds/files/
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 this list of conditions and the following disclaimer in the documentation
17 and/or other materials provided with the distribution.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef CDSLIB_URCU_DETAILS_GPI_H
32 #define CDSLIB_URCU_DETAILS_GPI_H
35 #include <cds/urcu/details/gp.h>
36 #include <cds/algo/backoff_strategy.h>
38 namespace cds { namespace urcu {
40 /// User-space general-purpose RCU with immediate reclamation
42 @headerfile cds/urcu/general_instant.h
44 This is simplest general-purpose RCU implementation. When a thread calls \ref retire_ptr function
45 the RCU \p synchronize function is called that waits until all reader/updater threads end up
46 their read-side critical sections, i.e. until the RCU quiescent state will come.
47 After that the retired object is freed immediately.
48 Thus, the implementation blocks for any retired object
50 There is a wrapper \ref cds_urcu_general_instant_gc "gc<general_instant>" for \p %general_instant class
51 that provides unified RCU interface. You should use this wrapper class instead \p %general_instant
54 - \p Lock - mutex type, default is \p std::mutex
55 - \p Backoff - back-off schema, default is cds::backoff::Default
58 class Lock = std::mutex
59 ,class Backoff = cds::backoff::Default
61 class general_instant: public details::gp_singleton< general_instant_tag >
64 typedef details::gp_singleton< general_instant_tag > base_class;
68 typedef general_instant_tag rcu_tag ; ///< RCU tag
69 typedef Lock lock_type ; ///< Lock type
70 typedef Backoff back_off ; ///< Back-off schema type
72 typedef typename base_class::thread_gc thread_gc ; ///< Thread-side RCU part
73 typedef typename thread_gc::scoped_lock scoped_lock ; ///< Access lock class
76 static bool const c_bBuffered = false ; ///< No buffers
81 typedef details::gp_singleton_instance< rcu_tag > singleton_ptr;
90 /// Returns singleton instance
91 static general_instant * instance()
93 return static_cast<general_instant *>( base_class::instance());
96 /// Checks if the singleton is created and ready to use
99 return singleton_ptr::s_pRCU != nullptr;
113 base_class::flip_and_wait( bkoff );
118 /// Creates singleton object
119 static void Construct()
121 if ( !singleton_ptr::s_pRCU )
122 singleton_ptr::s_pRCU = new general_instant();
125 /// Destroys singleton object
126 static void Destruct( bool bDetachAll = false )
130 instance()->m_ThreadList.detach_all();
132 singleton_ptr::s_pRCU = nullptr;
137 /// Retires \p p pointer
139 The method calls \p synchronize() to wait for the end of grace period
140 and calls \p p disposer.
142 virtual void retire_ptr( retired_ptr& p ) override
149 /// Retires the pointer chain [\p itFirst, \p itLast)
150 template <typename ForwardIterator>
151 void batch_retire( ForwardIterator itFirst, ForwardIterator itLast )
153 if ( itFirst != itLast ) {
155 while ( itFirst != itLast ) {
156 retired_ptr p( *itFirst );
164 /// Retires the pointer chain until \p Func returns \p nullptr retired pointer
165 template <typename Func>
166 void batch_retire( Func e )
168 retired_ptr p{ e() };
179 /// Waits to finish a grace period
182 assert( !thread_gc::is_locked());
183 std::unique_lock<lock_type> sl( m_Lock );
189 // Added for uniformity
190 size_t CDS_CONSTEXPR capacity() const
197 /// User-space general-purpose RCU with immediate reclamation (stripped version)
199 @headerfile cds/urcu/general_instant.h
201 This short version of \p general_instant is intended for stripping debug info.
202 If you use \p %general_instant with default template arguments you may use
203 this stripped version. All functionality of both classes are identical.
205 class general_instant_stripped: public general_instant<>
208 }} // namespace cds::urcu
210 #endif // #ifndef CDSLIB_URCU_DETAILS_GPI_H