imemory_allocator.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_IMEMORY_ALLOCATOR_H
#define NVIDIA_INDEX_IMEMORY_ALLOCATOR_H
 
#include <mi/dice.h>
#include <mi/base/interface_declare.h>
 
// CUDA forward declarations required for the interfaces below
struct cudaArray;
struct cudaChannelFormatDesc;
 
namespace nv {
namespace index {
 
class ICuda_memory_allocator;
 
class IMemory_allocator_configuration :
    public mi::base::Interface_declare<0x35cb18dd,0x6523,0x4362,0x92,0xb2,0xda,0xc4,0xb,0x3a,0x91,0xfd>
{
public:
    virtual mi::Sint32                  set_memory_allocator(
                                            ICuda_memory_allocator* alloc) = 0;
 
    virtual ICuda_memory_allocator*     get_memory_allocator() const = 0;
};
 
class ICuda_memory_allocator :
    public mi::base::Interface_declare<0xea832c47,0x6dfa,0x41ba,0xb3,0x1c,0xa3,0xcf,0x4e,0x35,0x53,0x91>
{
public:
    struct Buffer_data {
        mi::Sint32  device_id;      
        void*       data;           
        const void* user_data;      
 
        mi::Size    used_pitch;     
    };
 
    struct Array_data {
        mi::Sint32  device_id;      
        cudaArray*  array;          
        const void* user_data;      
    };
 
public:
    virtual Buffer_data device_alloc(
                            mi::Sint32  device_id,
                            mi::Size    data_size) = 0;
    virtual Buffer_data device_alloc_pitched(
                            mi::Sint32  device_id,
                            mi::Uint32  size_x_in_bytes,
                            mi::Uint32  size_y) = 0;
 
    virtual Array_data  device_alloc_array(
                            mi::Sint32                                     device_id,
                            const mi::math::Vector_struct<mi::Uint32, 3>&  arr_dim,
                            const cudaChannelFormatDesc*                   arr_chdesc,
                            mi::Uint32                                     arr_flags) = 0;
 
    virtual void        device_free(
                            Buffer_data&    buffer_data) = 0;
    virtual void        device_free(
                            Array_data&     array_data) = 0;
};
 
} // namespace index
} // namespace nv
 
#endif // NVIDIA_INDEX_IMEMORY_ALLOCATOR_H