tetrees/Plugins/Wwise/ThirdParty/include/AK/SoundEngine/Common/AkMemoryMgr.h

/*******************************************************************************
The content of this file includes portions of the AUDIOKINETIC Wwise Technology
released in source code form as part of the SDK installer package.

Commercial License Usage

Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
may use this file in accordance with the end user license agreement provided
with the software or, alternatively, in accordance with the terms contained in a
written agreement between you and Audiokinetic Inc.

Apache License Usage

Alternatively, this file may be used under the Apache License, Version 2.0 (the
"Apache License"); you may not use this file except in compliance with the
Apache License. You may obtain a copy of the Apache License at
http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed
under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
the specific language governing permissions and limitations under the License.

  Copyright (c) 2023 Audiokinetic Inc.
*******************************************************************************/

/// \file
/// Memory Manager namespace.

#ifndef _AKMEMORYMGR_H_
#define _AKMEMORYMGR_H_

#if !defined( AK_OPTIMIZED ) && !( defined AK_DISABLE_MEMDEBUG )
	#ifndef AK_MEMDEBUG
		#define AK_MEMDEBUG
	#endif
#endif

#include <AK/SoundEngine/Common/AkTypes.h>
#include <AK/SoundEngine/Common/AkSoundEngineExport.h>

struct AkMemSettings;

/// Memory category IDs.
enum AkMemID
{
	AkMemID_Object,                 ///< Generic placeholder for allocations tied to the Wwise project.
	AkMemID_Event,                  ///< Events from the Wwise project.
	AkMemID_Structure,              ///< Structures from the Wwise project.
	AkMemID_Media,                  ///< Media from the Wwise project.
	AkMemID_GameObject,             ///< Game Objects and related.
	AkMemID_Processing,             ///< Anything tied to instancing and processing of the DSP graph.
	AkMemID_ProcessingPlugin,       ///< Plug-in allocations related to the DSP graph.
	AkMemID_Streaming,              ///< Streaming Manager objects.
	AkMemID_StreamingIO,            ///< Streaming Manager I/O memory.
	AkMemID_SpatialAudio,           ///< Spatial audio.
	AkMemID_SpatialAudioGeometry,   ///< Spatial audio geometry data.
	AkMemID_SpatialAudioPaths,      ///< Spatial audio paths data.
	AkMemID_GameSim,                ///< Game Simulator allocations.
	AkMemID_MonitorQueue,           ///< Monitor Queue.
	AkMemID_Profiler,               ///< Profiler.
	AkMemID_FilePackage,            ///< File packager.
	AkMemID_SoundEngine,            ///< Base sound engine allocations (managers, etc).
	AkMemID_Integration,            ///< Game engine integration allocations.
	AkMemID_JobMgr,                 ///< Allocations for Sound Engine jobs and job dependencies.
	AkMemID_TempAudioRender,        ///< Temporary allocations for audio render.

	AkMemID_NUM,                    ///< Category count.
	AkMemID_MASK = 0x1FFFFFFF,      ///< Mask for category IDs.

	AkMemType_Media = 0x20000000,   ///< Media memory type bit.
	AkMemType_Device = 0x40000000,  ///< Device memory type bit.
	AkMemType_NoTrack = 0x80000000  ///< Do not track this allocation.
};

namespace AK
{
	/// Memory Manager namespace.
	/// \remarks The functions in this namespace are thread-safe, unless stated otherwise.
	/// \sa
	/// - \ref memorymanager
	namespace MemoryMgr
	{
		/// Memory category statistics.
		/// \remarks These statistics are not collected in the Release configuration of
		/// the default memory manager implementation.
		/// \sa
		/// - AK::MemoryMgr::GetCategoryStats()
		/// - \ref memorymanager
		struct CategoryStats
		{
			// Current state
			AkUInt64 uUsed;			///< Used memory (in bytes)

			// Statistics
			AkUInt64 uPeakUsed;		///< Peak used memory (in bytes)
			AkUInt32 uAllocs;		///< Number of allocation calls since initialization
			AkUInt32 uFrees;		///< Number of free calls since initialization
		};

