Name 

Description 

Functions 

The following table lists functions in this documentation. 

Types 

The following table lists types in this documentation. 

Macros 

The following table lists macros in this documentation. 

 

Name 

Description 

 

AllocateEx 

Allocates a block of memory of specific size. Debugging information if passed is recorded on the block. 

 

CloseSpace 

Closes a shared memory region. Calls CloseSpaceEx() with bFinal set TRUE. 

 

CloseSpaceEx 

Closes a memory region. Release can also be used to close opened spaces. 

 

CStrDupEx 

Translates from a TEXTCHAR string to a char string. Probably only for UNICODE to non wide translation points. 

 

CStrLen 

Get the length of a string in C chars. 

 

DebugDumpHeapMemEx 

Dumps all blocks into the log. 

 

DebugDumpHeapMemFile 

Dumps a heap to a specific file. 

 

DebugDumpMemEx 

Dumps all blocks into the log. 

 

DebugDumpMemFile 

Dumps a heap to a specific file. 

 

Defragment 

not so much of a fragment as a consolidation. Finds a free spot earlier in the heap and attempts to move the block there. This can help alleviate heap fragmentation. 

 

DupCharToTextEx 

Translates from a TEXTCHAR string to a wchar_t string. Probably only for UNICODE to non wide translation points. 

 

DupCStrEx 

Converts from 8 bit char to 16 bit wchar (or no-op if not UNICODE compiled) 

 

DupTextToCharEx 

Translates from a TEXTCHAR string to a wchar_t string. Probably only for UNICODE to non wide translation points. 

 

DupTextToWideEx 

Translates from a TEXTCHAR string to a wchar_t string. Probably only for UNICODE to non wide translation points. 

 

DupWideToTextEx 

Translates from a TEXTCHAR string to a wchar_t string. Probably only for UNICODE to non wide translation points. 

 

GetFirstUsedBlock 

MEM_PROC POINTER MEM_API AllocateEx ( PTRSZVAL nSize DBG_PASS ); #define Allocate(n) AllocateEx(n DBG_SRC ) 

 

GetHeapMemStatsEx 

 

 

GetMemStats 

MEM_PROC void MEM_API GetHeapMemStats ( PMEM pHeap, _32 *pFree, _32 *pUsed, _32 *pChunks, _32 *pFreeChunks ); 

 

GetSpaceSize 

This can give the size back of a memory space. 

 

HeapAllocateEx 

 

 

HeapMoveEx 

Moves a block of memory from one heap to another. 

 

HeapPreallocateEx 

This can be used to add additional space before the beginning of a memory block. 

 

HeapReallocateEx 

This can be used to add additional space after the end of a memory block. 

 

HoldEx 

Adds a usage count to a block of memory. For each count added, an additional release must be used. This can be used to keep a copy of the block, even if some other code automatically releases it. 

 

InitHeap 

even if pMem is just a POINTER returned from OpenSpace this will create a valid heap pointer.
will result TRUE if a valid heap is present will result FALSE if heap is not able to init (has content) 

 

LockedDecrement 

Does a multi-processor safe decrement on a variable. 

 

LockedExchange 

Multiprocessor safe swap of the contents of a variable with a new value, and result with the old variable. 

 

LockedExchange64 

multi-processor safe exchange the value in a 64 bit variable with another value. 

 

LockedExchange64 

Multi-processor safe exchange operation. Returns the prior value at the pointer. 

 

LockedIncrement 

A multi-processor safe increment of a variable. 

 

MemCmp 

#define _memcpy_ MemCpy Binary byte comparison of one block of memory to another. Results -1 if less, 1 if more and 0 if equal. 

 

MemCpy 

#define _memset_ MemSet memory copy operation. not safe when buffers overlap. Performs platform-native memory stream operation to copy from one place in memory to another. (32 or 64 bit operations as possible). 

 

MemDupEx 

This duplicates a block of memory. 

 

MemSet 

Sets a 32 bit value into memory. If the length to set is not a whole number of 32 bit words, the last bytes may contain the low 16 bits of the value and the low 8 bits. 

 

OpenSpace 

 

 

OpenSpaceExx 

