Inital commit

This commit is contained in:
2026-07-11 17:01:42 -05:00
commit 4e0219924d
83 changed files with 70924 additions and 0 deletions

View File

@@ -0,0 +1,2 @@
DisableFormat: true
SortIncludes: Never

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,74 @@
The RmlUi DirectX 12 renderer includes thirdparty code with the following licenses.
----- D3D12MemAlloc.cpp/.h -----
Copyright (c) 2019-2024 Advanced Micro Devices, Inc. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
----- offsetAllocator.cpp/.hpp -----
MIT License
Copyright (c) 2023 Sebastian Aaltonen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
----- Snippets from d3dx12.h header (included directly in RmlUi_Renderer_DX12.cpp) -----
The MIT License (MIT)
Copyright (c) 2015 Microsoft
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,513 @@
// (C) Sebastian Aaltonen 2023
// MIT License (see file: LICENSE)
#include "offsetAllocator.hpp"
#ifdef DEBUG
#include <assert.h>
#define ASSERT(x) assert(x)
//#define DEBUG_VERBOSE
#else
#define ASSERT(x)
#endif
#ifdef DEBUG_VERBOSE
#include <stdio.h>
#endif
#ifdef _MSC_VER
#include <intrin.h>
#endif
#include <cstring>
namespace OffsetAllocator
{
inline uint32 lzcnt_nonzero(uint32 v)
{
#ifdef _MSC_VER
unsigned long retVal;
_BitScanReverse(&retVal, v);
return 31 - retVal;
#else
return __builtin_clz(v);
#endif
}
inline uint32 tzcnt_nonzero(uint32 v)
{
#ifdef _MSC_VER
unsigned long retVal;
_BitScanForward(&retVal, v);
return retVal;
#else
return __builtin_ctz(v);
#endif
}
namespace SmallFloat
{
static constexpr uint32 MANTISSA_BITS = 3;
static constexpr uint32 MANTISSA_VALUE = 1 << MANTISSA_BITS;
static constexpr uint32 MANTISSA_MASK = MANTISSA_VALUE - 1;
// Bin sizes follow floating point (exponent + mantissa) distribution (piecewise linear log approx)
// This ensures that for each size class, the average overhead percentage stays the same
uint32 uintToFloatRoundUp(uint32 size)
{
uint32 exp = 0;
uint32 mantissa = 0;
if (size < MANTISSA_VALUE)
{
// Denorm: 0..(MANTISSA_VALUE-1)
mantissa = size;
}
else
{
// Normalized: Hidden high bit always 1. Not stored. Just like float.
uint32 leadingZeros = lzcnt_nonzero(size);
uint32 highestSetBit = 31 - leadingZeros;
uint32 mantissaStartBit = highestSetBit - MANTISSA_BITS;
exp = mantissaStartBit + 1;
mantissa = (size >> mantissaStartBit) & MANTISSA_MASK;
uint32 lowBitsMask = (1 << mantissaStartBit) - 1;
// Round up!
if ((size & lowBitsMask) != 0)
mantissa++;
}
return (exp << MANTISSA_BITS) + mantissa; // + allows mantissa->exp overflow for round up
}
uint32 uintToFloatRoundDown(uint32 size)
{
uint32 exp = 0;
uint32 mantissa = 0;
if (size < MANTISSA_VALUE)
{
// Denorm: 0..(MANTISSA_VALUE-1)
mantissa = size;
}
else
{
// Normalized: Hidden high bit always 1. Not stored. Just like float.
uint32 leadingZeros = lzcnt_nonzero(size);
uint32 highestSetBit = 31 - leadingZeros;
uint32 mantissaStartBit = highestSetBit - MANTISSA_BITS;
exp = mantissaStartBit + 1;
mantissa = (size >> mantissaStartBit) & MANTISSA_MASK;
}
return (exp << MANTISSA_BITS) | mantissa;
}
uint32 floatToUint(uint32 floatValue)
{
uint32 exponent = floatValue >> MANTISSA_BITS;
uint32 mantissa = floatValue & MANTISSA_MASK;
if (exponent == 0)
{
// Denorms
return mantissa;
}
else
{
return (mantissa | MANTISSA_VALUE) << (exponent - 1);
}
}
}
// Utility functions
uint32 findLowestSetBitAfter(uint32 bitMask, uint32 startBitIndex)
{
uint32 maskBeforeStartIndex = (1 << startBitIndex) - 1;
uint32 maskAfterStartIndex = ~maskBeforeStartIndex;
uint32 bitsAfter = bitMask & maskAfterStartIndex;
if (bitsAfter == 0) return Allocation::NO_SPACE;
return tzcnt_nonzero(bitsAfter);
}
// Allocator...
Allocator::Allocator(uint32 size, uint32 maxAllocs) :
m_size(size),
m_maxAllocs(maxAllocs),
m_nodes(nullptr),
m_freeNodes(nullptr)
{
if (sizeof(NodeIndex) == 2)
{
ASSERT(maxAllocs <= 65536);
}
reset();
}
Allocator::Allocator(Allocator &&other) :
m_size(other.m_size),
m_maxAllocs(other.m_maxAllocs),
m_freeStorage(other.m_freeStorage),
m_usedBinsTop(other.m_usedBinsTop),
m_nodes(other.m_nodes),
m_freeNodes(other.m_freeNodes),
m_freeOffset(other.m_freeOffset)
{
memcpy(m_usedBins, other.m_usedBins, sizeof(uint8) * NUM_TOP_BINS);
memcpy(m_binIndices, other.m_binIndices, sizeof(NodeIndex) * NUM_LEAF_BINS);
other.m_nodes = nullptr;
other.m_freeNodes = nullptr;
other.m_freeOffset = 0;
other.m_maxAllocs = 0;
other.m_usedBinsTop = 0;
}
void Allocator::reset()
{
m_freeStorage = 0;
m_usedBinsTop = 0;
m_freeOffset = m_maxAllocs - 1;
for (uint32 i = 0 ; i < NUM_TOP_BINS; i++)
m_usedBins[i] = 0;
for (uint32 i = 0 ; i < NUM_LEAF_BINS; i++)
m_binIndices[i] = Node::unused;
if (m_nodes) delete[] m_nodes;
if (m_freeNodes) delete[] m_freeNodes;
m_nodes = new Node[m_maxAllocs];
m_freeNodes = new NodeIndex[m_maxAllocs];
// Freelist is a stack. Nodes in inverse order so that [0] pops first.
for (uint32 i = 0; i < m_maxAllocs; i++)
{
m_freeNodes[i] = m_maxAllocs - i - 1;
}
// Start state: Whole storage as one big node
// Algorithm will split remainders and push them back as smaller nodes
insertNodeIntoBin(m_size, 0);
}
Allocator::~Allocator()
{
delete[] m_nodes;
delete[] m_freeNodes;
}
Allocation Allocator::allocate(uint32 size)
{
// Out of allocations?
if (m_freeOffset == 0)
{
Allocation result;
result.offset = Allocation::NO_SPACE;
result.metadata = Allocation::NO_SPACE;
//return {.offset = Allocation::NO_SPACE, .metadata = Allocation::NO_SPACE};
return result;
}
// Round up to bin index to ensure that alloc >= bin
// Gives us min bin index that fits the size
uint32 minBinIndex = SmallFloat::uintToFloatRoundUp(size);
uint32 minTopBinIndex = minBinIndex >> TOP_BINS_INDEX_SHIFT;
uint32 minLeafBinIndex = minBinIndex & LEAF_BINS_INDEX_MASK;
uint32 topBinIndex = minTopBinIndex;
uint32 leafBinIndex = Allocation::NO_SPACE;
// If top bin exists, scan its leaf bin. This can fail (NO_SPACE).
if (m_usedBinsTop & (1 << topBinIndex))
{
leafBinIndex = findLowestSetBitAfter(m_usedBins[topBinIndex], minLeafBinIndex);
}
// If we didn't find space in top bin, we search top bin from +1
if (leafBinIndex == Allocation::NO_SPACE)
{
topBinIndex = findLowestSetBitAfter(m_usedBinsTop, minTopBinIndex + 1);
// Out of space?
if (topBinIndex == Allocation::NO_SPACE)
{
Allocation result;
result.offset = Allocation::NO_SPACE;
result.metadata = Allocation::NO_SPACE;
//return {.offset = Allocation::NO_SPACE, .metadata = Allocation::NO_SPACE};
return result;
}
// All leaf bins here fit the alloc, since the top bin was rounded up. Start leaf search from bit 0.
// NOTE: This search can't fail since at least one leaf bit was set because the top bit was set.
leafBinIndex = tzcnt_nonzero(m_usedBins[topBinIndex]);
}
uint32 binIndex = (topBinIndex << TOP_BINS_INDEX_SHIFT) | leafBinIndex;
// Pop the top node of the bin. Bin top = node.next.
uint32 nodeIndex = m_binIndices[binIndex];
Node& node = m_nodes[nodeIndex];
uint32 nodeTotalSize = node.dataSize;
node.dataSize = size;
node.used = true;
m_binIndices[binIndex] = node.binListNext;
if (node.binListNext != Node::unused) m_nodes[node.binListNext].binListPrev = Node::unused;
m_freeStorage -= nodeTotalSize;
#ifdef DEBUG_VERBOSE
printf("Free storage: %u (-%u) (allocate)\n", m_freeStorage, nodeTotalSize);
#endif
// Bin empty?
if (m_binIndices[binIndex] == Node::unused)
{
// Remove a leaf bin mask bit
m_usedBins[topBinIndex] &= ~(1 << leafBinIndex);
// All leaf bins empty?
if (m_usedBins[topBinIndex] == 0)
{
// Remove a top bin mask bit
m_usedBinsTop &= ~(1 << topBinIndex);
}
}
// Push back reminder N elements to a lower bin
uint32 reminderSize = nodeTotalSize - size;
if (reminderSize > 0)
{
uint32 newNodeIndex = insertNodeIntoBin(reminderSize, node.dataOffset + size);
// Link nodes next to each other so that we can merge them later if both are free
// And update the old next neighbor to point to the new node (in middle)
if (node.neighborNext != Node::unused) m_nodes[node.neighborNext].neighborPrev = newNodeIndex;
m_nodes[newNodeIndex].neighborPrev = nodeIndex;
m_nodes[newNodeIndex].neighborNext = node.neighborNext;
node.neighborNext = newNodeIndex;
}
// return {.offset = node.dataOffset, .metadata = nodeIndex};
Allocation result;
result.offset = node.dataOffset;
result.metadata = nodeIndex;
return result;
}
void Allocator::free(Allocation allocation)
{
ASSERT(allocation.metadata != Allocation::NO_SPACE);
if (!m_nodes) return;
uint32 nodeIndex = allocation.metadata;
Node& node = m_nodes[nodeIndex];
// Double delete check
ASSERT(node.used == true);
// Merge with neighbors...
uint32 offset = node.dataOffset;
uint32 size = node.dataSize;
if ((node.neighborPrev != Node::unused) && (m_nodes[node.neighborPrev].used == false))
{
// Previous (contiguous) free node: Change offset to previous node offset. Sum sizes
Node& prevNode = m_nodes[node.neighborPrev];
offset = prevNode.dataOffset;
size += prevNode.dataSize;
// Remove node from the bin linked list and put it in the freelist
removeNodeFromBin(node.neighborPrev);
ASSERT(prevNode.neighborNext == nodeIndex);
node.neighborPrev = prevNode.neighborPrev;
}
if ((node.neighborNext != Node::unused) && (m_nodes[node.neighborNext].used == false))
{
// Next (contiguous) free node: Offset remains the same. Sum sizes.
Node& nextNode = m_nodes[node.neighborNext];
size += nextNode.dataSize;
// Remove node from the bin linked list and put it in the freelist
removeNodeFromBin(node.neighborNext);
ASSERT(nextNode.neighborPrev == nodeIndex);
node.neighborNext = nextNode.neighborNext;
}
uint32 neighborNext = node.neighborNext;
uint32 neighborPrev = node.neighborPrev;
// Insert the removed node to freelist
#ifdef DEBUG_VERBOSE
printf("Putting node %u into freelist[%u] (free)\n", nodeIndex, m_freeOffset + 1);
#endif
m_freeNodes[++m_freeOffset] = nodeIndex;
// Insert the (combined) free node to bin
uint32 combinedNodeIndex = insertNodeIntoBin(size, offset);
// Connect neighbors with the new combined node
if (neighborNext != Node::unused)
{
m_nodes[combinedNodeIndex].neighborNext = neighborNext;
m_nodes[neighborNext].neighborPrev = combinedNodeIndex;
}
if (neighborPrev != Node::unused)
{
m_nodes[combinedNodeIndex].neighborPrev = neighborPrev;
m_nodes[neighborPrev].neighborNext = combinedNodeIndex;
}
}
uint32 Allocator::insertNodeIntoBin(uint32 size, uint32 dataOffset)
{
// Round down to bin index to ensure that bin >= alloc
uint32 binIndex = SmallFloat::uintToFloatRoundDown(size);
uint32 topBinIndex = binIndex >> TOP_BINS_INDEX_SHIFT;
uint32 leafBinIndex = binIndex & LEAF_BINS_INDEX_MASK;
// Bin was empty before?
if (m_binIndices[binIndex] == Node::unused)
{
// Set bin mask bits
m_usedBins[topBinIndex] |= 1 << leafBinIndex;
m_usedBinsTop |= 1 << topBinIndex;
}
// Take a freelist node and insert on top of the bin linked list (next = old top)
uint32 topNodeIndex = m_binIndices[binIndex];
uint32 nodeIndex = m_freeNodes[m_freeOffset--];
#ifdef DEBUG_VERBOSE
printf("Getting node %u from freelist[%u]\n", nodeIndex, m_freeOffset + 1);
#endif
// m_nodes[nodeIndex] = {.dataOffset = dataOffset, .dataSize = size, .binListNext = topNodeIndex};
Node node_instance;
node_instance.dataOffset = dataOffset;
node_instance.dataSize = size;
node_instance.binListNext = topNodeIndex;
m_nodes[nodeIndex] = node_instance;
if (topNodeIndex != Node::unused) m_nodes[topNodeIndex].binListPrev = nodeIndex;
m_binIndices[binIndex] = nodeIndex;
m_freeStorage += size;
#ifdef DEBUG_VERBOSE
printf("Free storage: %u (+%u) (insertNodeIntoBin)\n", m_freeStorage, size);
#endif
return nodeIndex;
}
void Allocator::removeNodeFromBin(uint32 nodeIndex)
{
Node &node = m_nodes[nodeIndex];
if (node.binListPrev != Node::unused)
{
// Easy case: We have previous node. Just remove this node from the middle of the list.
m_nodes[node.binListPrev].binListNext = node.binListNext;
if (node.binListNext != Node::unused) m_nodes[node.binListNext].binListPrev = node.binListPrev;
}
else
{
// Hard case: We are the first node in a bin. Find the bin.
// Round down to bin index to ensure that bin >= alloc
uint32 binIndex = SmallFloat::uintToFloatRoundDown(node.dataSize);
uint32 topBinIndex = binIndex >> TOP_BINS_INDEX_SHIFT;
uint32 leafBinIndex = binIndex & LEAF_BINS_INDEX_MASK;
m_binIndices[binIndex] = node.binListNext;
if (node.binListNext != Node::unused) m_nodes[node.binListNext].binListPrev = Node::unused;
// Bin empty?
if (m_binIndices[binIndex] == Node::unused)
{
// Remove a leaf bin mask bit
m_usedBins[topBinIndex] &= ~(1 << leafBinIndex);
// All leaf bins empty?
if (m_usedBins[topBinIndex] == 0)
{
// Remove a top bin mask bit
m_usedBinsTop &= ~(1 << topBinIndex);
}
}
}
// Insert the node to freelist
#ifdef DEBUG_VERBOSE
printf("Putting node %u into freelist[%u] (removeNodeFromBin)\n", nodeIndex, m_freeOffset + 1);
#endif
m_freeNodes[++m_freeOffset] = nodeIndex;
m_freeStorage -= node.dataSize;
#ifdef DEBUG_VERBOSE
printf("Free storage: %u (-%u) (removeNodeFromBin)\n", m_freeStorage, node.dataSize);
#endif
}
uint32 Allocator::allocationSize(Allocation allocation) const
{
if (allocation.metadata == Allocation::NO_SPACE) return 0;
if (!m_nodes) return 0;
return m_nodes[allocation.metadata].dataSize;
}
StorageReport Allocator::storageReport() const
{
uint32 largestFreeRegion = 0;
uint32 freeStorage = 0;
// Out of allocations? -> Zero free space
if (m_freeOffset > 0)
{
freeStorage = m_freeStorage;
if (m_usedBinsTop)
{
uint32 topBinIndex = 31 - lzcnt_nonzero(m_usedBinsTop);
uint32 leafBinIndex = 31 - lzcnt_nonzero(m_usedBins[topBinIndex]);
largestFreeRegion = SmallFloat::floatToUint((topBinIndex << TOP_BINS_INDEX_SHIFT) | leafBinIndex);
ASSERT(freeStorage >= largestFreeRegion);
}
}
// return {.totalFreeSpace = freeStorage, .largestFreeRegion = largestFreeRegion};
StorageReport result;
result.totalFreeSpace = freeStorage;
result.largestFreeRegion = largestFreeRegion;
return result;
}
StorageReportFull Allocator::storageReportFull() const
{
StorageReportFull report;
StorageReportFull::Region region;
for (uint32 i = 0; i < NUM_LEAF_BINS; i++)
{
uint32 count = 0;
uint32 nodeIndex = m_binIndices[i];
while (nodeIndex != Node::unused)
{
nodeIndex = m_nodes[nodeIndex].binListNext;
count++;
}
region.size = SmallFloat::floatToUint(i);
region.count = count;
// report.freeRegions[i] = { .size = SmallFloat::floatToUint(i), .count = count };
report.freeRegions[i] = region;
}
return report;
}
}

