CodeGenTypes.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
 
#ifndef NVNEURAL_CODEGENTYPES_H
#define NVNEURAL_CODEGENTYPES_H
 
#include <nvneural/CoreTypes.h>
 
namespace nvneural {
 
class IResourceDictionary : public IRefObject
{
public:
    using ResourceId = std::uint32_t;
 
    static const IRefObject::TypeId typeID = 0xf8aa3818beae88d2ul;
 
    virtual NeuralResult getResource(ResourceId resourceId, const void** ppBufferOut, std::size_t* pBufferSizeOut) const noexcept = 0;
};
 
class IResourceAggregator : public IRefObject
{
public:
    using ResourceId = IResourceDictionary::ResourceId;
 
    virtual NeuralResult addResource(ResourceId* pResourceIdOut, const void* pBuffer, std::uint32_t bufferBytes) noexcept = 0;
 
    virtual NeuralResult finalize() noexcept = 0;
 
    virtual std::size_t resourceIdCount() const noexcept = 0;
 
    virtual ResourceId resourceIdByIndex(std::size_t resourceIndex) const noexcept = 0;
 
    virtual std::size_t resourceBufferSizeByIndex(std::size_t resourceIndex) const noexcept = 0;
 
    virtual const void* resourceBufferByIndex(std::size_t resourceIndex) const noexcept = 0;
};
 
class ICppCodeGenerationLayerHost : public IRefObject
{
public:
    static const IRefObject::TypeId typeID = 0x1025680db910cfebul;
 
 
    virtual bool deploymentMode() const noexcept = 0;
 
    virtual const IStringList* targetGpuArchitectures() const noexcept = 0;
 
    virtual const char* networkVariableName() const noexcept = 0;
 
    virtual const char* layerVariableName() const noexcept = 0;
 
    virtual const char* resourceDictionaryVariableName() const noexcept = 0;
 
    virtual const char* inputArgumentExpression() const noexcept = 0;
 
 
 
    virtual NeuralResult setObjectClass(const char* pObjectClass) noexcept = 0;
 
    virtual NeuralResult addInclude(const char* pInclude) noexcept = 0;
 
    virtual NeuralResult addSourceFragment(const char* pCppCode) noexcept = 0;
 
    virtual NeuralResult addHeaderFragment(const char* pCppCode) noexcept = 0;
 
    virtual NeuralResult setInitializationFragment(const char* pCppCode) noexcept = 0;
 
    virtual NeuralResult addResource(IResourceDictionary::ResourceId* pResourceIdOut, const void* pBuffer, std::uint32_t bufferBytes) noexcept = 0;
 
    virtual NeuralResult setInputFragment(const char* pCppCode) noexcept = 0;
 
};
 
class ICppCodeGenerationLayer : public IRefObject
{
public:
    static const IRefObject::TypeId typeID = 0xbf8778dfca10c9d5ul;
 
    virtual NeuralResult generateLayerCpp(ICppCodeGenerationLayerHost* pHost) noexcept = 0;
 
    virtual NeuralResult networkGenerationComplete() noexcept = 0;
};
 
} // namespace nvneural
 
#endif // NVNEURAL_CODEGENTYPES_H