		/// Memory global statistics.
		/// \remarks These statistics are not collected in the Release configuration of
		/// the default memory manager implementation.
		/// \sa
		/// - AK::MemoryMgr::GetGlobalStats()
		/// - \ref memorymanager
		struct GlobalStats
		{
			AkUInt64 uUsed;			///< Total memory used including all categories (in bytes)
			AkUInt64 uDeviceUsed;	///< Total device memory used including all categories (in bytes)
			AkUInt64 uReserved;		///< Total reserved memory. (Used and unused). Will return 0 if the reserved memory is not traceable.
			AkUInt64 uMax;			///< Maximum total allocation size, specified in the initialization settings through uMemAllocationSizeLimit. Will be 0 if no limit was set.
		};

		////////////////////////////////////////////////////////////////////////
		/// @name Initialization
		//@{

		/// Query whether the Memory Manager has been sucessfully initialized.
		/// \warning This function is not thread-safe. It should not be called at the same time as MemoryMgr::Init or MemoryMgr::Term.
		/// \return True if the Memory Manager is initialized, False otherwise
		/// \sa
		/// - AK::MemoryMgr::Init()
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( bool, IsInitialized )();

		/// Terminate the Memory Manager.
		/// \warning This function is not thread-safe. It is not valid to allocate memory or otherwise interact with the memory manager during or after this call.
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void, Term )();

		/// Performs whatever steps are required to initialize a thread for use with the memory manager.
		/// For example initializing thread local storage that the allocator requires to work.
		/// The default implementation of the memory manager performs thread initialization automatically and therefore this call is optional.
		/// For implementations where the cost of automatically initializing a thread for use with an allocator would be prohibitively expensive
		/// this call allows you to perform the initialization once during, for example, thread creation.
		/// \sa
		/// - AkMemInitForThread
		AK_EXTERNAPIFUNC( void, InitForThread )();

		/// Allows you to manually terminate a thread for use with the memory manager.
		/// The default implementation of the memory manager requires that all threads that interact with the memory manager call this function prior
		/// to either their termination or the termination of the memory manager. Threads not created by the sound engine itself will not have this
		/// function called for them automatically.
		/// Take care to call this function for any thread, not owned by wwise, that may have interacted with the memory manager. For example job system workers.
		/// \sa
		/// - AkMemTermForThread
		AK_EXTERNAPIFUNC( void, TermForThread )();

		/// Allows you to "trim" a thread being used with the memory manager.
		/// This is a function that will be called periodically by some Wwise-owned threads,
		/// so that any thread-local state can be cleaned up in order to return memory for other systems to use.
		/// For example, this can be used to return thread-local heaps to global stores or to finalize other deferred operations.
		/// This function is only required for optimization purposes and does not have to be defined.
		/// Therefore, unlike TermForThread, this is not expected to be called in all scenarios by Wwise.
		/// It is also recommended to be called by game engine integrations in any worker threads that run Wwise jobs.
		/// Refer to \ref eventmgrthread_jobmgr_best_practices for more information.
		/// \sa
		/// - AkMemTrimForThread
		AK_EXTERNAPIFUNC( void, TrimForThread )();

		//@}

		////////////////////////////////////////////////////////////////////////
		/// @name Memory Allocation
		//@{

#ifdef AK_MEMDEBUG
		/// Allocate memory: debug version.
		/// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void *, dMalloc )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			size_t		in_uSize,				///< Number of bytes to allocate
			const char *in_pszFile,				///< Debug file name
			AkUInt32	in_uLine				///< Debug line number
			);
#endif // AK_MEMDEBUG

		/// Allocate memory.
		/// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void *, Malloc )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			size_t		in_uSize 				///< Number of bytes to allocate
			);

#ifdef AK_MEMDEBUG
		/// Reallocate memory: debug version.
		/// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void*, dRealloc )(
			AkMemPoolId	in_poolId,
			void		*in_pAlloc,
			size_t		in_uSize,
			const char	*in_pszFile,
			AkUInt32	in_uLine
			);
