DynamicMemory.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_CORE_DYNAMIC_MEMORY_H__
#define DW_CORE_DYNAMIC_MEMORY_H__

#include <dw/core/Config.h>
#include <dw/core/Exports.h>
#include <dw/core/Status.h>

#include <stdio.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif


typedef void* (*dwDynamicMemoryMallocCallback)(size_t sizeInByte, void* userData);
typedef void (*dwDynamicMemoryFreeCallback) (void* addr, void* userData);

DW_API_PUBLIC dwStatus dwDynamicMemory_initialize(dwDynamicMemoryMallocCallback mallocCallback, 
                                                  dwDynamicMemoryFreeCallback freeCallback, 
                                                  void* userData);

DW_API_PUBLIC dwStatus dwDynamicMemory_getCallbacks(dwDynamicMemoryMallocCallback* mallocCallback, 
                                                    dwDynamicMemoryFreeCallback* freeCallback, 
                                                    void** userData);


typedef enum dwRuntimeMode {
    DW_MODE_INIT      = 0x0000, 
    DW_MODE_RUNTIME   = 0x0001, 
    DW_MODE_CLEANUP   = 0x0002, 
} dwRuntimeMode;


DW_API_PUBLIC
dwStatus dwDynamicMemory_updateRuntimeMode(dwRuntimeMode newMode);

DW_API_PUBLIC dwStatus dwDynamicMemory_release();

DW_API_PUBLIC
void* memcpy_opt(void * __restrict destination, const void * __restrict source, size_t num);

#ifdef __cplusplus
}
#endif

#endif // DW_CORE_DYNAMIC_MEMORY_H__