NvInferSafeRuntime.h

Go to the documentation of this file.

/*
 * Copyright (c) 1993-2022, NVIDIA CORPORATION. All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */
 
#ifndef NV_INFER_SAFE_RUNTIME_H
#define NV_INFER_SAFE_RUNTIME_H
 
#include "NvInferRuntimeCommon.h"
#include <cstddef>
#include <cstdint>
 
 
namespace nvinfer1
{
namespace safe
{
class ICudaEngine;
class IExecutionContext;
 
class IRuntime
{
public:
    virtual ICudaEngine* deserializeCudaEngine(void const* const blob, std::size_t const size) noexcept = 0;
 
    virtual void setGpuAllocator(IGpuAllocator* const allocator) noexcept = 0;
 
    //
    virtual void setErrorRecorder(IErrorRecorder* const recorder) noexcept = 0;
 
    virtual IErrorRecorder* getErrorRecorder() const noexcept = 0;
 
    IRuntime() = default;
    virtual ~IRuntime() noexcept = default;
    IRuntime(IRuntime const&) = delete;
    IRuntime(IRuntime&&) = delete;
    IRuntime& operator=(IRuntime const&) & = delete;
    IRuntime& operator=(IRuntime&&) & = delete;
};
 
class ICudaEngine
{
public:
    virtual std::int32_t getNbBindings() const noexcept = 0;
 
    virtual std::int32_t getBindingIndex(AsciiChar const* const name) const noexcept = 0;
 
    virtual AsciiChar const* getBindingName(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual bool bindingIsInput(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual Dims getBindingDimensions(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual DataType getBindingDataType(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual IExecutionContext* createExecutionContext() noexcept = 0;
 
    virtual IExecutionContext* createExecutionContextWithoutDeviceMemory() noexcept = 0;
 
    virtual size_t getDeviceMemorySize() const noexcept = 0;
 
    virtual std::int32_t getBindingBytesPerComponent(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual std::int32_t getBindingComponentsPerElement(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual TensorFormat getBindingFormat(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual std::int32_t getBindingVectorizedDim(std::int32_t const bindingIndex) const noexcept = 0;
 
    virtual AsciiChar const* getName() const noexcept = 0;
 
    //
    virtual void setErrorRecorder(IErrorRecorder* const recorder) noexcept = 0;
 
    virtual IErrorRecorder* getErrorRecorder() const noexcept = 0;
 
    ICudaEngine() = default;
    virtual ~ICudaEngine() noexcept = default;
    ICudaEngine(ICudaEngine const&) = delete;
    ICudaEngine(ICudaEngine&&) = delete;
    ICudaEngine& operator=(ICudaEngine const&) & = delete;
    ICudaEngine& operator=(ICudaEngine&&) & = delete;
};
 
struct FloatingPointErrorInformation
{
    int32_t nbNanErrors;
    int32_t nbInfErrors;
};
 
class IExecutionContext
{
public:
    virtual const ICudaEngine& getEngine() const noexcept = 0;
 
    virtual void setName(AsciiChar const* const name) noexcept = 0;
 
    virtual AsciiChar const* getName() const noexcept = 0;
 
    virtual void setDeviceMemory(void* const memory) noexcept = 0;
 
    virtual Dims getStrides(std::int32_t const bindingIndex) const noexcept = 0;
 
    //
    virtual void setErrorRecorder(IErrorRecorder* const recorder) noexcept = 0;
 
    virtual IErrorRecorder* getErrorRecorder() const noexcept = 0;
 
    virtual bool enqueueV2(
        void* const* const bindings, cudaStream_t const stream, cudaEvent_t* const inputConsumed) noexcept
        = 0;
 
    IExecutionContext() = default;
    virtual ~IExecutionContext() noexcept = default;
    IExecutionContext(IExecutionContext const&) = delete;
    IExecutionContext(IExecutionContext&&) = delete;
    IExecutionContext& operator=(IExecutionContext const&) & = delete;
    IExecutionContext& operator=(IExecutionContext&&) & = delete;
 
    virtual void setErrorBuffer(FloatingPointErrorInformation* const buffer) noexcept = 0;
 
    virtual FloatingPointErrorInformation* getErrorBuffer() const noexcept = 0;
};
 
IRuntime* createInferRuntime(ILogger& logger) noexcept;
 
extern "C" TENSORRTAPI nvinfer1::IPluginRegistry* getSafePluginRegistry() noexcept;
 
template <typename T>
class PluginRegistrar
{
public:
    PluginRegistrar()
    {
        getSafePluginRegistry()->registerCreator(instance, "");
    }
 
private:
    T instance{};
};
 
} // namespace safe
 
} // namespace nvinfer1
 
#define REGISTER_SAFE_TENSORRT_PLUGIN(name)                                                                            \
    static nvinfer1::safe::PluginRegistrar<name> pluginRegistrar##name {}
#endif // NV_INFER_SAFE_RUNTIME_H