2#include "gaia/config/config.h"
8#include "gaia/cnt/fwd_llist.h"
9#include "gaia/cnt/sarray.h"
10#include "gaia/core/bit_utils.h"
11#include "gaia/core/dyn_singleton.h"
12#include "gaia/core/utility.h"
13#include "gaia/mem/mem_alloc.h"
14#include "gaia/util/logging.h"
20 uintptr_t m_pageAddr = 0;
21 uint32_t m_reserved = 0;
23 uint32_t m_requestedBytes = 0;
27 class ChunkAllocatorImpl;
30 static constexpr uint32_t MemoryBlockAlignment = 64;
31 static constexpr uint32_t MinMemoryBlockSize = 1024 * 8;
33 static constexpr uint32_t MemoryBlockSizeClasses = 4;
35 static constexpr uint32_t MaxMemoryBlockSize = UINT16_MAX & ~(MemoryBlockAlignment - 1);
38 static constexpr uint32_t MemoryBlockUsableOffset = 40;
40 constexpr uint16_t mem_block_size(uint32_t sizeType) {
41 constexpr uint16_t sizes[] = {
42 MinMemoryBlockSize, MinMemoryBlockSize * 2, MinMemoryBlockSize * 4, MaxMemoryBlockSize};
43 return sizes[sizeType];
46 constexpr uint8_t mem_block_size_type(uint32_t sizeBytes) {
47 GAIA_ASSERT(sizeBytes > 0);
48 if (sizeBytes <= MinMemoryBlockSize)
50 if (sizeBytes <= MinMemoryBlockSize * 2)
52 if (sizeBytes <= MinMemoryBlockSize * 4)
57#if GAIA_ECS_CHUNK_ALLOCATOR
58 struct GAIA_API ChunkAllocatorPageStats final {
66 uint32_t num_pages_free;
69 uint64_t mem_requested;
71 uint32_t num_pages_empty;
75 struct GAIA_API ChunkAllocatorStats final {
76 ChunkAllocatorPageStats stats[MemoryBlockSizeClasses];
79 using ChunkAllocator = core::dyn_singleton<detail::ChunkAllocatorImpl>;
82 static_assert(
sizeof(MemoryBlockHeader) <= MemoryBlockUsableOffset);
84 struct MemoryPageHeader {
88 MemoryPageHeader(
void* ptr): m_data(ptr) {}
91 struct MemoryPage: MemoryPageHeader, cnt::fwd_llist_base<MemoryPage> {
92 static constexpr uint16_t NBlocks = 48;
93 static constexpr uint16_t NBlocks_Bits = (uint16_t)core::count_bits(NBlocks);
94 static constexpr uint32_t InvalidBlockId = NBlocks + 1;
96 static constexpr uint8_t FreedBlockPattern = 0xDD;
98 static constexpr uint32_t BlockArrayBytes = ((uint32_t)NBlocks_Bits * (uint32_t)NBlocks + 7) / 8;
99 using BlockArray = cnt::sarray<uint8_t, BlockArrayBytes>;
100 using BitView = core::bit_view<NBlocks_Bits>;
106 uint32_t m_sizeType : 2;
108 uint32_t m_blockCnt : NBlocks_Bits;
110 uint32_t m_usedBlocks : NBlocks_Bits;
112 uint32_t m_nextFreeBlock : NBlocks_Bits;
114 uint32_t m_freeBlocks : NBlocks_Bits;
118 #if GAIA_ASSERT_ENABLED
119 uint64_t m_usedMask = 0;
122 MemoryPage(
void* ptr, uint8_t sizeType):
123 MemoryPageHeader(ptr), m_sizeType(sizeType), m_blockCnt(0), m_usedBlocks(0), m_nextFreeBlock(0),
125 #if GAIA_ASSERT_ENABLED
126 static_assert(
sizeof(MemoryPage) <= 72);
128 static_assert(
sizeof(MemoryPage) <= 64);
132 void write_block_idx(uint32_t blockIdx, uint32_t value) {
133 const uint32_t bitPosition = blockIdx * NBlocks_Bits;
135 GAIA_ASSERT(bitPosition < NBlocks * NBlocks_Bits);
136 GAIA_ASSERT(value <= InvalidBlockId);
138 BitView{{(uint8_t*)m_blocks.data(), BlockArrayBytes}}.set(bitPosition, (uint8_t)value);
141 uint8_t read_block_idx(uint32_t blockIdx)
const {
142 const uint32_t bitPosition = blockIdx * NBlocks_Bits;
144 GAIA_ASSERT(bitPosition < NBlocks * NBlocks_Bits);
146 return BitView{{(uint8_t*)m_blocks.data(), BlockArrayBytes}}.get(bitPosition);
149 GAIA_NODISCARD
void* alloc_block(
154 auto StoreBlockAddress = [&](uint32_t index) {
157 auto* pMemoryBlock = (uint8_t*)m_data + (index * mem_block_size(m_sizeType));
158 GAIA_ASSERT((uintptr_t)pMemoryBlock % MemoryBlockAlignment == 0);
159 auto& header = block_header(pMemoryBlock);
160 header.m_pageAddr = (uintptr_t)
this;
161 header.m_reserved = 0;
163 header.m_requestedBytes = bytesWanted;
165 return (
void*)(pMemoryBlock + MemoryBlockUsableOffset);
169 GAIA_ASSERT(!full() &&
"Trying to allocate too many blocks!");
172 if (m_freeBlocks == 0U) {
176 write_block_idx(index, index);
178 GAIA_ASSERT(m_nextFreeBlock < m_blockCnt &&
"Block allocator recycle list broken!");
183 index = m_nextFreeBlock;
184 m_nextFreeBlock = read_block_idx(m_nextFreeBlock);
187 #if GAIA_ASSERT_ENABLED
188 GAIA_ASSERT((m_usedMask & (uint64_t(1) << index)) == 0 &&
"Block already marked as live");
189 m_usedMask |= uint64_t(1) << index;
192 return StoreBlockAddress(index);
195 void free_block(
void* pBlock) {
196 GAIA_ASSERT(pBlock !=
nullptr);
197 GAIA_ASSERT(m_usedBlocks > 0);
198 GAIA_ASSERT(m_freeBlocks <= NBlocks);
201 const auto* pMemoryBlock = (uint8_t*)pBlock - MemoryBlockUsableOffset;
202 const auto blckAddr = (uintptr_t)pMemoryBlock;
203 GAIA_ASSERT(blckAddr % MemoryBlockAlignment == 0);
204 const auto dataAddr = (uintptr_t)m_data;
205 GAIA_ASSERT(blckAddr >= dataAddr);
206 const auto blockSize = (uintptr_t)mem_block_size(m_sizeType);
207 #if GAIA_ASSERT_ENABLED
208 const auto pageSize = blockSize * NBlocks;
209 GAIA_ASSERT(blckAddr < dataAddr + pageSize);
211 GAIA_ASSERT((blckAddr - dataAddr) % blockSize == 0);
212 const auto blockIdx = (uint32_t)((blckAddr - dataAddr) / blockSize);
213 GAIA_ASSERT(blockIdx < m_blockCnt);
216 auto& header = block_header((
void*)pMemoryBlock);
217 GAIA_ASSERT(header.m_requestedBytes > 0);
219 #if GAIA_ASSERT_ENABLED
220 GAIA_ASSERT((m_usedMask & (uint64_t(1) << blockIdx)) != 0 &&
"Double free or corrupted block state");
221 m_usedMask &= ~(uint64_t(1) << blockIdx);
225 header.m_requestedBytes = 0;
226 std::memset(pBlock, FreedBlockPattern, blockSize - MemoryBlockUsableOffset);
230 if (m_freeBlocks == 0U)
231 write_block_idx(blockIdx, InvalidBlockId);
233 write_block_idx(blockIdx, m_nextFreeBlock);
234 m_nextFreeBlock = blockIdx;
240 GAIA_NODISCARD uint32_t used_blocks_cnt()
const {
244 GAIA_NODISCARD
bool full()
const {
245 return used_blocks_cnt() >= NBlocks;
248 GAIA_NODISCARD
bool empty()
const {
249 return used_blocks_cnt() == 0;
252 void verify()
const {
253 #if GAIA_ASSERT_ENABLED
254 GAIA_ASSERT(m_sizeType < MemoryBlockSizeClasses);
255 GAIA_ASSERT(m_blockCnt <= NBlocks);
256 GAIA_ASSERT(m_usedBlocks <= m_blockCnt);
257 GAIA_ASSERT(m_freeBlocks <= m_blockCnt);
258 GAIA_ASSERT(m_usedBlocks + m_freeBlocks == m_blockCnt);
260 const auto blockSize = (uintptr_t)mem_block_size(m_sizeType);
262 const auto pageAddr = (uintptr_t)m_data;
263 GAIA_ASSERT(pageAddr % MemoryBlockAlignment == 0);
266 uint64_t freeMask = 0;
269 if (m_freeBlocks != 0) {
270 uint32_t next = m_nextFreeBlock;
271 GAIA_FOR(m_freeBlocks) {
272 GAIA_ASSERT(next < m_blockCnt);
274 const auto bit = uint64_t(1) << next;
275 GAIA_ASSERT((freeMask & bit) == 0 &&
"Free list contains a cycle");
278 next = read_block_idx(next);
281 GAIA_ASSERT(next == InvalidBlockId);
284 GAIA_FOR(m_blockCnt) {
285 const auto* pMemoryBlock = (
const uint8_t*)m_data + (i * blockSize);
286 const auto& header = block_header(pMemoryBlock);
287 GAIA_ASSERT(header.m_pageAddr == (uintptr_t)
this);
288 GAIA_ASSERT(((uintptr_t)pMemoryBlock % MemoryBlockAlignment) == 0);
291 const bool isFree = (freeMask & (uint64_t(1) << i)) != 0;
292 GAIA_ASSERT((header.m_requestedBytes == 0) == isFree);
297 GAIA_ASSERT((m_usedMask & freeMask) == 0);
298 const auto liveMask = m_blockCnt == 64 ? ~uint64_t(0) : ((uint64_t(1) << m_blockCnt) - 1);
299 GAIA_ASSERT((m_usedMask | freeMask) == liveMask);
305 GAIA_NODISCARD uint64_t requested_bytes()
const {
306 if (m_usedBlocks == 0)
309 uint64_t freeMask = 0;
310 uint32_t next = m_nextFreeBlock;
311 GAIA_FOR(m_freeBlocks) {
312 GAIA_ASSERT(next < m_blockCnt);
313 const auto bit = uint64_t(1) << next;
314 GAIA_ASSERT((freeMask & bit) == 0 &&
"Free list contains a cycle");
316 next = read_block_idx(next);
319 uint64_t requested = 0;
320 GAIA_FOR(m_blockCnt) {
321 if ((freeMask & (uint64_t(1) << i)) != 0)
324 const auto* pMemoryBlock = (
const uint8_t*)m_data + (i * mem_block_size(m_sizeType));
325 requested += block_header(pMemoryBlock).m_requestedBytes;
333 static MemoryBlockHeader& block_header(
void* pMemoryBlock) {
334 return *(MemoryBlockHeader*)pMemoryBlock;
337 static const MemoryBlockHeader& block_header(
const void* pMemoryBlock) {
338 return *(
const MemoryBlockHeader*)pMemoryBlock;
342 enum class MemoryPageState : uint8_t { Detached, Empty, Partial, Full };
344 struct MemoryPageContainer {
346 cnt::fwd_llist<MemoryPage> pagesEmpty;
348 cnt::fwd_llist<MemoryPage> pagesPartial;
350 cnt::fwd_llist<MemoryPage> pagesFull;
352 GAIA_NODISCARD
bool empty()
const {
353 return pagesEmpty.empty() && pagesPartial.empty() && pagesFull.empty();
358 class ChunkAllocatorImpl {
359 friend ::gaia::ecs::ChunkAllocator;
362 MemoryPageContainer m_pages[MemoryBlockSizeClasses];
365 bool m_isDone =
false;
368 ChunkAllocatorImpl() =
default;
374 auto memStats = stats();
375 for (
const auto& s: memStats.stats) {
376 if (s.mem_total != 0) {
377 GAIA_ASSERT2(
false,
"ECS leaking memory");
378 GAIA_LOG_W(
"ECS leaking memory!");
385 ~ChunkAllocatorImpl() {
389 ChunkAllocatorImpl(ChunkAllocatorImpl&& world) =
delete;
390 ChunkAllocatorImpl(
const ChunkAllocatorImpl& world) =
delete;
391 ChunkAllocatorImpl& operator=(ChunkAllocatorImpl&&) =
delete;
392 ChunkAllocatorImpl& operator=(
const ChunkAllocatorImpl&) =
delete;
395 void* alloc(uint32_t bytesWanted) {
396 GAIA_ASSERT(bytesWanted > 0);
397 GAIA_ASSERT(bytesWanted <= MaxMemoryBlockSize);
398 if (bytesWanted == 0 || bytesWanted > MaxMemoryBlockSize)
401 const auto sizeType = mem_block_size_type(bytesWanted);
402 auto& container = m_pages[sizeType];
404 MemoryPageState prevState = MemoryPageState::Partial;
405 auto* pPage = container.pagesPartial.first;
406 if (pPage ==
nullptr) {
407 prevState = MemoryPageState::Empty;
408 pPage = container.pagesEmpty.first;
409 if (pPage ==
nullptr) {
410 prevState = MemoryPageState::Detached;
411 pPage = alloc_page(sizeType);
417 void* pBlock = pPage->alloc_block(bytesWanted);
419 void* pBlock = pPage->alloc_block();
422 move_page(container, pPage, prevState, state_for(*pPage));
427 GAIA_CLANG_WARNING_PUSH()
429 GAIA_CLANG_WARNING_DISABLE("-Wcast-align")
432 void free(
void* pBlock) {
433 GAIA_ASSERT(pBlock !=
nullptr);
434 if (pBlock ==
nullptr)
438 const auto& header = *(
const MemoryBlockHeader*)((uint8_t*)pBlock - MemoryBlockUsableOffset);
439 const auto pageAddr = header.m_pageAddr;
440 GAIA_ASSERT(pageAddr %
sizeof(uintptr_t) == 0);
442 GAIA_ASSERT(header.m_requestedBytes > 0);
444 auto* pPage = (MemoryPage*)pageAddr;
445 const auto prevState = state_for(*pPage);
447 auto& container = m_pages[pPage->m_sizeType];
449 #if GAIA_ASSERT_ENABLED
450 if (prevState == MemoryPageState::Full) {
451 const auto res = container.pagesFull.has(pPage);
452 GAIA_ASSERT(res &&
"Memory page couldn't be found among full pages");
453 }
else if (prevState == MemoryPageState::Partial) {
454 const auto res = container.pagesPartial.has(pPage);
455 GAIA_ASSERT(res &&
"Memory page couldn't be found among partial pages");
457 GAIA_ASSERT(
false &&
"Allocated block can't belong to an empty page");
462 pPage->free_block(pBlock);
465 move_page(container, pPage, prevState, state_for(*pPage));
470 if (pPage->empty()) {
471 container.pagesEmpty.unlink(pPage);
479 GAIA_CLANG_WARNING_POP()
482 ChunkAllocatorStats stats()
const {
483 ChunkAllocatorStats stats{};
484 for (uint32_t sizeType = 0; sizeType < MemoryBlockSizeClasses; ++sizeType)
485 stats.stats[sizeType] = page_stats(sizeType);
491 void flush(
bool releaseAll =
false) {
493 for (
auto& page: m_pages)
494 flushPages(page, i++, releaseAll);
500 auto diagPage = [](
const ChunkAllocatorPageStats& stats, uint32_t sizeType) {
501 GAIA_LOG_N(
"ChunkAllocator %uK stats", mem_block_size(sizeType) / 1024);
502 GAIA_LOG_N(
" Allocated: %" PRIu64
" B", stats.mem_total);
503 GAIA_LOG_N(
" Reserved by live blocks: %" PRIu64
" B", stats.mem_used);
504 GAIA_LOG_N(
" Pages: %u", stats.num_pages);
505 GAIA_LOG_N(
" Reusable pages: %u", stats.num_pages_free);
508 " Utilization: %.1f%%",
509 stats.mem_total ? 100.0 * ((
double)stats.mem_used / (
double)stats.mem_total) : 0);
511 GAIA_LOG_N(
" Requested: %" PRIu64
" B", stats.mem_requested);
512 GAIA_LOG_N(
" Free capacity: %" PRIu64
" B", stats.mem_total - stats.mem_used);
513 GAIA_LOG_N(
" Internal slack: %" PRIu64
" B", stats.mem_used - stats.mem_requested);
515 " Utilization: %.1f%%",
516 stats.mem_total ? 100.0 * ((
double)stats.mem_requested / (
double)stats.mem_total) : 0);
517 GAIA_LOG_N(
" Empty pages: %u", stats.num_pages_empty);
521 auto memStats = stats();
522 for (uint32_t sizeType = 0; sizeType < MemoryBlockSizeClasses; ++sizeType)
523 diagPage(memStats.stats[sizeType], sizeType);
526 void verify()
const {
527 #if GAIA_ASSERT_ENABLED
528 for (uint32_t sizeType = 0; sizeType < MemoryBlockSizeClasses; ++sizeType)
529 verify_container(m_pages[sizeType], sizeType);
534 static constexpr const char* s_strChunkAlloc_Chunk =
"Chunk";
535 static constexpr const char* s_strChunkAlloc_MemPage =
"MemoryPage";
537 static MemoryPage* alloc_page(uint8_t sizeType) {
538 const uint32_t size = mem_block_size(sizeType) * MemoryPage::NBlocks;
539 auto* pPageData = mem::AllocHelper::alloc_alig<uint8_t>(s_strChunkAlloc_Chunk, MemoryBlockAlignment, size);
540 auto* pMemoryPage = mem::AllocHelper::alloc<MemoryPage>(s_strChunkAlloc_MemPage);
541 return new (pMemoryPage) MemoryPage(pPageData, sizeType);
544 static void free_page(MemoryPage* pMemoryPage) {
545 GAIA_ASSERT(pMemoryPage !=
nullptr);
547 mem::AllocHelper::free_alig(s_strChunkAlloc_Chunk, pMemoryPage->m_data);
548 pMemoryPage->~MemoryPage();
549 mem::AllocHelper::free(s_strChunkAlloc_MemPage, pMemoryPage);
556 void try_delete_this() {
558 bool allEmpty =
true;
559 for (
const auto& c: m_pages)
560 allEmpty = allEmpty && c.empty();
565 static constexpr uint32_t warm_pages_to_keep(uint32_t sizeType) {
566 constexpr uint8_t WarmPagesPerSizeClass[] = {1, 1, 0, 0};
567 return WarmPagesPerSizeClass[sizeType];
570 static MemoryPageState state_for(
const MemoryPage& page) {
572 return MemoryPageState::Empty;
574 return MemoryPageState::Full;
575 return MemoryPageState::Partial;
578 static cnt::fwd_llist<MemoryPage>& page_list(MemoryPageContainer& container, MemoryPageState state) {
580 case MemoryPageState::Empty:
581 return container.pagesEmpty;
582 case MemoryPageState::Partial:
583 return container.pagesPartial;
585 GAIA_ASSERT(state == MemoryPageState::Full);
586 return container.pagesFull;
590 static void move_page(
591 MemoryPageContainer& container, MemoryPage* pPage, MemoryPageState fromState, MemoryPageState toState) {
592 if (fromState == toState)
595 if (fromState != MemoryPageState::Detached)
596 page_list(container, fromState).unlink(pPage);
597 page_list(container, toState).link(pPage);
600 [[maybe_unused]]
static void verify_page_membership(
601 [[maybe_unused]]
const MemoryPageContainer& container,
602 [[maybe_unused]]
const MemoryPage& page,
603 [[maybe_unused]] MemoryPageState expectedState
606 GAIA_ASSERT(state_for(page) == expectedState);
607 GAIA_ASSERT(page.get_fwd_llist_link().linked());
610 static void verify_container(
const MemoryPageContainer& container, uint32_t sizeType) {
612 for (
const auto& page: container.pagesEmpty) {
613 GAIA_ASSERT(page.m_sizeType == sizeType);
614 verify_page_membership(container, page, MemoryPageState::Empty);
618 for (
const auto& page: container.pagesPartial) {
619 GAIA_ASSERT(page.m_sizeType == sizeType);
620 verify_page_membership(container, page, MemoryPageState::Partial);
624 for (
const auto& page: container.pagesFull) {
625 GAIA_ASSERT(page.m_sizeType == sizeType);
626 verify_page_membership(container, page, MemoryPageState::Full);
631 ChunkAllocatorPageStats page_stats(uint32_t sizeType)
const {
632 ChunkAllocatorPageStats stats{};
633 const auto& container = m_pages[sizeType];
634 const auto blockSize = (uint64_t)mem_block_size(sizeType);
635 const auto pageSize = blockSize * MemoryPage::NBlocks;
637 stats.num_pages = (uint32_t)container.pagesEmpty.size() + (uint32_t)container.pagesPartial.size() +
638 (uint32_t)container.pagesFull.size();
639 stats.num_pages_free = (uint32_t)container.pagesEmpty.size() + (uint32_t)container.pagesPartial.size();
640 stats.mem_total = stats.num_pages * pageSize;
641 stats.mem_used = container.pagesFull.size() * pageSize;
644 stats.num_pages_empty = (uint32_t)container.pagesEmpty.size();
646 for (
const auto& page: container.pagesFull)
647 stats.mem_requested += page.requested_bytes();
649 for (
const auto& page: container.pagesPartial) {
650 stats.mem_used += page.used_blocks_cnt() * blockSize;
651 stats.mem_requested += page.requested_bytes();
654 for (
const auto& page: container.pagesPartial)
655 stats.mem_used += page.used_blocks_cnt() * blockSize;
663 void flushPages(MemoryPageContainer& container, uint32_t sizeType,
bool releaseAll) {
664 const bool keepWarmPage = !releaseAll && warm_pages_to_keep(sizeType) != 0;
665 bool keptWarmPage =
false;
666 for (
auto it = container.pagesEmpty.begin(); it != container.pagesEmpty.end();) {
667 auto* pPage = &(*it);
674 if (keepWarmPage && !keptWarmPage) {
679 container.pagesEmpty.unlink(pPage);
Checks if endianess was detected correctly at compile-time.
Definition bitset.h:9