std::pmr::synchronized_pool_resource

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Dynamic memory management

Smart pointers unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (until C++17) owner_less (C++11) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) Allocators allocator allocator_traits (C++11) allocator_arg_t (C++11) allocator_arg (C++11) uses_allocator (C++11) scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) Memory resources pmr::memory_resource (C++17) pmr::get_default_resource (C++17) pmr::set_default_resource (C++17) pmr::new_delete_resource (C++17) pmr::null_memory_resource (C++17) pmr::synchronized_pool_resource (C++17) pmr::unsynchronized_pool_resource (C++17) pmr::monotonic_buffer_resource (C++17) pmr::pool_options (C++17)

Uninitialized storage uninitialized_copy uninitialized_fill uninitialized_move (C++17) uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17) uninitialized_copy_n (C++11) uninitialized_fill_n uninitialized_move_n (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17) destroy_at (C++17) raw_storage_iterator (deprecated since c++17) get_temporary_buffer (deprecated since c++17) return_temporary_buffer (deprecated since c++17) Garbage collection support declare_reachable (C++11) undeclare_reachable (C++11) declare_no_pointers (C++11) undeclare_no_pointers (C++11) pointer_safety (C++11) get_pointer_safety (C++11) Miscellaneous pointer_traits (C++11) addressof (C++11) align (C++11) C Library malloc aligned_alloc (C++17) calloc realloc free Low level memory management

 

std::pmr::synchronized_pool_resource

synchronized_pool_resource::synchronized_pool_resource

synchronized_pool_resource::~synchronized_pool_resource

Public member functions

synchronized_pool_resource::release

synchronized_pool_resource::upstream_resource

synchronized_pool_resource::options

Protected member functions

synchronized_pool_resource::do_allocate

synchronized_pool_resource::do_deallocate

synchronized_pool_resource::do_is_equal

 

Defined in header <memory_resource>
class synchronized_pool_resource : public std::pmr::memory_resource;		(since C++17)

The class std::pmr::synchronized_pool_resource is a general-purpose memory resource class with the following properties:

• It owns the allocated memory and frees it on destruction, even if deallocate has not been called for some of the allocated blocks.
• It consists of a collection of pools that serves request for different block sizes. Each pool manages a collection of chunks that are then divided into blocks of uniform size.
• Calls to do_allocate are dispatched to the pool serving the smallest blocks accommodating the requested size.
• Exhausting memory in the pool causes the next allocation request for that pool to allocate an additional chunk of memory from the upstream allocator to replenish the pool. The chunk size obtained increases geometrically.
• Allocations requests that exceed the largest block size are served from the upstream allocator directly.
• The largest block size and maximum chunk size may be tuned by passing a std::pmr::pool_options struct to its constructor.

synchronized_pool_resource may be accessed from multiple threads without external synchronization, and may have thread-specific pools to reduce synchronization costs. If the memory resource is only accessed from one thread, unsynchronized_pool_resource is more efficient.

Member functions

(constructor)	Constructs a synchronized_pool_resource (public member function)
(destructor) [virtual]	Destroys a synchronized_pool_resource, releasing all allocated memory (virtual public member function)
operator= [deleted]	Copy assignment operator is deleted. synchronized_pool_resource is not copy assignable (public member function)
Public member functions
release	Release all allocated memory (public member function)
upstream_resource	Returns a pointer to the upstream memory resource (public member function)
options	Returns the options that control the pooling behavior of this resource (public member function)
Protected member functions
do_allocate [virtual]	Allocate memory (virtual protected member function)
do_deallocate [virtual]	Return memory to the pool (virtual protected member function)
do_is_equal [virtual]	Compare for equality with another memory_resource (virtual protected member function)