cds/intrusive/free_list_tagged.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_INTRUSIVE_FREE_LIST_TAGGED_H
  32 #define CDSLIB_INTRUSIVE_FREE_LIST_TAGGED_H
  33
  34 #include <cds/algo/atomic.h>
  35
  36 namespace cds { namespace intrusive {
  37
  38     /// Lock-free free list based on tagged pointers (required double-width CAS)
  39     /** @ingroup cds_intrusive_freelist
  40
  41         This variant of \p FreeList is intended for processor architectures that support double-width CAS.
  42         It uses <a href="https://en.wikipedia.org/wiki/Tagged_pointer">tagged pointer</a> technique to solve ABA problem.
  43
  44         \b How to use
  45         \code
  46         #include <cds/intrusive/free_list_tagged.h>
  47
  48         // Your struct should be derived from TaggedFreeList::node
  49         struct Foo: public cds::intrusive::TaggedFreeList::node
  50         {
  51             // Foo fields
  52         };
  53
  54         // Simplified Foo allocator
  55         class FooAllocator
  56         {
  57         public:
  58             // free-list clear() must be explicitly called before destroying the free-list object
  59             ~FooAllocator()
  60             {
  61                 m_FreeList.clear( []( freelist_node * p ) { delete static_cast<Foo *>( p ); });
  62             }
  63
  64             Foo * alloc()
  65             {
  66                 freelist_node * p = m_FreeList.get();
  67                 if ( p )
  68                     return static_cast<Foo *>( p );
  69                 return new Foo;
  70             };
  71
  72             void dealloc( Foo * p )
  73             {
  74                 m_FreeList.put( static_cast<freelist_node *>( p ));
  75             };
  76
  77         private:
  78             typedef cds::intrusive::TaggedFreeList::node freelist_node;
  79             cds::intrusive::TaggedFreeList m_FreeList;
  80         };
  81         \endcode
  82     */
  83     class TaggedFreeList
  84     {
  85     public:
  86         struct node {
  87             //@cond
  88             atomics::atomic<node *> m_freeListNext;
  89
  90             node()
  91                 : m_freeListNext( nullptr )
  92             {}
  93             //@endcond
  94         };
  95
  96     private:
  97         //@cond
  98         struct tagged_ptr
  99         {
 100             node *    ptr;
 101             uintptr_t tag;
 102
 103             tagged_ptr()
 104                 : ptr( nullptr )
 105                 , tag( 0 )
 106             {}
 107
 108             tagged_ptr( node* p )
 109                 : ptr( p )
 110                 , tag( 0 )
 111             {}
 112         };
 113
 114         static_assert(sizeof( tagged_ptr ) == sizeof( void * ) * 2, "sizeof( tagged_ptr ) violation");
 115         //@endcond
 116
 117     public:
 118         /// Creates empty free-list
 119         TaggedFreeList()
 120             : m_Head( tagged_ptr())
 121         {
 122             // Your platform must support double-width CAS
 123             assert( m_Head.is_lock_free());
 124         }
 125
 126         /// Destroys the free list. Free-list must be empty.
 127         /**
 128             @warning dtor does not free elements of the list.
 129             To free elements you should manually call \p clear() with an appropriate disposer.
 130         */
 131         ~TaggedFreeList()
 132         {
 133             assert( empty() );
 134         }
 135
 136         /// Puts \p pNode to the free list
 137         void put( node * pNode )
 138         {
 139             assert( m_Head.is_lock_free());
 140
 141             tagged_ptr currentHead = m_Head.load( atomics::memory_order_relaxed );
 142             tagged_ptr newHead = { pNode };
 143             do {
 144                 newHead.tag = currentHead.tag + 1;
 145                 pNode->m_freeListNext.store( currentHead.ptr, atomics::memory_order_relaxed );
 146             } while ( cds_unlikely( !m_Head.compare_exchange_weak( currentHead, newHead, atomics::memory_order_release, atomics::memory_order_relaxed )));
 147         }
 148
 149         /// Gets a node from the free list. If the list is empty, returns \p nullptr
 150         node * get()
 151         {
 152             tagged_ptr currentHead = m_Head.load( atomics::memory_order_acquire );
 153             tagged_ptr newHead;
 154             while ( currentHead.ptr != nullptr ) {
 155                 newHead.ptr = currentHead.ptr->m_freeListNext.load( atomics::memory_order_relaxed );
 156                 newHead.tag = currentHead.tag + 1;
 157                 if ( cds_likely( m_Head.compare_exchange_weak( currentHead, newHead, atomics::memory_order_release, atomics::memory_order_acquire )))
 158                     break;
 159             }
 160             return currentHead.ptr;
 161         }
 162
 163         /// Checks whether the free list is empty
 164         bool empty() const
 165         {
 166             return m_Head.load( atomics::memory_order_relaxed ).ptr == nullptr;
 167         }
 168
 169         /// Clears the free list (not atomic)
 170         /**
 171             For each element \p disp disposer is called to free memory.
 172             The \p Disposer interface:
 173             \code
 174             struct disposer
 175             {
 176                 void operator()( FreeList::node * node );
 177             };
 178             \endcode
 179
 180             This method must be explicitly called before the free list destructor.
 181         */
 182         template <typename Disposer>
 183         void clear( Disposer disp )
 184         {
 185             node * head = m_Head.load( atomics::memory_order_relaxed ).ptr;
 186             m_Head.store( { nullptr }, atomics::memory_order_relaxed );
 187             while ( head ) {
 188                 node * next = head->m_freeListNext.load( atomics::memory_order_relaxed );
 189                 disp( head );
 190                 head = next;
 191             }
 192         }
 193
 194     private:
 195         //@cond
 196         atomics::atomic<tagged_ptr> m_Head;
 197         //@endcond
 198     };
 199
 200 }} // namespace cds::intrusive
 201
 202 #endif // CDSLIB_INTRUSIVE_FREE_LIST_TAGGED_H