MallocTracked
Allocates a block of memory with specified size, alignment, and tracking information.
Read time 4 minutesLast updated 12 days ago
Definition
- Type: Method
- Namespace: Unity.Collections.LowLevel.Unsafe
- Assembly: UnityEngine.ManagedKernelModule
MallocTracked(long, int, Allocator, int)
Allocates a block of memory with specified size, alignment, and tracking information.
public static void* MallocTracked(long size, int alignment, Allocator allocator, int callstacksToSkip)
Parameters
The size of the memory block to allocate, in bytes. Ensure the size is sufficient for the intended data storage to avoid buffer overflow.
Specifies the alignment of the memory block. Alignment must be a power of two to ensure efficient memory access patterns for various processor architectures.
The memory allocator used to manage the allocation. Choose an allocator type that matches the intended use case for the allocated memory, such as Allocator.Temp or Allocator.Persistent.
Specifies the number of call stack frames to skip when tracking memory. Adjust this to refine the granularity of stack traces collected for memory profiling.
Returns
Type | Description |
|---|---|
| void* | A pointer to the allocated memory block. Manage this pointer diligently, ensuring it is freed appropriately to prevent memory leaks and accessing invalid memory. |
Remarks
The method allocates memory while providing options to track memory allocations for debugging and profiling purposes. This function is similar to UnsafeUtility.Malloc, but with additional tracking that helps identify memory allocations that might contribute to memory leaks or inefficiencies in performance-critical applications.
MallocTrackedEnsure that the allocated memory is properly freed with UnsafeUtility.Free when it is no longer required to avoid memory leaks. Balance the parameter value to focus on your debugging needs while minimizing overhead.
callstacksToSkipExamples
using System.Runtime.InteropServices;using Unity.Collections;using Unity.Collections.LowLevel.Unsafe;using UnityEngine;public class MallocTrackedSimplifiedExample : MonoBehaviour{ void Start() { // Enable Native Leak Detection with stack trace for debugging UnsafeUtility.SetLeakDetectionMode(NativeLeakDetectionMode.EnabledWithStackTrace); // Allocate a block of memory for a CustomNativeArray Allocate(10, Allocator.Persistent, out CustomNativeArray<int> array); // NOTE: Not freeing the buffer in this example; this is intentional for demonstration. // During a Domain reload, such as entering/exiting Play Mode, a warning will appear // if memory is not properly freed, aiding in identifying leaks. } [StructLayout(LayoutKind.Sequential)] unsafe struct CustomNativeArray<T> where T : struct { public void* m_Buffer; public int m_Length; public Allocator m_AllocatorLabel; } static void Allocate<T>(int length, Allocator allocator, out CustomNativeArray<T> array) where T : struct { long totalSize = UnsafeUtility.SizeOf<T>() * length; array = default; unsafe { // Allocate memory with leak detection tracking array.m_Buffer = UnsafeUtility.MallocTracked(totalSize, UnsafeUtility.AlignOf<T>(), allocator, 0); } // Set the array metadata array.m_Length = length; array.m_AllocatorLabel = allocator; }}
MallocTracked(long, int, MemoryLabel, int)
Allocates a block of memory with specified size, alignment, memory label and tracking information.
public static void* MallocTracked(long size, int alignment, MemoryLabel label, int callstacksToSkip)
Parameters
The size of the memory block to allocate, in bytes. Ensure the size is sufficient for the intended data storage to avoid buffer overflow.
Specifies the alignment of the memory block. Alignment must be a power of two to ensure efficient memory access patterns for various processor architectures.
The memory label to allocate under.
Specifies the number of call stack frames to skip when tracking memory. Adjust this to refine the granularity of stack traces collected for memory profiling.
Returns
Type | Description |
|---|---|
| void* | A pointer to the allocated memory block. Manage this pointer carefully to prevent memory leaks and ensure proper deallocation. |
Remarks
The method allocates memory while providing options to track memory allocations for debugging and profiling purposes. This function is similar to UnsafeUtility.Malloc, but with additional tracking that helps identify memory allocations that might contribute to memory leaks or inefficiencies in performance-critical applications.
MallocTrackedSpecifying a memory label helps in profiling and debugging memory usage in Unity.
To avoid memory leaks, free the allocated memory with UnsafeUtility.Free when it's no longer required. Balance the parameter value to focus on your debugging needs while minimizing overhead.
callstacksToSkip