Open a shared memory region. The region may be named with a text string (this does not work under linux platforms, and the name of the file to back the shared region is the sharing point). The region may be backed with a file (and must be if it is to be shared on linux.
If the region exists by name, the region is opened, and a pointer to that region is returned.
If the file exists, the file is opened, and mapped into memory, and a pointer to the file backed memory is returned.
if the file does... more 

 

PreallocateEx 

 

 

ReallocateEx 

 

 

ReleaseEx 

Releases an allocated block. Memory becomes free to allocate again. If debugging information is passed, the releasing source and line is recorded in the block. (can be used to find code deallocating memory it shouldn't).
This also works with Hold(), and decrements the hold counter. If there are no more holds on the block, then the block is released. 

 

SetAllocateDebug 

disables storing file/line, also disables auto GetMemStats checking 

 

SetAllocateLogging 

Sets whether to log allocations or not.
returns the prior state of logging... 

 

SetCriticalLogging 

Sets whether to log critical sections or not.
returns the prior state of logging... 

 

SetHeapUnit 

Sets how much a heap is expanded by when it is out of space. Default is like 512k. 

 

SetManualAllocateCheck 

disables auto GemMemStats on every allocate/release/Hold
GetMemStats will evaluate each and every block allocated in memory and inspect it for corruption. 

 

SetMinAllocate 

Sets the minimum size to allocate. If a block size less than this is allocated, then this much is actually allocated. 

 

SizeOfMemBlock 

returns the size of a memory block which was Allocate()'d. 

 

StrCaseCmp 

Compares two strings, case insensitively. 

 

StrCaseCmpEx 

String insensitive case comparison with maximum length specified. 

 

StrCaseStr 

Searches for one string in another. Compares case insensitively. 

 

StrChr 

This searches a string for the first character that matches some specified character.
A custom strchr function, since microsoft is saying this is an unsafe function. This Compiles to compare native strings, if UNICODE uses unicode, otherwise uses 8 bit characters. 

 

StrChr 

This searches a string for the first character that matches some specified character.
A custom strchr function, since microsoft is saying this is an unsafe function. This Compiles to compare native strings, if UNICODE uses unicode, otherwise uses 8 bit characters. 

 

StrCmp 

Compares two strings. Must match exactly. 

 

StrCmp 

Compares two strings. Must match exactly. 

 

StrCmpEx 

 

 

StrCpy 

copy S2 to S1. This is 'unsafe', since neither paramter's size is known. Prefer StrCpyEx which passes the maximum length for S1. 

 

StrCpyEx 

copy S2 to S1, with a maximum of N characters.
The last byte of S1 will always be a 'nul'. If S2 was longer than S1, then it will be truncated to fit within S1. Perferred method over this is SaveText or StrDup. 

 

StrDupEx 

Duplicates a string, and returns a pointer to the copy. 

 

StrLen 

Returns the count of characters in a string. 

 

StrRChr 

Finds the last instance of a character in a string. 

 

StrRChr 

This searches a string for the last character that matches some specified character.
A custom strrchr function, since microsoft is saying this is an unsafe function. This Compiles to compare native strings, if UNICODE uses unicode, otherwise uses 8 bit characters. 

 

StrStr 

Finds an instance of a string in another string.
Custom implementation because strstr is declared unsafe, and to handle switching between unicode and char. 

 

StrStr 

Finds an instance of a string in another string.
Custom implementation because strstr is declared unsafe, and to handle switching between unicode and char. 

Name 

Description 

Allocate 

Allocates a block of memory of specific size. Debugging information if passed is recorded on the block. 

CStrDup 

Translates from a TEXTCHAR string to a char string. Probably only for UNICODE to non wide translation points. 

Deallocate 

A 'safe' release macro. casts the block to the type to release. Makes sure the pointer being released is the type specified. 

DebugDumpHeapMem 

Dumps all blocks into the log. 

DebugDumpMem 

Dumps all tracked heaps. 

DupCharToText 

This is macro sack::memory::DupCharToText. 

DupCStr 

Converts from 8 bit char to 16 bit wchar (or no-op if not UNICODE compiled) 

DupTextToChar 

This is macro sack::memory::DupTextToChar. 

DupTextToWide 

This is macro sack::memory::DupTextToWide. 

DupWideToText 

This is macro sack::memory::DupWideToText. 

GetHeapMemStats 

 

HeapAllocate 

 

HeapMove 

Moves a block of memory from one heap to another. 

HeapPreallocate 

This can be used to add additional space before the beginning of a memory block. 

HeapReallocate 

This can be used to add additional space after the end of a memory block. 

Hold 

Adds a usage count to a block of memory. For each count added, an additional release must be used. This can be used to keep a copy of the block, even if some other code automatically releases it. 

LockedExchangePtrSzVal 

like also __if_assembly__ extern "C" { 

MemDup 

This duplicates a block of memory. 

New 

A simple macro to allocate a new single unit of a structure. Adds a typecast automatically to be (type*) so C++ compilation is clean. Does not burden the user with extra typecasts. This, being in definition use means that all other things that are typecast are potentially error prone. Memory is considered uninitialized. 

NewArray 

Allocate a new array of type. 

NewObject 

Allocate sizeof(type). Will invoke some sort of registered initializer 

NewPlus 

an advantage of C, can define extra space at end of structure which is allowed to carry extra data, which is unknown by other code room for exploits rock. 

OpenSpaceEx 

Open a shared memory region. The region may be named with a text string (this does not work under linux platforms, and the name of the file to back the shared region is the sharing point). The region may be backed with a file (and must be if it is to be shared on linux.
If the region exists by name, the region is opened, and a pointer to that region is returned.
If the file exists, the file is opened, and mapped into memory, and a pointer to the file backed memory is returned.
if the file does... more 

Preallocate 

 

Reallocate 

 

Release 

Releases an allocated block. Memory becomes free to allocate again. If debugging information is passed, the releasing source and line is recorded in the block. (can be used to find code deallocating memory it shouldn't).
This also works with Hold(), and decrements the hold counter. If there are no more holds on the block, then the block is released. 

Renew 

Reallocates an array of type. 

StrDup 

Duplicates a string, and returns a pointer to the copy. 

Name 

Description 

PMEM 

This is type sack::memory::PMEM.