aboutsummaryrefslogtreecommitdiff
path: root/src/zencore/memory/mallocmimalloc.cpp
blob: 1919af3bfba098e0f5b5967d1298aeb70ebdf3b9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// Copyright Epic Games, Inc. All Rights Reserved.

#include <zencore/intmath.h>
#include <zencore/memory/align.h>
#include <zencore/memory/mallocmimalloc.h>

#if ZEN_MIMALLOC_ENABLED

#	include <mimalloc.h>

/** Value we fill a memory block with after it is free, in UE_BUILD_DEBUG **/
#	define DEBUG_FILL_FREED (0xdd)

/** Value we fill a new memory block with, in UE_BUILD_DEBUG **/
#	define DEBUG_FILL_NEW (0xcd)

#	define ZEN_ENABLE_DEBUG_FILL 1

namespace zen {

// Dramatically reduce memory zeroing and page faults during alloc intense workloads
// by keeping freed pages for a little while instead of releasing them
// right away to the OS, effectively acting like a scratch buffer
// until pages are both freed and inactive for the delay specified
// in milliseconds.
int32_t GMiMallocMemoryResetDelay = 10000;

FMallocMimalloc::FMallocMimalloc()
{
	mi_option_set(mi_option_reset_delay, GMiMallocMemoryResetDelay);
}

void*
FMallocMimalloc::TryMalloc(size_t Size, uint32_t Alignment)
{
	void* NewPtr = nullptr;

	if (Alignment != DEFAULT_ALIGNMENT)
	{
		Alignment = Max(uint32_t(Size >= 16 ? 16 : 8), Alignment);
		NewPtr	  = mi_malloc_aligned(Size, Alignment);
	}
	else
	{
		NewPtr = mi_malloc_aligned(Size, uint32_t(Size >= 16 ? 16 : 8));
	}

#	if ZEN_BUILD_DEBUG && ZEN_ENABLE_DEBUG_FILL
	if (Size && NewPtr != nullptr)
	{
		memset(NewPtr, DEBUG_FILL_NEW, mi_usable_size(NewPtr));
	}
#	endif

	return NewPtr;
}

void*
FMallocMimalloc::Malloc(size_t Size, uint32_t Alignment)
{
	void* Result = TryMalloc(Size, Alignment);

	if (Result == nullptr && Size)
	{
		OutOfMemory(Size, Alignment);
	}

	return Result;
}

void*
FMallocMimalloc::TryRealloc(void* Ptr, size_t NewSize, uint32_t Alignment)
{
#	if ZEN_BUILD_DEBUG && ZEN_ENABLE_DEBUG_FILL
	size_t OldSize = 0;
	if (Ptr)
	{
		OldSize = mi_malloc_size(Ptr);
		if (NewSize < OldSize)
		{
			memset((uint8_t*)Ptr + NewSize, DEBUG_FILL_FREED, OldSize - NewSize);
		}
	}
#	endif
	void* NewPtr = nullptr;

	if (NewSize == 0)
	{
		mi_free(Ptr);

		return nullptr;
	}

#	if ZEN_PLATFORM_MAC
	// macOS expects all allocations to be aligned to 16 bytes, so on Mac we always have to use mi_realloc_aligned
	Alignment = AlignArbitrary(Max((uint32_t)16, Alignment), (uint32_t)16);
	NewPtr	  = mi_realloc_aligned(Ptr, NewSize, Alignment);
#	else
	if (Alignment != DEFAULT_ALIGNMENT)
	{
		Alignment = Max(NewSize >= 16 ? (uint32_t)16 : (uint32_t)8, Alignment);
		NewPtr	  = mi_realloc_aligned(Ptr, NewSize, Alignment);
	}
	else
	{
		NewPtr = mi_realloc(Ptr, NewSize);
	}
#	endif

#	if ZEN_BUILD_DEBUG && ZEN_ENABLE_DEBUG_FILL
	if (NewPtr && NewSize > OldSize)
	{
		memset((uint8_t*)NewPtr + OldSize, DEBUG_FILL_NEW, mi_usable_size(NewPtr) - OldSize);
	}
#	endif

	return NewPtr;
}

void*
FMallocMimalloc::Realloc(void* Ptr, size_t NewSize, uint32_t Alignment)
{
	void* Result = TryRealloc(Ptr, NewSize, Alignment);

	if (Result == nullptr && NewSize)
	{
		OutOfMemory(NewSize, Alignment);
	}

	return Result;
}

void
FMallocMimalloc::Free(void* Ptr)
{
	if (!Ptr)
	{
		return;
	}

#	if ZEN_BUILD_DEBUG && ZEN_ENABLE_DEBUG_FILL
	memset(Ptr, DEBUG_FILL_FREED, mi_usable_size(Ptr));
#	endif

	mi_free(Ptr);
}

void*
FMallocMimalloc::MallocZeroed(size_t Size, uint32_t Alignment)
{
	void* Result = TryMallocZeroed(Size, Alignment);

	if (Result == nullptr && Size)
	{
		OutOfMemory(Size, Alignment);
	}

	return Result;
}

void*
FMallocMimalloc::TryMallocZeroed(size_t Size, uint32_t Alignment)
{
	void* NewPtr = nullptr;

	if (Alignment != DEFAULT_ALIGNMENT)
	{
		Alignment = Max(uint32_t(Size >= 16 ? 16 : 8), Alignment);
		NewPtr	  = mi_zalloc_aligned(Size, Alignment);
	}
	else
	{
		NewPtr = mi_zalloc_aligned(Size, uint32_t(Size >= 16 ? 16 : 8));
	}

	return NewPtr;
}

bool
FMallocMimalloc::GetAllocationSize(void* Original, size_t& SizeOut)
{
	SizeOut = mi_malloc_size(Original);
	return true;
}

void
FMallocMimalloc::Trim(bool bTrimThreadCaches)
{
	mi_collect(bTrimThreadCaches);
}

#	undef DEBUG_FILL_FREED
#	undef DEBUG_FILL_NEW

}  // namespace zen

#endif	// MIMALLOC_ENABLED