docs: update memory and threading API docs

This commit is contained in:
2026-03-20 02:35:24 +08:00
parent c5b17239ca
commit fd792b7df1
103 changed files with 2485 additions and 673 deletions

View File

@@ -4,9 +4,7 @@
void Free(void* ptr) override;
```
释放内存并记录统计。调用转发到底层分配器,同时更新统计信息:递增 `totalFreed`(累加当前 `allocationCount`),并递减 `allocationCount`
**注意:** `totalFreed` 累加的是每次释放时的 `allocationCount`(分配计数)而非实际字节大小。这是一个简化的实现,用于追踪释放操作次数。
释放内存并记录统计。调用转发到底层分配器,同时更新统计信息:递增 `totalFreed`(累加释放字节数),并递减 `allocationCount`
**参数:**
- `ptr` - 指向要释放的内存块
@@ -31,9 +29,9 @@ proxy.Free(p1);
proxy.Free(p2);
const auto& stats = proxy.GetStats();
// totalFreed 累加了每次释放时的 allocationCount次数字节
// totalFreed 累加了释放的字节
// allocationCount 最终为 0
printf("Total allocated: %zu bytes, Freed count: %zu, Current count: %zu\n",
printf("Total allocated: %zu bytes, Freed: %zu bytes, Current count: %zu\n",
stats.totalAllocated, stats.totalFreed, stats.allocationCount);
```

View File

@@ -0,0 +1,37 @@
# ProxyAllocator::GetAllocationCount
```cpp
size_t GetAllocationCount() const override;
```
获取当前未释放的分配次数。
**参数:**
**返回:** 当前未释放的分配次数
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
proxy.Allocate(100);
proxy.Allocate(200);
void* p = proxy.Allocate(300);
proxy.Free(p);
size_t count = proxy.GetAllocationCount();
printf("Current allocation count: %zu\n", count);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,32 @@
# ProxyAllocator::GetName
```cpp
const char* GetName() const override;
```
获取分配器的名称字符串。
**参数:**
**返回:** 分配器名称字符串
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
const char* name = proxy.GetName();
printf("Allocator name: %s\n", name);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,37 @@
# ProxyAllocator::GetPeakAllocated
```cpp
size_t GetPeakAllocated() const override;
```
获取峰值分配的字节数。
**参数:**
**返回:** 峰值分配的字节数
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
proxy.Allocate(100);
proxy.Allocate(200);
proxy.Free(proxy.Allocate(50));
proxy.Free(proxy.Allocate(100));
size_t peakAllocated = proxy.GetPeakAllocated();
printf("Peak allocated: %zu bytes\n", peakAllocated);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,35 @@
# ProxyAllocator::GetTotalAllocated
```cpp
size_t GetTotalAllocated() const override;
```
获取累计分配的字节数。
**参数:**
**返回:** 累计分配的字节数
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
proxy.Allocate(100);
proxy.Allocate(200);
size_t totalAllocated = proxy.GetTotalAllocated();
printf("Total allocated: %zu bytes\n", totalAllocated);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -0,0 +1,35 @@
# ProxyAllocator::GetTotalFreed
```cpp
size_t GetTotalFreed() const override;
```
获取累计释放的字节数。
**参数:**
**返回:** 累计释放的字节数
**线程安全:**
**复杂度:** O(1)
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
ProxyAllocator proxy(sysAlloc, "TrackedAlloc");
void* p1 = proxy.Allocate(100);
proxy.Free(p1);
size_t totalFreed = proxy.GetTotalFreed();
printf("Total freed: %zu bytes\n", totalFreed);
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览

View File

@@ -4,6 +4,8 @@
**类型**: `class`
**头文件**: `XCEngine/Memory/ProxyAllocator.h`
**描述**: 代理分配器,用于统计和跟踪底层分配器的分配情况。
## 概述
@@ -14,12 +16,15 @@
| 方法 | 描述 |
|------|------|
| `ProxyAllocator` | 构造代理分配器 |
| `~ProxyAllocator` | 析构函数 |
| `Allocate` | 分配内存并记录统计 |
| `Free` | 释放内存并记录统计 |
| `Reallocate` | 转发到底层分配器 |
| `GetStats` | 获取详细统计信息 |
| [`Allocate`](allocate.md) | 分配内存并记录统计 |
| [`Free`](free.md) | 释放内存并记录统计 |
| [`Reallocate`](reallocate.md) | 转发到底层分配器 |
| [`GetStats`](get-stats.md) | 获取详细统计信息 |
| [`GetTotalAllocated`](get-total-allocated.md) | 获取累计分配字节数 |
| [`GetTotalFreed`](get-total-freed.md) | 获取累计释放字节数 |
| [`GetPeakAllocated`](get-peak-allocated.md) | 获取峰值分配字节数 |
| [`GetAllocationCount`](get-allocation-count.md) | 获取分配次数 |
| [`GetName`](get-name.md) | 获取分配器名称 |
## 构造函数

View File

@@ -4,7 +4,7 @@
void* Reallocate(void* ptr, size_t newSize) override;
```
重新分配内存。调用转发到底层分配器,不记录额外统计信息(底层分配器的返回值直接返回)。此方法线程安全,内部使用互斥锁保护。
重新分配内存。调用转发到底层分配器,同时更新统计信息(峰值分配和当前分配量)。此方法线程安全,内部使用互斥锁保护。
**参数:**
- `ptr` - 现有内存块指针

View File

@@ -1,37 +0,0 @@
# ProxyAllocator::~ProxyAllocator
```cpp
~ProxyAllocator() override;
```
销毁代理分配器。此析构函数不释放底层分配器,只清理代理分配器自身的统计信息(互斥锁等)。底层分配器由创建者负责管理。
**参数:**
**返回:**
**注意:** 析构函数不释放底层分配器。如果需要释放底层分配器,应先调用 `Shutdown` 或显式销毁底层分配器。
**示例:**
```cpp
#include <XCEngine/Memory/MemoryManager.h>
#include <XCEngine/Memory/ProxyAllocator.h>
{
MemoryManager::Get().Initialize();
IAllocator* sysAlloc = MemoryManager::Get().GetSystemAllocator();
auto proxy = MemoryManager::Get().CreateProxyAllocator("TrackedAlloc");
proxy->Allocate(1024);
// proxy 超出作用域时自动销毁
// 底层 sysAlloc 仍有效
MemoryManager::Get().Shutdown();
}
```
## 相关文档
- [ProxyAllocator 总览](proxy-allocator.md) - 返回类总览