Removed trailing spaces
[libcds.git] / cds / memory / vyukov_queue_pool.h
index 0d29b98a4f5dd7ddf827e13e64494e5abf40377e..432a7f02d9aeaeeabb68547c65788dd9e5943ff2 100644 (file)
@@ -1,11 +1,11 @@
 /*
     This file is a part of libcds - Concurrent Data Structures library
 
-    (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
+    (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
 
     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:
 
@@ -25,7 +25,7 @@
     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.     
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
 #ifndef CDSLIB_MEMORY_VYUKOV_QUEUE_ALLOCATOR_H
@@ -33,6 +33,7 @@
 
 #include <cds/details/allocator.h>
 #include <cds/intrusive/vyukov_mpmc_cycle_queue.h>
+#include <cds/details/throw_exception.h>
 
 namespace cds { namespace memory {
 
@@ -48,7 +49,7 @@ namespace cds { namespace memory {
     /// Free-list based on bounded lock-free queue \p cds::intrusive::VyukovMPMCCycleQueue
     /** @ingroup cds_memory_pool
         Template parameters:
-        - \p T - the type of object maintaining by free-list
+        - \p T - the type of object maintaining by free-list. \p T must be default constructible.
         - \p Traits - traits for \p cds::intrusive::VyukovMPMCCycleQueue class plus
             \p cds::opt::allocator option, defaul is \p vyukov_queue_pool_traits
 
@@ -76,7 +77,7 @@ namespace cds { namespace memory {
         // Pool of Foo object of size 1024.
         struct pool_traits: public cds::memory::vyukov_queue_pool_traits
         {
-            typedef cds::opt::v::static_buffer< Foo, 1024 > buffer;
+            typedef cds::opt::v::uninitialized_static_buffer< Foo, 1024 > buffer;
         };
         typedef cds::memory::vyukov_queue_pool< Foo, pool_traits > pool_type;
         static pool_type thePool;
@@ -124,6 +125,7 @@ namespace cds { namespace memory {
     protected:
         //@cond
         typedef cds::details::Allocator< value_type, allocator_type >   cxx_allocator;
+        typedef typename cxx_allocator::allocator_type std_allocator;
 
         queue_type      m_Queue;
         value_type *    m_pFirst;
@@ -134,7 +136,7 @@ namespace cds { namespace memory {
         //@cond
         void preallocate_pool()
         {
-            m_pFirst = cxx_allocator().NewArray( m_Queue.capacity() );
+            m_pFirst = std_allocator().allocate( m_Queue.capacity());
             m_pLast = m_pFirst + m_Queue.capacity();
 
             for ( value_type * p = m_pFirst; p < m_pLast; ++p ) {
@@ -165,13 +167,13 @@ namespace cds { namespace memory {
         ~vyukov_queue_pool()
         {
             m_Queue.clear();
-            cxx_allocator().Delete( m_pFirst, m_Queue.capacity());
+            std_allocator().deallocate( m_pFirst, m_Queue.capacity());
         }
 
         /// Allocates an object from pool
         /**
             The pool supports allocation only single object (\p n = 1).
-            If \p n > 1 the behaviour is undefined.
+            If \p n > 1 the behavior is undefined.
 
             If the queue is not empty, the popped value is returned.
             Otherwise, a new value allocated.
@@ -183,8 +185,8 @@ namespace cds { namespace memory {
 
             value_type * p = m_Queue.pop();
             if ( p ) {
-                assert( from_pool(p) );
-                return p;
+                assert( from_pool(p));
+                return new( p ) value_type;
             }
             // The pool is empty - allocate new from the heap
             return cxx_allocator().New();
@@ -193,7 +195,7 @@ namespace cds { namespace memory {
         /// Deallocated the object \p p
         /**
             The pool supports allocation only single object (\p n = 1).
-            If \p n > 1 the behaviour is undefined.
+            If \p n > 1 the behavior is undefined.
 
             If \p p is from preallocated pool, it pushes into the queue.
             Otherwise, \p p is deallocated by allocator provided.
@@ -204,7 +206,8 @@ namespace cds { namespace memory {
             CDS_UNUSED(n);
 
             if ( p ) {
-                if ( from_pool(p) ) {
+                if ( from_pool(p)) {
+                    p->~value_type();
                     // The queue can notify about false fullness state
                     // so we push in loop
                     back_off bkoff;
@@ -221,9 +224,9 @@ namespace cds { namespace memory {
     /// Lazy free-list based on bounded lock-free queue \p cds::intrusive::VyukovMPMCCycleQueue
     /** @ingroup cds_memory_pool
         Template parameters:
-        - \p T - the type of object maintaining by free-list
+        - \p T - the type of object maintaining by free-list. \p T must be default constructible
         - \p Traits - traits for \p cds::intrusive::VyukovMPMCCycleQueue class plus
-            \p cds::opt::allocator option, defaul is \p vyukov_queue_pool_traits
+            \p cds::opt::allocator option, default is \p vyukov_queue_pool_traits
 
         \b Internals
 
@@ -292,6 +295,7 @@ namespace cds { namespace memory {
     protected:
         //@cond
         typedef cds::details::Allocator< value_type, allocator_type >   cxx_allocator;
+        typedef typename cxx_allocator::allocator_type std_allocator;
 
         queue_type      m_Queue;
         //@endcond
@@ -305,15 +309,15 @@ namespace cds { namespace memory {
         /// Deallocates all objects from the pool
         ~lazy_vyukov_queue_pool()
         {
-            cxx_allocator a;
-            while ( !m_Queue.empty() )
-                a.Delete( m_Queue.pop());
+            std_allocator a;
+            while ( !m_Queue.empty())
+                a.deallocate( m_Queue.pop(), 1 );
         }
 
         /// Allocates an object from pool
         /**
             The pool supports allocation only single object (\p n = 1).
-            If \p n > 1 the behaviour is undefined.
+            If \p n > 1 the behavior is undefined.
 
             If the queue is not empty, the popped value is returned.
             Otherwise, a new value allocated.
@@ -325,7 +329,7 @@ namespace cds { namespace memory {
 
             value_type * p = m_Queue.pop();
             if ( p )
-                return p;
+                return new( p ) value_type;
 
             return cxx_allocator().New();
         }
@@ -344,9 +348,10 @@ namespace cds { namespace memory {
             CDS_UNUSED(n);
 
             if ( p ) {
+                p->~value_type();
                 // Here we ignore false fullness state of the queue
                 if ( !m_Queue.push( *p ))
-                    cxx_allocator().Delete( p );
+                    std_allocator().deallocate( p, 1 );
             }
         }
 
@@ -355,7 +360,7 @@ namespace cds { namespace memory {
     /// Bounded free-list based on bounded lock-free queue \p cds::intrusive::VyukovMPMCCycleQueue
     /** @ingroup cds_memory_pool
         Template parameters:
-        - \p T - the type of object maintaining by free-list
+        - \p T - the type of object maintaining by free-list. \p T must be default-constructible
         - \p Traits - traits for \p cds::intrusive::VyukovMPMCCycleQueue class plus
             \p cds::opt::allocator option, defaul is \p vyukov_queue_pool_traits
 
@@ -383,7 +388,7 @@ namespace cds { namespace memory {
         // Pool of Foo object of size 1024.
         struct pool_traits: public cds::memory::vyukov_queue_pool_traits
         {
-            typedef cds::opt::v::static_buffer< Foo, 1024 > buffer;
+            typedef cds::opt::v::uninitialized_static_buffer< Foo, 1024 > buffer;
         };
         typedef cds::memory::bounded_vyukov_queue_pool< Foo, pool_traits > pool_type;
         static pool_type thePool;
@@ -435,7 +440,8 @@ namespace cds { namespace memory {
 
     protected:
         //@cond
-        typedef cds::details::Allocator< value_type, allocator_type >   cxx_allocator;
+        typedef cds::details::Allocator< value_type, allocator_type > cxx_allocator;
+        typedef typename cxx_allocator::allocator_type std_allocator;
 
         queue_type      m_Queue;
         value_type *    m_pFirst;
@@ -447,7 +453,7 @@ namespace cds { namespace memory {
         void preallocate_pool()
         {
             size_t const nCount = m_Queue.capacity();
-            m_pFirst = cxx_allocator().NewArray( nCount );
+            m_pFirst = std_allocator().allocate( nCount );
             m_pLast = m_pFirst + nCount;
 
             for ( value_type * p = m_pFirst; p < m_pLast; ++p )
@@ -477,7 +483,7 @@ namespace cds { namespace memory {
         ~bounded_vyukov_queue_pool()
         {
             m_Queue.clear();
-            cxx_allocator().Delete( m_pFirst, m_Queue.capacity() );
+            std_allocator().deallocate( m_pFirst, m_Queue.capacity());
         }
 
         /// Allocates an object from pool
@@ -497,7 +503,7 @@ namespace cds { namespace memory {
 
             if ( !p ) {
                 back_off bkoff;
-                while ( m_Queue.size() ) {
+                while ( m_Queue.size()) {
                     p = m_Queue.pop();
                     if ( p )
                         goto ok;
@@ -505,11 +511,11 @@ namespace cds { namespace memory {
                 }
 
                 // The pool is empty
-                throw std::bad_alloc();
+                CDS_THROW_EXCEPTION( std::bad_alloc());
             }
 
         ok:
-            assert( from_pool(p) );
+            assert( from_pool(p));
             return p;
         }
 
@@ -530,7 +536,7 @@ namespace cds { namespace memory {
                 back_off bkoff;
                 // The queue can notify it is full but that is false fullness state
                 // So, we push in loop
-                while ( !m_Queue.push(*p) )
+                while ( !m_Queue.push(*p))
                     bkoff();
             }
         }