DynamicMemory.h

Go to the documentation of this file.

//
// 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 & AFFILIATES 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 & AFFILIATES. 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 & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//

#ifndef DW_CORE_DYNAMIC_MEMORY_H_
#define DW_CORE_DYNAMIC_MEMORY_H_

#include <stddef.h>
#include <stdbool.h>

#ifdef DW_EXPORTS
#define DWALLOC_API_PUBLIC __attribute__((visibility("default")))
#else
#define DWALLOC_API_PUBLIC
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef enum dwDynamicMemoryError {
    DW_DYNAMIC_MEMORY_SUCCESS = 0,       
    DW_DYNAMIC_MEMORY_BAD_ALLOC,         
    DW_DYNAMIC_MEMORY_ALLOC_NOT_ALLOWED, 
    DW_DYNAMIC_MEMORY_FREE_NOT_ALLOWED   
} dwDynamicMemoryError;

typedef void* (*dwDynamicMemoryMallocCallback)(size_t sizeInByte, void* userData);
typedef void (*dwDynamicMemoryFreeCallback)(void* addr, void* userData);
typedef void (*dwDynamicMemoryErrorCallback)(dwDynamicMemoryError error, size_t lastRequestedSizeInByte, void* userData);

DWALLOC_API_PUBLIC
void dwDynamicMemory_initialize(dwDynamicMemoryMallocCallback mallocCallback,
                                dwDynamicMemoryFreeCallback freeCallback,
                                void* const userData);

DWALLOC_API_PUBLIC
void dwDynamicMemory_setErrorCallback(dwDynamicMemoryErrorCallback errorCallback, void* const userData);

DWALLOC_API_PUBLIC
void dwDynamicMemory_getCallbacks(dwDynamicMemoryMallocCallback* const mallocCallback,
                                  dwDynamicMemoryFreeCallback* const freeCallback,
                                  void** const userData);

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

DWALLOC_API_PUBLIC
bool dwDynamicMemory_setRuntimeMode(dwRuntimeMode const newMode);

DWALLOC_API_PUBLIC
bool dwDynamicMemory_getRuntimeMode(dwRuntimeMode* const mode);

DWALLOC_API_PUBLIC
void dwDynamicMemory_release();

DWALLOC_API_PUBLIC
void* dwDynamicMemory_malloc(size_t const size);

DWALLOC_API_PUBLIC
void dwDynamicMemory_free(void* const ptr);

#ifdef __cplusplus
}
#endif

#endif // DW_CORE_DYNAMIC_MEMORY_H_