17#ifndef KOKKOS_IMPL_PUBLIC_INCLUDE
18#include <Kokkos_Macros.hpp>
20 "Including non-public Kokkos header files is not allowed.");
22#ifndef KOKKOS_MEMORYPOOL_HPP
23#define KOKKOS_MEMORYPOOL_HPP
25#include <Kokkos_Core_fwd.hpp>
28#include <impl/Kokkos_ConcurrentBitset.hpp>
29#include <impl/Kokkos_Error.hpp>
30#include <impl/Kokkos_SharedAlloc.hpp>
44void memory_pool_bounds_verification(
size_t min_block_alloc_size,
45 size_t max_block_alloc_size,
46 size_t min_superblock_size,
47 size_t max_superblock_size,
48 size_t max_block_per_superblock,
49 size_t min_total_alloc_size);
57void _print_memory_pool_state(std::ostream &s, uint32_t
const *sb_state_ptr,
58 int32_t sb_count, uint32_t sb_size_lg2,
59 uint32_t sb_state_size, uint32_t state_shift,
60 uint32_t state_used_mask);
64template <
typename DeviceType>
67 using CB = Kokkos::Impl::concurrent_bitset;
69 enum : uint32_t { bits_per_int_lg2 = CB::bits_per_int_lg2 };
70 enum : uint32_t { state_shift = CB::state_shift };
71 enum : uint32_t { state_used_mask = CB::state_used_mask };
72 enum : uint32_t { state_header_mask = CB::state_header_mask };
73 enum : uint32_t { max_bit_count_lg2 = CB::max_bit_count_lg2 };
74 enum : uint32_t { max_bit_count = CB::max_bit_count };
76 enum : uint32_t { HINT_PER_BLOCK_SIZE = 2 };
98 using base_memory_space =
typename DeviceType::memory_space;
102 base_memory_space>::accessible
105 using Tracker = Kokkos::Impl::SharedAllocationTracker;
106 using Record = Kokkos::Impl::SharedAllocationRecord<base_memory_space>;
109 uint32_t *m_sb_state_array;
110 uint32_t m_sb_state_size;
111 uint32_t m_sb_size_lg2;
112 uint32_t m_max_block_size_lg2;
113 uint32_t m_min_block_size_lg2;
115 int32_t m_hint_offset;
116 int32_t m_data_offset;
117 int32_t m_unused_padding;
120 using memory_space =
typename DeviceType::memory_space;
123 enum : uint32_t { max_superblock_size = 1LU << 31 };
124 enum : uint32_t { max_block_per_superblock = max_bit_count };
128 KOKKOS_INLINE_FUNCTION
129 bool operator==(MemoryPool
const &other)
const {
130 return m_sb_state_array == other.m_sb_state_array;
133 KOKKOS_INLINE_FUNCTION
134 size_t capacity() const noexcept {
135 return size_t(m_sb_count) << m_sb_size_lg2;
138 KOKKOS_INLINE_FUNCTION
139 size_t min_block_size() const noexcept {
140 return (1LU << m_min_block_size_lg2);
143 KOKKOS_INLINE_FUNCTION
144 size_t max_block_size() const noexcept {
145 return (1LU << m_max_block_size_lg2);
148 struct usage_statistics {
149 size_t capacity_bytes;
150 size_t superblock_bytes;
151 size_t max_block_bytes;
152 size_t min_block_bytes;
153 size_t capacity_superblocks;
154 size_t consumed_superblocks;
155 size_t consumed_blocks;
156 size_t consumed_bytes;
157 size_t reserved_blocks;
158 size_t reserved_bytes;
161 void get_usage_statistics(usage_statistics &stats)
const {
164 const size_t alloc_size = m_hint_offset *
sizeof(uint32_t);
166 uint32_t *
const sb_state_array =
167 accessible ? m_sb_state_array : (uint32_t *)host.
allocate(alloc_size);
170 Kokkos::Impl::DeepCopy<Kokkos::HostSpace, base_memory_space>(
171 sb_state_array, m_sb_state_array, alloc_size);
173 "MemoryPool::get_usage_statistics(): fence after copying state "
174 "array to HostSpace");
177 stats.superblock_bytes = (1LU << m_sb_size_lg2);
178 stats.max_block_bytes = (1LU << m_max_block_size_lg2);
179 stats.min_block_bytes = (1LU << m_min_block_size_lg2);
180 stats.capacity_bytes = stats.superblock_bytes * m_sb_count;
181 stats.capacity_superblocks = m_sb_count;
182 stats.consumed_superblocks = 0;
183 stats.consumed_blocks = 0;
184 stats.consumed_bytes = 0;
185 stats.reserved_blocks = 0;
186 stats.reserved_bytes = 0;
188 const uint32_t *sb_state_ptr = sb_state_array;
190 for (int32_t i = 0; i < m_sb_count; ++i, sb_state_ptr += m_sb_state_size) {
191 const uint32_t block_count_lg2 = (*sb_state_ptr) >> state_shift;
193 if (block_count_lg2) {
194 const uint32_t block_count = 1u << block_count_lg2;
195 const uint32_t block_size_lg2 = m_sb_size_lg2 - block_count_lg2;
196 const uint32_t block_size = 1u << block_size_lg2;
197 const uint32_t block_used = (*sb_state_ptr) & state_used_mask;
199 stats.consumed_superblocks++;
200 stats.consumed_blocks += block_used;
201 stats.consumed_bytes += block_used * block_size;
202 stats.reserved_blocks += block_count - block_used;
203 stats.reserved_bytes += (block_count - block_used) * block_size;
212 void print_state(std::ostream &s)
const {
215 const size_t alloc_size = m_hint_offset *
sizeof(uint32_t);
217 uint32_t *
const sb_state_array =
218 accessible ? m_sb_state_array : (uint32_t *)host.
allocate(alloc_size);
221 Kokkos::Impl::DeepCopy<Kokkos::HostSpace, base_memory_space>(
222 sb_state_array, m_sb_state_array, alloc_size);
224 "MemoryPool::print_state(): fence after copying state array to "
228 Impl::_print_memory_pool_state(s, sb_state_array, m_sb_count, m_sb_size_lg2,
229 m_sb_state_size, state_shift,
239 KOKKOS_DEFAULTED_FUNCTION MemoryPool(MemoryPool &&) =
default;
240 KOKKOS_DEFAULTED_FUNCTION MemoryPool(
const MemoryPool &) =
default;
241 KOKKOS_DEFAULTED_FUNCTION MemoryPool &operator=(MemoryPool &&) =
default;
242 KOKKOS_DEFAULTED_FUNCTION MemoryPool &operator=(
const MemoryPool &) =
default;
244 KOKKOS_INLINE_FUNCTION MemoryPool()
246 m_sb_state_array(nullptr),
249 m_max_block_size_lg2(0),
250 m_min_block_size_lg2(0),
254 m_unused_padding(0) {}
270 MemoryPool(
const base_memory_space &memspace,
271 const size_t min_total_alloc_size,
size_t min_block_alloc_size = 0,
272 size_t max_block_alloc_size = 0,
size_t min_superblock_size = 0)
274 m_sb_state_array(nullptr),
277 m_max_block_size_lg2(0),
278 m_min_block_size_lg2(0),
282 m_unused_padding(0) {
283 const uint32_t int_align_lg2 = 3;
284 const uint32_t int_align_mask = (1u << int_align_lg2) - 1;
285 const uint32_t default_min_block_size = 1u << 6;
286 const uint32_t default_max_block_size = 1u << 12;
287 const uint32_t default_min_superblock_size = 1u << 20;
292 if (0 == min_block_alloc_size) {
295 min_superblock_size =
296 std::min(
size_t(default_min_superblock_size), min_total_alloc_size);
298 min_block_alloc_size =
299 std::min(
size_t(default_min_block_size), min_superblock_size);
301 max_block_alloc_size =
302 std::min(
size_t(default_max_block_size), min_superblock_size);
303 }
else if (0 == min_superblock_size) {
309 const size_t max_superblock =
310 min_block_alloc_size * max_block_per_superblock;
312 min_superblock_size =
313 std::min(max_superblock,
314 std::min(
size_t(max_superblock_size), min_total_alloc_size));
317 if (0 == max_block_alloc_size) {
318 max_block_alloc_size = min_superblock_size;
332 Kokkos::Impl::memory_pool_bounds_verification(
333 min_block_alloc_size, max_block_alloc_size, min_superblock_size,
334 max_superblock_size, max_block_per_superblock, min_total_alloc_size);
340 m_min_block_size_lg2 =
341 Kokkos::Impl::integral_power_of_two_that_contains(min_block_alloc_size);
343 m_max_block_size_lg2 =
344 Kokkos::Impl::integral_power_of_two_that_contains(max_block_alloc_size);
347 Kokkos::Impl::integral_power_of_two_that_contains(min_superblock_size);
353 const uint64_t sb_size_mask = (1LU << m_sb_size_lg2) - 1;
355 m_sb_count = (min_total_alloc_size + sb_size_mask) >> m_sb_size_lg2;
362 const uint32_t max_block_count_lg2 = m_sb_size_lg2 - m_min_block_size_lg2;
365 (CB::buffer_bound_lg2(max_block_count_lg2) + int_align_mask) &
371 const size_t all_sb_state_size =
372 (m_sb_count * m_sb_state_size + int_align_mask) & ~int_align_mask;
376 const int32_t number_block_sizes =
377 1 + m_max_block_size_lg2 - m_min_block_size_lg2;
382 const int32_t block_size_array_size =
383 (number_block_sizes + int_align_mask) & ~int_align_mask;
385 m_hint_offset = all_sb_state_size;
386 m_data_offset = m_hint_offset + block_size_array_size * HINT_PER_BLOCK_SIZE;
390 const size_t header_size = m_data_offset *
sizeof(uint32_t);
391 const size_t alloc_size =
392 header_size + (size_t(m_sb_count) << m_sb_size_lg2);
394 Record *rec = Record::allocate(memspace,
"Kokkos::MemoryPool", alloc_size);
396 m_tracker.assign_allocated_record_to_uninitialized(rec);
398 m_sb_state_array = (uint32_t *)rec->data();
402 uint32_t *
const sb_state_array =
403 accessible ? m_sb_state_array : (uint32_t *)host.
allocate(header_size);
405 for (int32_t i = 0; i < m_data_offset; ++i) sb_state_array[i] = 0;
409 for (int32_t i = 0; i < number_block_sizes; ++i) {
410 const uint32_t block_size_lg2 = i + m_min_block_size_lg2;
411 const uint32_t block_count_lg2 = m_sb_size_lg2 - block_size_lg2;
412 const uint32_t block_state = block_count_lg2 << state_shift;
413 const uint32_t hint_begin = m_hint_offset + i * HINT_PER_BLOCK_SIZE;
419 const int32_t jbeg = (i * m_sb_count) / number_block_sizes;
420 const int32_t jend = ((i + 1) * m_sb_count) / number_block_sizes;
422 sb_state_array[hint_begin] = uint32_t(jbeg);
423 sb_state_array[hint_begin + 1] = uint32_t(jbeg);
425 for (int32_t j = jbeg; j < jend; ++j) {
426 sb_state_array[j * m_sb_state_size] = block_state;
433 Kokkos::Impl::DeepCopy<base_memory_space, Kokkos::HostSpace>(
434 m_sb_state_array, sb_state_array, header_size);
436 "MemoryPool::MemoryPool(): fence after copying state array from "
451 KOKKOS_FORCEINLINE_FUNCTION
452 uint32_t get_block_size_lg2(uint32_t n)
const noexcept {
453 const unsigned i = Kokkos::Impl::integral_power_of_two_that_contains(n);
455 return i < m_min_block_size_lg2 ? m_min_block_size_lg2 : i;
460 KOKKOS_INLINE_FUNCTION
461 uint32_t allocate_block_size(uint64_t alloc_size)
const noexcept {
462 return alloc_size <= (1UL << m_max_block_size_lg2)
463 ? (1UL << get_block_size_lg2(uint32_t(alloc_size)))
478 void *allocate(
size_t alloc_size, int32_t attempt_limit = 1) const noexcept {
479 if (
size_t(1LU << m_max_block_size_lg2) < alloc_size) {
481 "Kokkos MemoryPool allocation request exceeded specified maximum "
485 if (0 == alloc_size)
return nullptr;
489 const uint32_t block_size_lg2 = get_block_size_lg2(alloc_size);
494 const uint32_t block_count_lg2 = m_sb_size_lg2 - block_size_lg2;
495 const uint32_t block_state = block_count_lg2 << state_shift;
496 const uint32_t block_count = 1u << block_count_lg2;
502 volatile uint32_t *
const hint_sb_id_ptr =
505 + HINT_PER_BLOCK_SIZE
506 * (block_size_lg2 - m_min_block_size_lg2);
508 const int32_t sb_id_begin = int32_t(hint_sb_id_ptr[1]);
513#if defined(KOKKOS_ENABLE_SYCL) && !defined(KOKKOS_ARCH_INTEL_GPU)
514 const uint32_t block_id_hint = alloc_size;
516 const uint32_t block_id_hint =
517 (uint32_t)(Kokkos::Impl::clock_tic()
521 + (threadIdx.x + blockDim.x * threadIdx.y)
527 uint32_t sb_state = block_state;
531 volatile uint32_t *sb_state_array =
nullptr;
533 while (attempt_limit) {
534 int32_t hint_sb_id = -1;
539 sb_id = hint_sb_id = int32_t(*hint_sb_id_ptr);
541 sb_state_array = m_sb_state_array + (sb_id * m_sb_state_size);
548 if (sb_state == (state_header_mask & *sb_state_array)) {
553 const uint32_t count_lg2 = sb_state >> state_shift;
554 const uint32_t mask = (1u << count_lg2) - 1;
557 sb_state_array, count_lg2, block_id_hint & mask, sb_state);
564 if (0 <= result.first) {
566 const uint32_t size_lg2 = m_sb_size_lg2 - count_lg2;
570 p = ((
char *)(m_sb_state_array + m_data_offset)) +
571 (uint64_t(sb_id) << m_sb_size_lg2)
572 + (uint64_t(result.first) << size_lg2);
587 sb_state = block_state;
590 bool update_hint =
false;
591 int32_t sb_id_empty = -1;
592 int32_t sb_id_large = -1;
593 uint32_t sb_state_large = 0;
595 sb_state_array = m_sb_state_array + sb_id_begin * m_sb_state_size;
597 for (int32_t i = 0,
id = sb_id_begin; i < m_sb_count; ++i) {
602 const uint32_t full_state = *sb_state_array;
603 const uint32_t used = full_state & state_used_mask;
604 const uint32_t state = full_state & state_header_mask;
606 if (state == block_state) {
609 if (used < block_count) {
616 update_hint = used + 1 < block_count;
620 }
else if (0 == used) {
623 if (-1 == sb_id_empty) {
630 }
else if ((-1 == sb_id_empty ) &&
631 (-1 == sb_id_large ) &&
632 (state < block_state ) &&
634 (used < (1u << (state >> state_shift)))) {
640 sb_state_large = state;
645 if (++
id < m_sb_count) {
646 sb_state_array += m_sb_state_size;
649 sb_state_array = m_sb_state_array;
659 if (0 <= sb_id_empty) {
668 sb_state_array = m_sb_state_array + (sb_id * m_sb_state_size);
673 const uint32_t state_empty = state_header_mask & *sb_state_array;
678 sb_state_array, state_empty, block_state);
679 }
else if (0 <= sb_id_large) {
683 sb_state = sb_state_large;
685 sb_state_array = m_sb_state_array + (sb_id * m_sb_state_size);
710 KOKKOS_INLINE_FUNCTION
711 void deallocate(
void *p,
size_t )
const noexcept {
712 if (
nullptr == p)
return;
716 static_cast<char *
>(p) -
717 reinterpret_cast<char *
>(m_sb_state_array + m_data_offset);
720 const int ok_contains =
721 (0 <= d) && (
size_t(d) < (size_t(m_sb_count) << m_sb_size_lg2));
723 int ok_block_aligned = 0;
724 int ok_dealloc_once = 0;
727 const int sb_id = d >> m_sb_size_lg2;
730 volatile uint32_t *
const sb_state_array =
731 m_sb_state_array + (sb_id * m_sb_state_size);
733 const uint32_t block_state = (*sb_state_array) & state_header_mask;
734 const uint32_t block_size_lg2 =
735 m_sb_size_lg2 - (block_state >> state_shift);
737 ok_block_aligned = 0 == (d & ((1UL << block_size_lg2) - 1));
739 if (ok_block_aligned) {
744 (d & (ptrdiff_t(1LU << m_sb_size_lg2) - 1)) >> block_size_lg2;
746 const int result = CB::release(sb_state_array, bit, block_state);
748 ok_dealloc_once = 0 <= result;
752 if (!ok_contains || !ok_block_aligned || !ok_dealloc_once) {
753 Kokkos::abort(
"Kokkos MemoryPool::deallocate given erroneous pointer");
759 KOKKOS_INLINE_FUNCTION
760 int number_of_superblocks() const noexcept {
return m_sb_count; }
762 KOKKOS_INLINE_FUNCTION
763 void superblock_state(
int sb_id,
int &block_size,
int &block_count_capacity,
764 int &block_count_used)
const noexcept {
766 block_count_capacity = 0;
767 block_count_used = 0;
769 bool can_access_state_array = []() {
771 (
return SpaceAccessibility<DefaultHostExecutionSpace,
772 base_memory_space>::accessible;))
774 (
return SpaceAccessibility<DefaultExecutionSpace,
775 base_memory_space>::accessible;))
778 if (can_access_state_array) {
781 const uint32_t state =
782 ((uint32_t
volatile *)m_sb_state_array)[sb_id * m_sb_state_size];
784 const uint32_t block_count_lg2 = state >> state_shift;
785 const uint32_t block_used = state & state_used_mask;
787 block_size = 1LU << (m_sb_size_lg2 - block_count_lg2);
788 block_count_capacity = 1LU << block_count_lg2;
789 block_count_used = block_used;
Declaration of parallel operators.
A thread safe view to a bitset.
Memory management for host memory.
void deallocate(void *const arg_alloc_ptr, const size_t arg_alloc_size) const
Deallocate untracked memory in the space.
void * allocate(const size_t arg_alloc_size) const
Allocate untracked memory in the space.
Access relationship between DstMemorySpace and SrcMemorySpace.