ierror.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_IERROR_H
#define NVIDIA_INDEX_IERROR_H
 
#include <mi/base/types.h>
#include <mi/dice.h>
#include <mi/base/interface_declare.h>
 
namespace nv
{
namespace index
{
 
class IError :
    public mi::base::Interface_declare<0x27d2eff4,0xcb29,0x4452,0x84,0x6e,0x4f,0xa7,0x9,0xa3,0x12,0x6c>
{
public:
    virtual mi::base::Uuid  get_error_uuid() const = 0;
 
    virtual const char*     get_error_string() const = 0;
 
    virtual mi::Uint32      get_host_id() const = 0;
 
    virtual mi::Uint32      get_device_id() const = 0;
};
 
class IOut_of_memory_error :
    public mi::base::Interface_declare<0x565cc068,0xd7c9,0x4c3e,0x85,0x38,0x77,0xca,0x44,0x6b,0x23,0x65,
                                       nv::index::IError>
{
public:
    enum Failure_hint
    {
        OOM_FAIL_HINT_NONE                          = 0x00u,    
        OOM_FAIL_INVALID_ALLOC_REQUEST              = 0x01u,    
        OOM_FAIL_FRAGMENTED_MEMORY                  = 0x02u,    
        OOM_FAIL_INSUFFICIENT_DYNAMIC_RESOURCES     = 0x04u     
    };
 
    virtual mi::Size    get_memory_available() const = 0;
 
    virtual mi::Size    get_memory_requested() const = 0;
 
    virtual mi::Uint32  get_failure_hints() const = 0;
};
 
class IHost_out_of_memory_error :
    public mi::base::Interface_declare<0x573349e3,0x5f5c,0x4951,0xab,0x97,0xc3,0xd1,0x13,0xcd,0xe7,0x2c,
                                       nv::index::IOut_of_memory_error>
{
};
 
class IDevice_out_of_memory_error :
    public mi::base::Interface_declare<0x5662d3ad,0x3311,0x49ca,0xb2,0xce,0x9e,0x93,0x67,0xad,0x68,0x86,
                                       nv::index::IOut_of_memory_error>
{
};
 
class IDevice_execution_error :
    public mi::base::Interface_declare<0x9db4beec,0x1d8c,0x4a5f,0x86,0x14,0xd6,0x7c,0x9d,0xa1,0x98,0x5d,
                                       nv::index::IError>
{
};
 
class IRuntime_error :
    public mi::base::Interface_declare<0x6565399f,0x99ea,0x480f,0xb4,0x44,0x49,0xdc,0xc0,0x8f,0x96,0x87,
                                       nv::index::IError>
{
};
 
class IError_set :
    public mi::base::Interface_declare<0x5edf4263,0x4f89,0x42de,0xa3,0xf8,0xae,0x4f,0x1e,0xf0,0x75,0x58>
{
public:
    virtual bool any_errors() const = 0;
 
    virtual mi::Uint32  get_nb_errors() const = 0;
 
    virtual IError* get_error(mi::Uint32 idx) const = 0;
};
 
}} // namespace index / nv
 
#endif // NVIDIA_INDEX_IERROR_H