docs: add plugin setup guide

2026-05-30 18:33:24 +12:00
parent f3db41c402
commit b61043a3fe
1776 changed files with 122386 additions and 2 deletions
@@ -0,0 +1,86 @@
+#pragma once
+
+#include "RE/I/IMemoryStore.h"
+
+namespace RE
+{
+	class __declspec(novtable) ScrapHeap :
+		public IMemoryStore  // 00
+	{
+	public:
+		static constexpr auto RTTI{ RTTI::ScrapHeap };
+		static constexpr auto VTABLE{ VTABLE::ScrapHeap };
+
+		class Block
+		{
+		public:
+			// members
+			std::size_t sizeFlags;  // 00
+			Block*      prev;       // 08
+		};
+		static_assert(sizeof(Block) == 0x10);
+
+		class FreeBlock :
+			public Block  // 00
+		{
+		public:
+			// members
+			FreeBlock* left;   // 10
+			FreeBlock* right;  // 18
+		};
+		static_assert(sizeof(FreeBlock) == 0x20);
+
+		class FreeTreeNode :
+			public FreeBlock  // 00
+		{
+		public:
+			// members
+			FreeTreeNode** root;            // 20
+			FreeTreeNode*  leftNode;        // 28
+			FreeTreeNode*  rightNode;       // 30
+			std::size_t    parentAndBlack;  // 38
+		};
+		static_assert(sizeof(FreeTreeNode) == 0x40);
+
+		// NOLINTNEXTLINE(modernize-use-equals-default)
+		~ScrapHeap() override { REX::W32::VirtualFree(baseAddress, 0, REX::W32::MEM_RELEASE); }  // 00
+
+		// override (IMemoryStore)
+		std::size_t Size(void const* a_mem) const override { return *static_cast<const std::size_t*>(a_mem) & ~(std::size_t{ 3 } << 62); }  // 01
+		void        GetMemoryStats(MemoryStats*) override { return; }                                                                       // 02
+		bool        ContainsBlockImpl(const void* a_block) const override { return baseAddress <= a_block && a_block <= endAddress; }       // 03
+		void*       AllocateAlignImpl(std::size_t a_size, std::uint32_t a_alignment) override { return Allocate(a_size, a_alignment); }     // 04
+		void        DeallocateAlignImpl(void*& a_block) override { Deallocate(a_block), a_block = nullptr; }                                // 05
+
+		void* Allocate(std::size_t a_size, std::size_t a_alignment)
+		{
+			using func_t = decltype(&ScrapHeap::Allocate);
+			static REL::Relocation<func_t> func{ ID::ScrapHeap::Allocate };
+			return func(this, a_size, a_alignment);
+		}
+
+		void Deallocate(void* a_mem)
+		{
+			using func_t = decltype(&ScrapHeap::Deallocate);
+			static REL::Relocation<func_t> func{ ID::ScrapHeap::Deallocate };
+			return func(this, a_mem);
+		}
+
+		// members
+		FreeBlock*    smallBlocks[6]{ nullptr };  // 08
+		FreeTreeNode* freeList{ nullptr };        // 38
+		Block*        lastBlock{ nullptr };       // 40
+		std::byte*    baseAddress{ nullptr };     // 48
+		std::byte*    endAddress{ nullptr };      // 50
+		std::byte*    commitEnd{ nullptr };       // 58
+		std::size_t   reserveSize;                // 60
+		std::size_t   minCommit{ 1u << 17 };      // 68
+		std::size_t   totalAllocated{ 0 };        // 70
+		std::uint32_t keepPagesRequest{ 0 };      // 78
+		std::uint32_t totalFreeBlocks{ 0 };       // 7C
+		std::uint32_t freeSmallBlocks{ 0 };       // 80
+		std::uint32_t totalAllocatedBlocks{ 0 };  // 84
+		std::uint32_t pmpBarrier{ 0 };            // 88
+	};
+	static_assert(sizeof(ScrapHeap) == 0x90);
+}