diff options
| author |  vnugent <public@vaughnnugent.com> | 2023-01-18 22:43:14 -0500 |
|---|---|---|
| committer | vnugent <public@vaughnnugent.com> | 2023-01-18 22:43:14 -0500 |
| commit | 46caaac9debdaad496c07af9d3806e67a447066c (patch) | |
| tree | 750bebaa5f3b59f06792b99de8a6fae995452bca /lib/Utils/README.md | |
| parent | 52b8e30437e235817ed534dec860e781bb0468c0 (diff) | |
Heap diag and plugin log file names
Diffstat (limited to 'lib/Utils/README.md')
| -rw-r--r-- | lib/Utils/README.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/Utils/README.md b/lib/Utils/README.md index 683cc3c..a3be003 100644 --- a/lib/Utils/README.md +++ b/lib/Utils/README.md @@ -26,6 +26,9 @@ Valid allocator value for the `VNLIB_SHARED_HEAP_TYPE` environment variable: - "rpmalloc" - to load the RPMalloc native library if compiled for your platform - none - the default value, will attempt to load the win32 private heap Kernel32 library, otherwise, the native ProcessHeap() cross platform allocator +#### Heap Diagnostics +The Memory.Diagnostics namespace was added to provide a wrapper for tracking IUnmanagedHeap memory allocations. Diagnostics can be enabled for the SharedHeap by setting the `VNLIB_SHARED_HEAP_DIAGNOSTICS` environment variable to "1". When enabled, calling MemoryUtil.GetSharedHeapStats() will return the heap's current statistics, otherwise an empty struct is returned. The SharedHeap diagnostics are disabled by default. + ## Usage A usage breakdown would be far to lengthy for this library, and instead I intend to keep valid and comprehensive documentation in Visual Studio XML documentation files included in this project's src directory. |