#endif // AK_MEMDEBUG

		/// Reallocate memory.
		/// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void *, Realloc )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			void *		in_pAlloc,				///< Pointer to the start of the allocated memory
			size_t		in_uSize 				///< Number of bytes to allocate
			);

#ifdef AK_MEMDEBUG
		/// Reallocate memory: debug version.
		/// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void*, dReallocAligned )(
			AkMemPoolId	in_poolId,				///< ID of the memory category (AkMemID)
			void		*in_pAlloc,				///< Pointer to the start of the allocated memory
			size_t		in_uSize,				///< Number of bytes to allocate
			AkUInt32	in_uAlignment,			///< Alignment (in bytes)
			const char	*in_pszFile,			///< Debug file name
			AkUInt32	in_uLine				///< Debug line number
			);
#endif // AK_MEMDEBUG

		/// Reallocate memory.
		/// \return A pointer to the start of the reallocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void *, ReallocAligned )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			void *		in_pAlloc,				///< Pointer to the start of the allocated memory
			size_t		in_uSize, 				///< Number of bytes to allocate
			AkUInt32	in_uAlignment			///< Alignment (in bytes)
			);

		/// Free memory allocated with the memory manager.
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void, Free )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			void *		in_pMemAddress			///< Pointer to the start of memory
			);

#ifdef AK_MEMDEBUG
		/// Allocate memory with a specific alignment. debug version.
		/// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void *, dMalign )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			size_t		in_uSize,				///< Number of bytes to allocate
			AkUInt32	in_uAlignment, 			///< Alignment (in bytes)
			const char*	 in_pszFile,			///< Debug file name
			AkUInt32	in_uLine				///< Debug line number
			);
