Building GTS Malloc

Download the Source Code

Clone the repository.

git clone https://github.com/GameTechDev/GTS-GamesTaskScheduler.git

Build the Library

GTS Malloc uses premake to generate IDE projects and make files. GTS project generation and build options can be altered in
premake/_scripts_/gts_malloc_sln.lua.
See the premake wiki for documentation on how to alter the lua files or make you own project generator.

Windows

Generate a Microsoft Visual Studio solutions:
premake/gts_malloc.bat
- This will create the directory "_build", which contains several solutions.
Open a solution:
_build/gts_malloc/<vs*>/msvc/gts_malloc.sln
Select your target platform and build the solution. The build products will be located at:
_build/gts_malloc/<vs*>/msvc/<build_flavor>
- GTS Malloc can be built as both static and dynamic libraries.

Linux

Generate a gnu make file:
premake/linux/gts_malloc.bat
- This will create a directory that contains the make file.
  _build/gts_malloc/gmake
Build using make and select the desired configuration. (Open the Makefile to see all the configs.)
make -f "Makefile" config=<config_type>
- Build products are located in:
  _build/gts_malloc/gmake/<config>

Linking to GTS Malloc

The paths below are relative to the root location where GTS was cloned.

Header Files

Files	Description
source/gts/include/	Public header files.

Libraries

Static

Windows

File	Description
_build/gts_malloc/<vs*>/<compiler_flavor>/<build_flavor>/gts_malloc_static.lib	GTS Malloc static library

Refer to the Microsoft Visual Studio documentation on linking the application using MSVS solutions.

Linux

File	Description
_build/gts_malloc/gmake/<build_flavor>/gts_malloc.a	GTS Malloc static library

Shared

Windows

File	Description
_build/gts_malloc/<vs*>/<compiler_flavor>/<build_flavor>/gts_malloc_shared.lib	GTS Malloc import library
_build/gts_malloc/<vs*>/<compiler_flavor>/<build_flavor>/gts_malloc_shared.dll	GTS Malloc shared libaray
_build/gts_malloc/<vs*>/<compiler_flavor>/<build_flavor>/gts_malloc_redirect.lib	GTS Malloc redirection import library
_build/gts_malloc/<vs*>/<compiler_flavor>/<build_flavor>/gts_malloc_redirect.dll	GTS Malloc redirection shared library

Refer to the Microsoft Visual Studio documentation on linking the application using MSVS solutions.

Linux

File	Description
_build/gts_malloc/gmake/<build_flavor>/gts_malloc_shared.so	GTS Malloc shared libaray

Overriding Malloc

Static Override

Statically link gts_malloc. Include GtsMallocCOverride.h in each translation unit that will override malloc.

Warning: Care must be taken when using this method as one may mistakenly mix pointers from external code.

Dynamic Override

Windows

Dynamically link gts_malloc and gts_malloc_redirect. gts_malloc_redirect will automatically redirect calls to malloc.

Linux

Preload gts_malloc:

LD_PRELOAD=/path/to/gts_malloc.so myprogram

Overriding new/delete

To further override new/delete, include GtsMallocCppOverride.h.

Note: To do this add the header to single source file of the project.

GTS Malloc Build Options

GTS Malloc supports the following build-time options.

Option	Supported values (defaults in bold)	Description
GTS_ENABLE_ASSERTS	not defined, defined	Enables asserts in NDEBUG builds.
GTS_ENABLE_INTERNAL_ASSERTS	not defined, defined	Enables internal asserts in NDEBUG builds.
GTS_TRACE_CONCURRENT_USE_LOGGER	0, 1	Enables tracing with the ConcurrentLogger.
GTS_TRACE_USE_TRACY	0, 1	Enables tracing with the Tracy.
GTS_TRACE_USE_RAD_TELEMETRY	0, 1	Enables tracing with the RAD Telemetry. not tested
GTS_TRACE_USE_ITT	0, 1	Enables tracing with Intel's ITT.
GTS_ENABLE_COUNTER	not defined, defined	Enables statistics counters.
GTS_HAS_CUSTOM_CPU_INTRINSICS_WRAPPERS	not defined, defined	Indicates that the CPU intrinsic wrappers will be user provided in user_config.h.
GTS_HAS_CUSTOM_OS_MEMORY_WRAPPERS	not defined, defined	Indicates that the OS memory wrappers will be user provided in user_config.h.
GTS_HAS_CUSTOM_THREAD_WRAPPERS	not defined, defined	Indicates that the OS thread wrappers will be user provided in user_config.h.
GTS_HAS_CUSTOM_EVENT_WRAPPERS	not defined, defined	Indicates that the OS event wrappers will be user provided in user_config.h.
GTS_HAS_CUSTOM_ATOMICS_WRAPPERS	not defined, defined	Indicates that the atomics wrappers will be user provided in user_config.h.
GTS_HAS_CUSTOM_ASSERT_WRAPPER	not defined, defined	Indicates that assert handling will be user provided in user_config.h.
GTS_HAS_CUSTOM_TRACE_WRAPPER	not defined, defined	Indicates that the trace wrappers will be user provided in user_config.h.

Warning: All other build options that can be found in source files are dedicated for the development/debug purposes and are subject to change without any notice. Please avoid using them.

Tracing

Tracing overrides have the folowing precedence ordering:

GTS_HAS_CUSTOM_TRACE_WRAPPER
GTS_TRACE_USE_RAD_TELEMETRY
GTS_TRACE_USE_TRACY
GTS_TRACE_CONCURRENT_USE_LOGGER
GTS_TRACE_USE_ITT

See Tracing (TBD) for details.

Platform Overrides

If the user defines any of the GTS_HAS_CUSTOM_*; they must implement the corresponding macro in their user_config.h.

See Platform Replacement for details.