TABLE OF CONTENTS

1. Public/Memory Management
2. Public: Memory Management/cl_free
3. Public: Memory Management/cl_malloc
4. Public: Memory Management/cl_mem_display
5. Public: Memory Management/cl_memclr
6. Public: Memory Management/cl_memcmp
7. Public: Memory Management/cl_memcpy
8. Public: Memory Management/cl_memset
9. Public: Memory Management/cl_zalloc

Public/Memory Management

    Memory Management

    The memory management functionality provides memory manipulation
    functions as well as powerful debugging tools.

    The Allocation Tracking functionality provides a means for tracking memory 
    allocations in order to detect memory leaks.

    Memory allocation tracking stores the file name and line number where 
    allocations occur. Gathering this information does have an adverse impact 
    on performance, and memory tracking should therefore not be enabled in 
    release builds of software.

    Memory tracking is compiled into the debug version of the library, 
    and can be enabled for the release version as well. To Enable memory 
    tracking in a release build of the public layer, users should define 
    the MEM_TRACK_ON keyword for compilation.

Public: Memory Management/cl_free

    cl_free

    The cl_free function deallocates a block of memory.

void
cl_free( 
    IN  void* const p_memory );

    p_memory 
        [in] Pointer to a memory block.

    This function does not return a value.

    The p_memory parameter is the pointer returned by a previous call to
    cl_malloc, or cl_zalloc.

    cl_free has no effect if p_memory is NULL.

    Memory Management, cl_alloc, cl_zalloc

Public: Memory Management/cl_malloc

    cl_malloc

    The cl_malloc function allocates a block of memory.

void*
cl_malloc( 
    IN  const size_t    size );

    size
        [in] Size of the requested allocation.

    Pointer to allocated memory if successful.

    NULL otherwise.

    Allocated memory follows alignment rules specific to the different 
    environments.

    Memory Management, cl_free, cl_zalloc, cl_memset, cl_memclr, cl_memcpy, cl_memcmp

Public: Memory Management/cl_mem_display

    cl_mem_display

    The cl_mem_display function displays all tracked memory allocations to 
    the applicable debugger.

void
cl_mem_display( void );

    This function does not return a value.

    Each tracked memory allocation is displayed along with the file name and 
    line number that allocated it.

    Output is sent to the platform's debugging target, which may be the
    system log file.

    Memory Management

Public: Memory Management/cl_memclr

    cl_memclr

    The cl_memclr function sets every byte in a memory range to zero.

 void
cl_memclr( 
    IN  void* const     p_memory, 
    IN  const size_t    count ;

    p_memory 
        [in] Pointer to a memory block.

    count
        [in] Number of bytes to set.

    This function does not return a value.

    Memory Management, cl_memset, cl_memcpy, cl_memcmp

Public: Memory Management/cl_memcmp

    cl_memcmp

    The cl_memcmp function compares two memory buffers.

int32_t
cl_memcmp( 
    IN  const void* const   p_mem,
    IN  const void* const   p_ref,
    IN  const size_t        count );

    p_mem 
        [in] Pointer to a memory block being compared.

    p_ref
        [in] Pointer to the reference memory block to compare against.

    count
        [in] Number of bytes to compare. 

    Returns less than zero if p_mem is less than p_ref.

    Returns greater than zero if p_mem is greater than p_ref.

    Returns zero if the two memory regions are the identical.

    Memory Management, cl_memset, cl_memclr, cl_memcpy

Public: Memory Management/cl_memcpy

    cl_memcpy

    The cl_memcpy function copies a given number of bytes from 
    one buffer to another.

void*
cl_memcpy( 
    IN  void* const         p_dest, 
    IN  const void* const   p_src, 
    IN  const size_t        count );

    p_dest 
        [in] Pointer to the buffer being copied to. 

    p_src 
        [in] Pointer to the buffer being copied from. 

    count
        [in] Number of bytes to copy from the source buffer to the 
        destination buffer. 

    This function does not return a value.

    Memory Management, cl_memset, cl_memclr, cl_memcmp

Public: Memory Management/cl_memset

    cl_memset

    The cl_memset function sets every byte in a memory range to a given value.

void
cl_memset( 
    IN  void* const     p_memory, 
    IN  const uint8_t   fill,
    IN  const size_t    count );

    p_memory 
        [in] Pointer to a memory block.

    fill 
        [in] Byte value with which to fill the memory. 

    count
        [in] Number of bytes to set.

    This function does not return a value.

    Memory Management, cl_memclr, cl_memcpy, cl_memcmp

Public: Memory Management/cl_zalloc

    cl_zalloc

    The cl_zalloc function allocates a block of memory initialized to zero.

void*
cl_zalloc( 
    IN  const size_t    size );

    size
        [in] Size of the requested allocation.

    Pointer to allocated memory if successful.

    NULL otherwise.

    Allocated memory follows alignment rules specific to the different 
    environments.

    Memory Management, cl_free, cl_malloc, cl_memset, cl_memclr, cl_memcpy, cl_memcmp