View File

@@ -0,0 +1,97 @@
// (C) Sebastian Aaltonen 2023
// MIT License (see file: LICENSE)
//#define USE_16_BIT_OFFSETS
#pragma once
namespace OffsetAllocator
{
typedef unsigned char uint8;
typedef unsigned short uint16;
typedef unsigned int uint32;
// 16 bit offsets mode will halve the metadata storage cost
// But it only supports up to 65536 maximum allocation count
#ifdef USE_16_BIT_NODE_INDICES
typedef uint16 NodeIndex;
#else
typedef uint32 NodeIndex;
#endif
static constexpr uint32 NUM_TOP_BINS = 32;
static constexpr uint32 BINS_PER_LEAF = 8;
static constexpr uint32 TOP_BINS_INDEX_SHIFT = 3;
static constexpr uint32 LEAF_BINS_INDEX_MASK = 0x7;
static constexpr uint32 NUM_LEAF_BINS = NUM_TOP_BINS * BINS_PER_LEAF;
struct Allocation
{
static constexpr uint32 NO_SPACE = 0xffffffff;
uint32 offset = NO_SPACE;
NodeIndex metadata = NO_SPACE; // internal: node index
};
struct StorageReport
{
uint32 totalFreeSpace;
uint32 largestFreeRegion;
};
struct StorageReportFull
{
struct Region
{
uint32 size;
uint32 count;
};
Region freeRegions[NUM_LEAF_BINS];
};
class Allocator
{
public:
Allocator(uint32 size, uint32 maxAllocs = 128 * 1024);
Allocator(Allocator &&other);
~Allocator();
void reset();
Allocation allocate(uint32 size);
void free(Allocation allocation);
uint32 allocationSize(Allocation allocation) const;
StorageReport storageReport() const;
StorageReportFull storageReportFull() const;
private:
uint32 insertNodeIntoBin(uint32 size, uint32 dataOffset);
void removeNodeFromBin(uint32 nodeIndex);
struct Node
{
static constexpr NodeIndex unused = 0xffffffff;
uint32 dataOffset = 0;
uint32 dataSize = 0;
NodeIndex binListPrev = unused;
NodeIndex binListNext = unused;
NodeIndex neighborPrev = unused;
NodeIndex neighborNext = unused;
bool used = false; // TODO: Merge as bit flag
};
uint32 m_size;
uint32 m_maxAllocs;
uint32 m_freeStorage;
uint32 m_usedBinsTop;
uint8 m_usedBins[NUM_TOP_BINS];
NodeIndex m_binIndices[NUM_LEAF_BINS];
Node* m_nodes;
NodeIndex* m_freeNodes;
uint32 m_freeOffset;
};
}