Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
Memory.h
Go to the documentation of this file.
1// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
2// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
3// SPDX-License-Identifier: MIT
4
5#pragma once
6
8
9#ifndef JPH_DISABLE_CUSTOM_ALLOCATOR
10
11// Normal memory allocation, must be at least 8 byte aligned on 32 bit platform and 16 byte aligned on 64 bit platform
12using AllocateFunction = void *(*)(size_t inSize);
13using ReallocateFunction = void *(*)(void *inBlock, size_t inOldSize, size_t inNewSize);
14using FreeFunction = void (*)(void *inBlock);
15
16// Aligned memory allocation
17using AlignedAllocateFunction = void *(*)(size_t inSize, size_t inAlignment);
18using AlignedFreeFunction = void (*)(void *inBlock);
19
20// User defined allocation / free functions
26
29
30// 32-bit MinGW g++ doesn't call the correct overload for the new operator when a type is 16 bytes aligned.
31// It uses the non-aligned version, which on 32 bit platforms usually returns an 8 byte aligned block.
32// We therefore default to 16 byte aligned allocations when the regular new operator is used.
33// See: https://github.com/godotengine/godot/issues/105455#issuecomment-2824311547
34#if defined(JPH_COMPILER_MINGW) && JPH_CPU_ADDRESS_BITS == 32
35 #define JPH_INTERNAL_DEFAULT_ALLOCATE(size) JPH::AlignedAllocate(size, 16)
36 #define JPH_INTERNAL_DEFAULT_FREE(pointer) JPH::AlignedFree(pointer)
37#else
38 #define JPH_INTERNAL_DEFAULT_ALLOCATE(size) JPH::Allocate(size)
39 #define JPH_INTERNAL_DEFAULT_FREE(pointer) JPH::Free(pointer)
40#endif
41
43#define JPH_OVERRIDE_NEW_DELETE \
44 JPH_INLINE void *operator new (size_t inCount) { return JPH_INTERNAL_DEFAULT_ALLOCATE(inCount); } \
45 JPH_INLINE void operator delete (void *inPointer) noexcept { JPH_INTERNAL_DEFAULT_FREE(inPointer); } \
46 JPH_INLINE void *operator new[] (size_t inCount) { return JPH_INTERNAL_DEFAULT_ALLOCATE(inCount); } \
47 JPH_INLINE void operator delete[] (void *inPointer) noexcept { JPH_INTERNAL_DEFAULT_FREE(inPointer); } \
48 JPH_INLINE void *operator new (size_t inCount, std::align_val_t inAlignment) { return JPH::AlignedAllocate(inCount, static_cast<size_t>(inAlignment)); } \
49 JPH_INLINE void operator delete (void *inPointer, [[maybe_unused]] std::align_val_t inAlignment) noexcept { JPH::AlignedFree(inPointer); } \
50 JPH_INLINE void *operator new[] (size_t inCount, std::align_val_t inAlignment) { return JPH::AlignedAllocate(inCount, static_cast<size_t>(inAlignment)); } \
51 JPH_INLINE void operator delete[] (void *inPointer, [[maybe_unused]] std::align_val_t inAlignment) noexcept { JPH::AlignedFree(inPointer); } \
52 JPH_INLINE void *operator new ([[maybe_unused]] size_t inCount, void *inPointer) noexcept { return inPointer; } \
53 JPH_INLINE void operator delete ([[maybe_unused]] void *inPointer, [[maybe_unused]] void *inPlace) noexcept { /* Do nothing */ } \
54 JPH_INLINE void *operator new[] ([[maybe_unused]] size_t inCount, void *inPointer) noexcept { return inPointer; } \
55 JPH_INLINE void operator delete[] ([[maybe_unused]] void *inPointer, [[maybe_unused]] void *inPlace) noexcept { /* Do nothing */ }
56
57#else
58
59// Directly define the allocation functions
60JPH_EXPORT void *Allocate(size_t inSize);
61JPH_EXPORT void *Reallocate(void *inBlock, size_t inOldSize, size_t inNewSize);
62JPH_EXPORT void Free(void *inBlock);
63JPH_EXPORT void *AlignedAllocate(size_t inSize, size_t inAlignment);
64JPH_EXPORT void AlignedFree(void *inBlock);
65
66// Don't implement allocator registering
67inline void RegisterDefaultAllocator() { }
68
69// Don't override new/delete
70#define JPH_OVERRIDE_NEW_DELETE
71
72#endif // !JPH_DISABLE_CUSTOM_ALLOCATOR
73
#define JPH_EXPORT
Definition Core.h:275
#define JPH_NAMESPACE_END
Definition Core.h:419
#define JPH_NAMESPACE_BEGIN
Definition Core.h:413
void *(*)(void *inBlock, size_t inOldSize, size_t inNewSize) ReallocateFunction
Definition Memory.h:13
void *(*)(size_t inSize, size_t inAlignment) AlignedAllocateFunction
Definition Memory.h:17
JPH_EXPORT AlignedAllocateFunction AlignedAllocate
Definition Memory.cpp:71
void(*)(void *inBlock) FreeFunction
Definition Memory.h:14
JPH_EXPORT void RegisterDefaultAllocator()
Register platform default allocation / free functions.
Definition Memory.cpp:74
JPH_EXPORT AllocateFunction Allocate
Definition Memory.cpp:68
JPH_EXPORT ReallocateFunction Reallocate
Definition Memory.cpp:69
JPH_EXPORT AlignedFreeFunction AlignedFree
Definition Memory.cpp:72
void(*)(void *inBlock) AlignedFreeFunction
Definition Memory.h:18
void *(*)(size_t inSize) AllocateFunction
Definition Memory.h:12
JPH_EXPORT FreeFunction Free
Definition Memory.cpp:70