#endif // AK_MEMDEBUG

		/// Allocate memory with a specific alignment.
		/// \return A pointer to the start of the allocated memory (NULL if the allocation could not be completed)
		/// \sa
		/// - \ref memorymanager
		AK_EXTERNAPIFUNC( void *, Malign )(
			AkMemPoolId in_poolId,				///< ID of the memory category (AkMemID)
			size_t		in_uSize, 				///< Number of bytes to allocate
			AkUInt32	in_uAlignment 			///< Alignment (in bytes)
			);

		//@}

		////////////////////////////////////////////////////////////////////////
		/// @name Memory Profiling
		//@{

		/// Get statistics for a given memory category.
		/// \note Be aware of the potentially incoherent nature of reporting such information during concurrent modification by multiple threads.
		AK_EXTERNAPIFUNC( void, GetCategoryStats )(
			AkMemPoolId	in_poolId,				///< ID of the memory category (AkMemID)
			CategoryStats& out_poolStats		///< Returned statistics.
			);

		/// Get statistics for overall memory manager usage.
		/// \note Be aware of the potentially incoherent nature of reporting such information during concurrent modification by multiple threads.
		AK_EXTERNAPIFUNC( void, GetGlobalStats )(
			GlobalStats& out_stats				///< Returned statistics.
			);

		/// Called to start profiling memory usage for one thread (the calling thread).
		/// \note Not implementing this will result in the Soundbank tab of the Wwise Profiler to show 0 bytes for memory usage.
		AK_EXTERNAPIFUNC( void, StartProfileThreadUsage )(
			);

		/// Called to stop profiling memory usage for the current thread.
		/// \return The amount of memory allocated by this thread since StartProfileThreadUsage was called.
		/// \note Not implementing this will result in the Soundbank tab of the Wwise Profiler to show 0 bytes for memory usage.
		AK_EXTERNAPIFUNC( AkUInt64, StopProfileThreadUsage )(
			);

		/// Dumps the currently tracked allocations to a file
		/// \note AkMemSettings::uMemoryDebugLevel must be enabled and the build must define AK_MEMDEBUG for this to work
		AK_EXTERNAPIFUNC( void, DumpToFile )(
			const AkOSChar* pszFilename			///< Filename.
			);

		//@}
	}
	
	/// TempAlloc namespace.
	/// \remarks The functions in this namespace are thread-safe, unless stated otherwise.
	namespace TempAlloc
	{
		////////////////////////////////////////////////////////////////////////
		/// @name TempAlloc systems
		//@{

		/// Temp-alloc memory statistics. Whenever these are fetched, they represent the last completed temp-alloc "tick".
		/// \remarks These statistics are not collected in the Release configuration of the memory mgr.
		struct Stats
		{
			AkUInt32 uMemUsed;          ///< Used memory (in bytes).
			AkUInt32 uMemAllocated;     ///< Allocated memory (in bytes).
			AkUInt32 uBlocksUsed;       ///< Number of individual blocks used.

			AkUInt32 uPeakMemUsed;      ///< The peak value for uMemUsed since initialization.
			AkUInt32 uPeakMemAllocated; ///< The peak value for uMemAllocated since initialization.
			AkUInt32 uPeakBlocksUsed;   ///< The peak value for uBlocksUsed since initialization.
			AkUInt32 uPeakBlockUsed;    ///< The peak amount of used memory in any single block since initialization.
		};

		/// IDs of temporary memory pools used by the sound engine.
		enum Type
		{
			Type_AudioRender,
			Type_NUM, // end of the enum list
		};

		/// Initialization settings for temporary-memory pools. Separate settings are specified for each temporary-memory pool.
		struct InitSettings
		{
			AkUInt32 uMinimumBlockCount;    ///< The number of blocks of memory the system is initialized with and is the minimum kept around forever. Defaults to 1. Higher values increase upfront memory use, but can reduce, or eliminate, the creation and destruction of memory blocks over time. 
			AkUInt32 uMinimumBlockSize;     ///< The minimum size of each block. If a new allocation requests a new block of memory, then the new block is the size of the requested allocation times four, and then rounded up to the next multiple of this value. Defaults to 2MiB.
			AkUInt32 uMaximumUnusedBlocks;  ///< The maximum number of blocks that the system keeps in an unused state, and avoids freeing. Defaults to 1. Higher values do not increase the peak memory use, but do prevent unused memory from being freed, in order to reduce creation and destruction of memory blocks.

			// Various debug options for monitoring and analyzing potential issues in usage of the TempAlloc system. All of these are ignored (treated as disabled) in Release configurations.
			bool bDebugDetailedStats;       ///< Enable to track detailed stats and include them in the detailed stat dump. Detailed stats include the size and quantity of each type of allocation from the system. Disabled by default.
			bool bDebugClearMemory;         ///< Enable to clear any allocation to a deterministic garbage value. Useful to make sure memory is initialized properly. Disabled by default.
			bool bDebugEnableSentinels;     ///< Enable to write out sentinels between most allocations to help detect memory overwrites, verified at the end of a tick. Enabled by default. Increases memory usage of blocks slightly.
			bool bDebugFlushBlocks;         ///< Enable to forcefully release all blocks at the end of a tick and recreate them from scratch every tick. Useful to ensure stale memory is not being accessed. Disabled by default. This might interfere with some stats reporting due to blocks being released between ticks.
			bool bDebugStandaloneAllocs;    ///< Enable to force the block size to be as small as possible for each allocation (smaller than can be achieved by just setting uMinimumBlockSize to very low values). Useful to investigate memory overruns in-depth, especially in conjunction with other options like bDebugFlushBlocks and the MemoryMgr's stomp allocator. If enabled, bDebugDetailedStats and bDebugEnableSentinels will be disabled. Greatly increases CPU and memory usage.
		};

		/// Get simple statistics for a given temporary-memory pool
		AK_EXTERNAPIFUNC(void, GetStats)(
			Type in_eType,      ///< Temporary-memory pool type.
			Stats& out_stats    ///< Returned statistics.
			);

		/// Get a detailed listing of the allocations into the temp-alloc pool, and output them to a file.
		/// \note TempAllocInitSettings::bTrackDetailedStats must be enabled for the specified type to get detailed information about the underlying allocs. Otherwise, only the simple stats are listed.
		AK_EXTERNAPIFUNC(void, DumpTempAllocsToFile)(
			Type in_eType,      ///< Temporary-memory pool type.
			const AkOSChar* pszFilename    ///< Filename.
			);
	}
}

#endif // _AKMEMORYMGR_H_