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