NvInferSafeMemAllocator.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 1993-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
// Header file for the NVIDIA Safe Runtime Memory Allocator interface.
// This file provides the user-implementable interface for the Memory Allocator feature in the NVIDIA Safe Runtime API.
// It includes the necessary classes, functions, and definitions for creating and managing safe memory allocators,
// including the ISafeMemAllocator interface.
// Users should implement this interface to provide a custom memory allocator that will be used by the Safe Runtime
// to allocate memory for both CPU and GPU resources. The allocator should handle memory allocation and deallocation
// requests from the Safe Runtime, and ensure thread safety and proper memory management.
// The implemented allocator will be responsible for allocating memory for various components of the Safe Runtime,
// including tensors, plugins, and other internal data structures.
 
#ifndef NV_INFER_SAFE_MEM_ALLOCATOR_H
#define NV_INFER_SAFE_MEM_ALLOCATOR_H
#include "NvInferSafeRecorder.h"
#include <cstdint>
 
namespace nvinfer2
{
namespace safe
{
class ISafeRecorder;
 
constexpr uint64_t kMAXIMUM_ALLOC_SIZE{17179869184U};
 
enum class MemoryPlacement : uint32_t
{
    kNONE = 0x0,
    kMANAGED = 0x1,
    kGPU = 0x2,
    kCPU = 0x4,
    kCPU_PINNED = 0x80
};
 
enum class MemoryUsage : uint32_t
{
    kGENERIC = 0x0,
    kIMMUTABLE = 0x3,
    kSCRATCH = 0x5,
    kIOTENSOR = 0x6
};
 
class ISafeMemAllocator
{
public:
    virtual void* allocate(uint64_t const size, uint64_t const alignment, MemoryPlacement const flags,
        MemoryUsage const usage, ISafeRecorder& recorder) noexcept = 0;
 
    virtual ~ISafeMemAllocator() = default;
    ISafeMemAllocator() = default;
 
    virtual bool deallocate(void* const memory, MemoryPlacement const flags, ISafeRecorder& recorder) noexcept = 0;
 
protected:
    ISafeMemAllocator(ISafeMemAllocator const&) = default;
    ISafeMemAllocator(ISafeMemAllocator&&) = default;
    ISafeMemAllocator& operator=(ISafeMemAllocator const&) & = default;
    ISafeMemAllocator& operator=(ISafeMemAllocator&&) & = default;
};
} // namespace safe
} // namespace nvinfer2
 
#endif /* NV_INFER_SAFE_MEM_ALLOCATOR_H */