cds/urcu/details/gpi.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  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.
  18
  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.
  29 */
  30
  31 #ifndef CDSLIB_URCU_DETAILS_GPI_H
  32 #define CDSLIB_URCU_DETAILS_GPI_H
  33
  34 #include <mutex>
  35 #include <cds/urcu/details/gp.h>
  36 #include <cds/algo/backoff_strategy.h>
  37
  38 namespace cds { namespace urcu {
  39
  40     /// User-space general-purpose RCU with immediate reclamation
  41     /**
  42         @headerfile cds/urcu/general_instant.h
  43
  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
  49
  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
  52
  53         Template arguments:
  54         - \p Lock - mutex type, default is \p std::mutex
  55         - \p Backoff - back-off schema, default is cds::backoff::Default
  56     */
  57     template <
  58         class Lock = std::mutex
  59        ,class Backoff = cds::backoff::Default
  60     >
  61     class general_instant: public details::gp_singleton< general_instant_tag >
  62     {
  63         //@cond
  64         typedef details::gp_singleton< general_instant_tag > base_class;
  65         //@endcond
  66
  67     public:
  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
  71
  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
  74
  75         static bool const c_bBuffered = false ; ///< This RCU does not buffer disposed elements
  76
  77     protected:
  78         //@cond
  79         typedef details::gp_singleton_instance< rcu_tag >    singleton_ptr;
  80         //@endcond
  81
  82     protected:
  83         //@cond
  84         lock_type   m_Lock;
  85         //@endcond
  86
  87     public:
  88         /// Returns singleton instance
  89         static general_instant * instance()
  90         {
  91             return static_cast<general_instant *>( base_class::instance());
  92         }
  93
  94         /// Checks if the singleton is created and ready to use
  95         static bool isUsed()
  96         {
  97             return singleton_ptr::s_pRCU != nullptr;
  98         }
  99
 100     protected:
 101         //@cond
 102         general_instant()
 103         {}
 104
 105         ~general_instant()
 106         {}
 107
 108         void flip_and_wait()
 109         {
 110             back_off bkoff;
 111             base_class::flip_and_wait( bkoff );
 112         }
 113         //@endcond
 114
 115     public:
 116         /// Creates singleton object
 117         static void Construct()
 118         {
 119             if ( !singleton_ptr::s_pRCU )
 120                 singleton_ptr::s_pRCU = new general_instant();
 121         }
 122
 123         /// Destroys singleton object
 124         static void Destruct( bool bDetachAll = false )
 125         {
 126             if ( isUsed() ) {
 127                 if ( bDetachAll )
 128                     instance()->m_ThreadList.detach_all();
 129                 delete instance();
 130                 singleton_ptr::s_pRCU = nullptr;
 131             }
 132         }
 133
 134     public:
 135         /// Retires \p p pointer
 136         /**
 137             The method calls \p synchronize() to wait for the end of grace period
 138             and calls \p p disposer.
 139         */
 140         virtual void retire_ptr( retired_ptr& p )
 141         {
 142             synchronize();
 143             if ( p.m_p )
 144                 p.free();
 145         }
 146
 147         /// Retires the pointer chain [\p itFirst, \p itLast)
 148         template <typename ForwardIterator>
 149         void batch_retire( ForwardIterator itFirst, ForwardIterator itLast )
 150         {
 151             if ( itFirst != itLast ) {
 152                 synchronize();
 153                 while ( itFirst != itLast ) {
 154                     retired_ptr p( *itFirst );
 155                     ++itFirst;
 156                     if ( p.m_p )
 157                         p.free();
 158                 }
 159             }
 160         }
 161
 162         /// Retires the pointer chain until \p Func returns \p nullptr retired pointer
 163         template <typename Func>
 164         void batch_retire( Func e )
 165         {
 166             retired_ptr p{ e() };
 167             if ( p.m_p ) {
 168                 synchronize();
 169                 while ( p.m_p ) {
 170                     retired_ptr pr( p );
 171                     p = e();
 172                     pr.free();
 173                 }
 174             }
 175         }
 176
 177         /// Waits to finish a grace period
 178         void synchronize()
 179         {
 180             assert( !thread_gc::is_locked());
 181             std::unique_lock<lock_type> sl( m_Lock );
 182             flip_and_wait();
 183             flip_and_wait();
 184         }
 185
 186         //@cond
 187         // Added for uniformity
 188         size_t CDS_CONSTEXPR capacity() const
 189         {
 190             return 1;
 191         }
 192         //@endcond
 193     };
 194
 195     /// User-space general-purpose RCU with immediate reclamation (stripped version)
 196     /**
 197         @headerfile cds/urcu/general_instant.h
 198
 199         This short version of \p general_instant is intended for stripping debug info.
 200         If you use \p %general_instant with default template arguments you may use
 201         this stripped version. All functionality of both classes are identical.
 202     */
 203     class general_instant_stripped: public general_instant<>
 204     {};
 205
 206 }} // namespace cds::urcu
 207
 208 #endif // #ifndef CDSLIB_URCU_DETAILS_GPI_H