/Src/Dependencies/Boost/boost/interprocess/allocators/private_node_allocator.hpp
http://hadesmem.googlecode.com/ · C++ Header · 442 lines · 247 code · 76 blank · 119 comment · 3 complexity · fae33fe5380c00960d5288c794ab5aac MD5 · raw file
- //////////////////////////////////////////////////////////////////////////////
- //
- // (C) Copyright Ion Gaztanaga 2005-2009. Distributed under the Boost
- // Software License, Version 1.0. (See accompanying file
- // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
- //
- // See http://www.boost.org/libs/interprocess for documentation.
- //
- //////////////////////////////////////////////////////////////////////////////
- #ifndef BOOST_INTERPROCESS_PRIVATE_NODE_ALLOCATOR_HPP
- #define BOOST_INTERPROCESS_PRIVATE_NODE_ALLOCATOR_HPP
- #if (defined _MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif
- #include <boost/interprocess/detail/config_begin.hpp>
- #include <boost/interprocess/detail/workaround.hpp>
- #include <boost/pointer_to_other.hpp>
- #include <boost/interprocess/interprocess_fwd.hpp>
- #include <boost/assert.hpp>
- #include <boost/utility/addressof.hpp>
- #include <boost/interprocess/allocators/detail/node_pool.hpp>
- #include <boost/interprocess/containers/container/detail/multiallocation_chain.hpp>
- #include <boost/interprocess/exceptions.hpp>
- #include <boost/interprocess/detail/utilities.hpp>
- #include <boost/interprocess/detail/workaround.hpp>
- #include <memory>
- #include <algorithm>
- #include <cstddef>
- //!\file
- //!Describes private_node_allocator_base pooled shared memory STL compatible allocator
- namespace boost {
- namespace interprocess {
- /// @cond
- namespace detail {
- template < unsigned int Version
- , class T
- , class SegmentManager
- , std::size_t NodesPerBlock
- >
- class private_node_allocator_base
- : public node_pool_allocation_impl
- < private_node_allocator_base < Version, T, SegmentManager, NodesPerBlock>
- , Version
- , T
- , SegmentManager
- >
- {
- public:
- //Segment manager
- typedef SegmentManager segment_manager;
- typedef typename SegmentManager::void_pointer void_pointer;
- /// @cond
- private:
- typedef private_node_allocator_base
- < Version, T, SegmentManager, NodesPerBlock> self_t;
- typedef detail::private_node_pool
- <SegmentManager
- , sizeof_value<T>::value
- , NodesPerBlock
- > node_pool_t;
- BOOST_STATIC_ASSERT((Version <=2));
- /// @endcond
- public:
- typedef typename boost::
- pointer_to_other<void_pointer, T>::type pointer;
- typedef typename boost::
- pointer_to_other<void_pointer, const T>::type const_pointer;
- typedef T value_type;
- typedef typename detail::add_reference
- <value_type>::type reference;
- typedef typename detail::add_reference
- <const value_type>::type const_reference;
- typedef std::size_t size_type;
- typedef std::ptrdiff_t difference_type;
- typedef boost::interprocess::version_type
- <private_node_allocator_base, Version> version;
- typedef boost::container::containers_detail::transform_multiallocation_chain
- <typename SegmentManager::multiallocation_chain, T>multiallocation_chain;
- //!Obtains node_allocator from other node_allocator
- template<class T2>
- struct rebind
- {
- typedef private_node_allocator_base
- <Version, T2, SegmentManager, NodesPerBlock> other;
- };
- /// @cond
- template <int dummy>
- struct node_pool
- {
- typedef detail::private_node_pool
- <SegmentManager
- , sizeof_value<T>::value
- , NodesPerBlock
- > type;
- static type *get(void *p)
- { return static_cast<type*>(p); }
- };
- private:
- //!Not assignable from related private_node_allocator_base
- template<unsigned int Version2, class T2, class MemoryAlgorithm2, std::size_t N2>
- private_node_allocator_base& operator=
- (const private_node_allocator_base<Version2, T2, MemoryAlgorithm2, N2>&);
- //!Not assignable from other private_node_allocator_base
- private_node_allocator_base& operator=(const private_node_allocator_base&);
- /// @endcond
- public:
- //!Constructor from a segment manager
- private_node_allocator_base(segment_manager *segment_mngr)
- : m_node_pool(segment_mngr)
- {}
- //!Copy constructor from other private_node_allocator_base. Never throws
- private_node_allocator_base(const private_node_allocator_base &other)
- : m_node_pool(other.get_segment_manager())
- {}
- //!Copy constructor from related private_node_allocator_base. Never throws.
- template<class T2>
- private_node_allocator_base
- (const private_node_allocator_base
- <Version, T2, SegmentManager, NodesPerBlock> &other)
- : m_node_pool(other.get_segment_manager())
- {}
- //!Destructor, frees all used memory. Never throws
- ~private_node_allocator_base()
- {}
- //!Returns the segment manager. Never throws
- segment_manager* get_segment_manager()const
- { return m_node_pool.get_segment_manager(); }
- //!Returns the internal node pool. Never throws
- node_pool_t* get_node_pool() const
- { return const_cast<node_pool_t*>(&m_node_pool); }
- //!Swaps allocators. Does not throw. If each allocator is placed in a
- //!different shared memory segments, the result is undefined.
- friend void swap(self_t &alloc1,self_t &alloc2)
- { alloc1.m_node_pool.swap(alloc2.m_node_pool); }
- /// @cond
- private:
- node_pool_t m_node_pool;
- /// @endcond
- };
- //!Equality test for same type of private_node_allocator_base
- template<unsigned int V, class T, class S, std::size_t NPC> inline
- bool operator==(const private_node_allocator_base<V, T, S, NPC> &alloc1,
- const private_node_allocator_base<V, T, S, NPC> &alloc2)
- { return &alloc1 == &alloc2; }
- //!Inequality test for same type of private_node_allocator_base
- template<unsigned int V, class T, class S, std::size_t NPC> inline
- bool operator!=(const private_node_allocator_base<V, T, S, NPC> &alloc1,
- const private_node_allocator_base<V, T, S, NPC> &alloc2)
- { return &alloc1 != &alloc2; }
- template < class T
- , class SegmentManager
- , std::size_t NodesPerBlock = 64
- >
- class private_node_allocator_v1
- : public private_node_allocator_base
- < 1
- , T
- , SegmentManager
- , NodesPerBlock
- >
- {
- public:
- typedef detail::private_node_allocator_base
- < 1, T, SegmentManager, NodesPerBlock> base_t;
- template<class T2>
- struct rebind
- {
- typedef private_node_allocator_v1<T2, SegmentManager, NodesPerBlock> other;
- };
- private_node_allocator_v1(SegmentManager *segment_mngr)
- : base_t(segment_mngr)
- {}
- template<class T2>
- private_node_allocator_v1
- (const private_node_allocator_v1<T2, SegmentManager, NodesPerBlock> &other)
- : base_t(other)
- {}
- };
- } //namespace detail {
- /// @endcond
- //!An STL node allocator that uses a segment manager as memory
- //!source. The internal pointer type will of the same type (raw, smart) as
- //!"typename SegmentManager::void_pointer" type. This allows
- //!placing the allocator in shared memory, memory mapped-files, etc...
- //!This allocator has its own node pool. NodesPerBlock is the number of nodes allocated
- //!at once when the allocator needs runs out of nodes
- template < class T
- , class SegmentManager
- , std::size_t NodesPerBlock
- >
- class private_node_allocator
- /// @cond
- : public detail::private_node_allocator_base
- < 2
- , T
- , SegmentManager
- , NodesPerBlock
- >
- /// @endcond
- {
- #ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
- typedef detail::private_node_allocator_base
- < 2, T, SegmentManager, NodesPerBlock> base_t;
- public:
- typedef boost::interprocess::version_type<private_node_allocator, 2> version;
- template<class T2>
- struct rebind
- {
- typedef private_node_allocator
- <T2, SegmentManager, NodesPerBlock> other;
- };
- private_node_allocator(SegmentManager *segment_mngr)
- : base_t(segment_mngr)
- {}
- template<class T2>
- private_node_allocator
- (const private_node_allocator<T2, SegmentManager, NodesPerBlock> &other)
- : base_t(other)
- {}
- #else
- public:
- typedef implementation_defined::segment_manager segment_manager;
- typedef segment_manager::void_pointer void_pointer;
- typedef implementation_defined::pointer pointer;
- typedef implementation_defined::const_pointer const_pointer;
- typedef T value_type;
- typedef typename detail::add_reference
- <value_type>::type reference;
- typedef typename detail::add_reference
- <const value_type>::type const_reference;
- typedef std::size_t size_type;
- typedef std::ptrdiff_t difference_type;
- //!Obtains private_node_allocator from
- //!private_node_allocator
- template<class T2>
- struct rebind
- {
- typedef private_node_allocator
- <T2, SegmentManager, NodesPerBlock> other;
- };
- private:
- //!Not assignable from
- //!related private_node_allocator
- template<class T2, class SegmentManager2, std::size_t N2>
- private_node_allocator& operator=
- (const private_node_allocator<T2, SegmentManager2, N2>&);
- //!Not assignable from
- //!other private_node_allocator
- private_node_allocator& operator=(const private_node_allocator&);
- public:
- //!Constructor from a segment manager. If not present, constructs a node
- //!pool. Increments the reference count of the associated node pool.
- //!Can throw boost::interprocess::bad_alloc
- private_node_allocator(segment_manager *segment_mngr);
- //!Copy constructor from other private_node_allocator. Increments the reference
- //!count of the associated node pool. Never throws
- private_node_allocator(const private_node_allocator &other);
- //!Copy constructor from related private_node_allocator. If not present, constructs
- //!a node pool. Increments the reference count of the associated node pool.
- //!Can throw boost::interprocess::bad_alloc
- template<class T2>
- private_node_allocator
- (const private_node_allocator<T2, SegmentManager, NodesPerBlock> &other);
- //!Destructor, removes node_pool_t from memory
- //!if its reference count reaches to zero. Never throws
- ~private_node_allocator();
- //!Returns a pointer to the node pool.
- //!Never throws
- node_pool_t* get_node_pool() const;
- //!Returns the segment manager.
- //!Never throws
- segment_manager* get_segment_manager()const;
- //!Returns the number of elements that could be allocated.
- //!Never throws
- size_type max_size() const;
- //!Allocate memory for an array of count elements.
- //!Throws boost::interprocess::bad_alloc if there is no enough memory
- pointer allocate(size_type count, cvoid_pointer hint = 0);
- //!Deallocate allocated memory.
- //!Never throws
- void deallocate(const pointer &ptr, size_type count);
- //!Deallocates all free blocks
- //!of the pool
- void deallocate_free_blocks();
- //!Swaps allocators. Does not throw. If each allocator is placed in a
- //!different memory segment, the result is undefined.
- friend void swap(self_t &alloc1, self_t &alloc2);
- //!Returns address of mutable object.
- //!Never throws
- pointer address(reference value) const;
- //!Returns address of non mutable object.
- //!Never throws
- const_pointer address(const_reference value) const;
- //!Copy construct an object.
- //!Throws if T's copy constructor throws
- void construct(const pointer &ptr, const_reference v);
- //!Destroys object. Throws if object's
- //!destructor throws
- void destroy(const pointer &ptr);
- //!Returns maximum the number of objects the previously allocated memory
- //!pointed by p can hold. This size only works for memory allocated with
- //!allocate, allocation_command and allocate_many.
- size_type size(const pointer &p) const;
- std::pair<pointer, bool>
- allocation_command(boost::interprocess::allocation_type command,
- size_type limit_size,
- size_type preferred_size,
- size_type &received_size, const pointer &reuse = 0);
- //!Allocates many elements of size elem_size in a contiguous block
- //!of memory. The minimum number to be allocated is min_elements,
- //!the preferred and maximum number is
- //!preferred_elements. The number of actually allocated elements is
- //!will be assigned to received_size. The elements must be deallocated
- //!with deallocate(...)
- multiallocation_chain allocate_many(size_type elem_size, std::size_t num_elements);
- //!Allocates n_elements elements, each one of size elem_sizes[i]in a
- //!contiguous block
- //!of memory. The elements must be deallocated
- multiallocation_chain allocate_many(const size_type *elem_sizes, size_type n_elements);
- //!Allocates many elements of size elem_size in a contiguous block
- //!of memory. The minimum number to be allocated is min_elements,
- //!the preferred and maximum number is
- //!preferred_elements. The number of actually allocated elements is
- //!will be assigned to received_size. The elements must be deallocated
- //!with deallocate(...)
- void deallocate_many(multiallocation_chain chain);
- //!Allocates just one object. Memory allocated with this function
- //!must be deallocated only with deallocate_one().
- //!Throws boost::interprocess::bad_alloc if there is no enough memory
- pointer allocate_one();
- //!Allocates many elements of size == 1 in a contiguous block
- //!of memory. The minimum number to be allocated is min_elements,
- //!the preferred and maximum number is
- //!preferred_elements. The number of actually allocated elements is
- //!will be assigned to received_size. Memory allocated with this function
- //!must be deallocated only with deallocate_one().
- multiallocation_chain allocate_individual(std::size_t num_elements);
- //!Deallocates memory previously allocated with allocate_one().
- //!You should never use deallocate_one to deallocate memory allocated
- //!with other functions different from allocate_one(). Never throws
- void deallocate_one(const pointer &p);
- //!Allocates many elements of size == 1 in a contiguous block
- //!of memory. The minimum number to be allocated is min_elements,
- //!the preferred and maximum number is
- //!preferred_elements. The number of actually allocated elements is
- //!will be assigned to received_size. Memory allocated with this function
- //!must be deallocated only with deallocate_one().
- void deallocate_individual(multiallocation_chain chain);
- #endif
- };
- #ifdef BOOST_INTERPROCESS_DOXYGEN_INVOKED
- //!Equality test for same type
- //!of private_node_allocator
- template<class T, class S, std::size_t NodesPerBlock, std::size_t F, unsigned char OP> inline
- bool operator==(const private_node_allocator<T, S, NodesPerBlock, F, OP> &alloc1,
- const private_node_allocator<T, S, NodesPerBlock, F, OP> &alloc2);
- //!Inequality test for same type
- //!of private_node_allocator
- template<class T, class S, std::size_t NodesPerBlock, std::size_t F, unsigned char OP> inline
- bool operator!=(const private_node_allocator<T, S, NodesPerBlock, F, OP> &alloc1,
- const private_node_allocator<T, S, NodesPerBlock, F, OP> &alloc2);
- #endif
- } //namespace interprocess {
- } //namespace boost {
- #include <boost/interprocess/detail/config_end.hpp>
- #endif //#ifndef BOOST_INTERPROCESS_PRIVATE_NODE_ALLOCATOR_HPP