SimpleNode.hpp

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2019-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DW_FRAMEWORK_SIMPLENODE_HPP_
#define DW_FRAMEWORK_SIMPLENODE_HPP_
 
#include <dw/core/base/Types.h>
#include <dwcgf/Exception.hpp>
#include <dwcgf/channel/Channel.hpp>
#include <dwcgf/pass/Pass.hpp>
#include <dwcgf/node/Node.hpp>
#include <dwcgf/pass/PassDescriptor.hpp>
#include <dwcgf/port/ManagedPort.hpp>
#include <dwcgf/port/PortCollectionDescriptor.hpp>
#include <dwcgf/port/PortDescriptor.hpp>
 
#include <dwshared/dwfoundation/dw/core/container/BaseString.hpp>
#include <dwshared/dwfoundation/dw/core/container/HashContainer.hpp>
#include <dwshared/dwfoundation/dw/core/container/VectorFixed.hpp>
#include <dwshared/dwfoundation/dw/core/language/Function.hpp>
 
#include <memory>
 
namespace dw
{
namespace framework
{
 
struct NodeAllocationParams
{
public:
    NodeAllocationParams() = delete;
    NodeAllocationParams(
        size_t maxInputPortCount_,
        size_t maxOutputPortCount_,
        size_t maxPassCount_)
        : maxInputPortCount(maxInputPortCount_)
        , maxOutputPortCount(maxOutputPortCount_)
        , maxPassCount(maxPassCount_)
    {
    }
    size_t maxInputPortCount{};
    size_t maxOutputPortCount{};
    size_t maxPassCount{};
};
 
template <typename NodeT>
// coverity[autosar_cpp14_a2_10_5_violation] FP: nvbugs/3907242
NodeAllocationParams createAllocationParams()
{
    NodeAllocationParams params{
        portSize<NodeT, PortDirection::INPUT>(),
        portSize<NodeT, PortDirection::OUTPUT>(),
        passSize<NodeT>()};
    return params;
}
 
class SimpleNode : public Node
{
public:
    SimpleNode(NodeAllocationParams params);
 
    dwStatus reset() override
    {
        throw ExceptionWithStatus(DW_NOT_IMPLEMENTED, "SimpleNode::reset() not implemented");
    }
 
 
    dwStatus setInputChannel(ChannelObject* channel, size_t portID) override;
 
 
    dwStatus setOutputChannel(ChannelObject* channel, size_t portID) override;
 
    dwStatus getInputChannel(const size_t portID, ChannelObject*& channel) const override;
 
    dwStatus getOutputChannel(const size_t portID, ChannelObject*& channel) const override;
 
    dwStatus validate() override
    {
        throw ExceptionWithStatus(DW_NOT_IMPLEMENTED, "SimpleNode::validate() not implemented");
    }
 
 
    dwStatus validate(const char* direction, const PortCollectionDescriptor& collection, dw::core::Function<bool(size_t)> isPortBound);
 
    dwStatus run() override;
    size_t getPassCount() const noexcept override;
    dwStatus runPass(size_t passIndex) override;
    dwStatus getPass(Pass*& pass, size_t index) override;
    // coverity[autosar_cpp14_a2_10_5_violation]
    dwStatus getPasses(VectorFixed<Pass*>& passList) override;
 
    dwStatus setName(const char* name) override;
    dwStatus getName(const char** name) override;
 
    dwStatus collectErrorSignals(dwGraphErrorSignal*& errorSignal) override;
    dwStatus getModuleErrorSignal(dwErrorSignal& errorSignal) override;
    dwStatus getNodeErrorSignal(dwGraphErrorSignal& errorSignal) override;
    dwStatus collectHealthSignals(dwGraphHealthSignal*& healthSignal) override;
    dwStatus getModuleHealthSignal(dwHealthSignal& healthSignal) override;
    dwStatus getNodeHealthSignal(dwGraphHealthSignal& healthSignal) override;
    dwStatus clearErrorSignal() override;
    dwStatus clearHealthSignal() override;
    dwStatus addToErrorSignal(uint32_t error, dwTime_t timestamp = 0L) final;
    dwStatus addToHealthSignal(uint32_t error, dwTime_t timestamp = 0L) override;
 
    template <typename Func, typename PortList>
    void iteratePorts(PortList& portList, Func func)
    {
        for (auto& elem : portList)
        {
            func(elem);
        }
    }
 
    template <typename Func>
    void iterateManagedInputPorts(Func func)
    {
        iteratePorts(m_inputPorts, [&func, this](decltype(m_inputPorts)::TElement& elem) {
            if (nullptr == elem.second.get())
            {
                const char* nodeName{nullptr};
                static_cast<void>(this->getName(&nodeName));
                throw ExceptionWithStatus(DW_NOT_INITIALIZED, "SimpleNode: input port not initialized, node ", nodeName, ", port id ", elem.first);
            }
            func(*elem.second);
        });
    }
 
    template <typename Func>
    void iterateManagedOutputPorts(Func func)
    {
        iteratePorts(m_outputPorts, [&func, this](decltype(m_outputPorts)::TElement& elem) {
            if (nullptr == elem.second.get())
            {
                const char* nodeName{nullptr};
                static_cast<void>(this->getName(&nodeName));
                throw ExceptionWithStatus(DW_NOT_INITIALIZED, "SimpleNode: output port not initialized, node ", nodeName, ", port id ", elem.first);
            }
            func(*elem.second);
        });
    }
 
    template <typename ModuleHandle_t>
    dwStatus setModuleHandle(ModuleHandle_t handle, dwContextHandle_t context)
    {
        dwModuleHandle_t moduleHandle;
 
        if (DW_NULL_HANDLE == handle)
        {
            return DW_INVALID_ARGUMENT;
        }
 
        dwStatus ret{getModuleHandle(&moduleHandle, handle, context)};
        if (DW_SUCCESS != ret)
        {
            return ret;
        }
 
        return setObjectHandle(moduleHandle);
    }
 
    dwStatus setObjectHandle(dwModuleHandle_t handle);
 
    dwModuleHandle_t getObjectHandle() const;
 
    dwStatus getInputPort(const size_t portID, dw::framework::PortBase*& port) const override;
 
    dwStatus getOutputPort(const size_t portID, dw::framework::PortBase*& port) const override;
 
protected:
    dwStatus getModuleHandle(dwModuleHandle_t* moduleHandle, void* handle, dwContextHandle_t context);
 
 
    template <
        typename NodeT, size_t PassIndex, typename PassFunctionT>
    void registerPass(PassFunctionT func, std::initializer_list<std::pair<dwStatus, uint32_t>> const& returnMapping = {})
    {
        // if the pass index is invalid the compilation will fail on passProcessorType() below
        // no need to check with isValidPass<NodeT>(PassIndex) at runtime
 
        // coverity[autosar_cpp14_a5_1_1_violation] RFD Accepted: TID-2056
        if (0U == m_passList.size() || m_passList.size() - 1U < PassIndex)
        {
            // coverity[autosar_cpp14_a5_1_1_violation] RFD Accepted: TID-2056
            m_passList.resize(PassIndex + 1U);
        }
        // coverity[autosar_cpp14_a5_1_1_violation] FP: nvbugs/3364868
        if (nullptr != m_passList[PassIndex])
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "registerPass called with a pass id which has been added before: ", PassIndex);
        }
        dwProcessorType processorType{passProcessorType<NodeT, PassIndex>()};
        // coverity[autosar_cpp14_a5_1_1_violation] FP: nvbugs/3364868
        m_passList[PassIndex] = std::make_unique<PassImpl<PassFunctionT>>(*this, passName<NodeT, PassIndex>(), func, processorType, returnMapping);
    }
 
 
    template <
        typename NodeT, size_t PassIndex, typename PassFunctionT>
    void registerPass(PassFunctionT func, cudaStream_t const cudaStream, std::initializer_list<std::pair<dwStatus, uint32_t>> const& returnMapping = {})
    {
        static_assert(DW_PROCESSOR_TYPE_GPU == passProcessorType<NodeT, PassIndex>(), "The processor type of a pass with a cuda stream must be GPU");
        registerPass<NodeT, PassIndex>(func, returnMapping);
        // coverity[autosar_cpp14_a5_1_1_violation] FP: nvbugs/3364868
        m_passList[PassIndex]->m_cudaStream = cudaStream;
    }
 
public:
    dwStatus updateHealthSignal(const dwGraphHealthSignal& signal);
 
    dwStatus updateCurrentErrorSignal(dwGraphErrorSignal& signal) override;
 
    dwStatus updateCurrentHealthSignal(dwGraphHealthSignal& signal) override;
 
protected:
    dwGraphHealthSignal& getHealthSignal()
    {
        return m_healthSignal;
    }
 
private:
    VectorFixed<std::unique_ptr<Pass>> m_passList;
    FixedString<MAX_NAME_LEN> m_name;
    bool m_setupTeardownCreated;
 
    dwGraphErrorSignal m_errorSignal;
    dwGraphHealthSignal m_healthSignal;
 
    dwModuleHandle_t m_object;
    uint32_t m_iterationCount{};
    uint32_t m_nodePeriod{};
 
public:
 
    template <typename NodeT, size_t PortIndex, typename... Args>
    void initInputPort(Args&&... args)
    {
        static_assert(PortIndex < portSize<NodeT, PortDirection::INPUT>(), "Invalid port index");
        using DataType = decltype(portType<NodeT, PortDirection::INPUT, PortIndex>());
        std::shared_ptr<ManagedPortInput<DataType>> port{std::make_shared<ManagedPortInput<DataType>>(portName<NodeT, PortDirection::INPUT, PortIndex>(), std::forward<Args>(args)...)};
        if (m_inputPorts.find(PortIndex) != m_inputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Input port with the following id registered multiple times: ", PortIndex);
        }
        m_inputPorts[PortIndex] = port;
    }
 
 
    template <typename NodeT, size_t PortIndex, typename... Args>
    void initInputArrayPorts(Args&&... args)
    {
        static_assert(PortIndex < portSize<NodeT, PortDirection::INPUT>(), "Invalid port index");
        constexpr size_t arraySize{descriptorPortSize<NodeT, PortDirection::INPUT, descriptorIndex<NodeT, PortDirection::INPUT, PortIndex>()>()};
        for (size_t i{0U}; i < arraySize; ++i)
        {
            initInputArrayPort<NodeT, PortIndex>(i, std::forward<Args>(args)...);
        }
    }
 
 
    template <typename NodeT, size_t PortIndex, typename... Args>
    void initInputArrayPort(size_t arrayIndex, Args&&... args)
    {
        static_assert(PortIndex < portSize<NodeT, PortDirection::INPUT>(), "Invalid port index");
        using DataType = decltype(portType<NodeT, PortDirection::INPUT, PortIndex>());
        if (arrayIndex >= descriptorPortSize<NodeT, PortDirection::INPUT, descriptorIndex<NodeT, PortDirection::INPUT, PortIndex>()>())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Invalid array index ", arrayIndex, " for array input port ", PortIndex);
        }
        std::shared_ptr<ManagedPortInput<DataType>> port{std::make_shared<ManagedPortInput<DataType>>(portName<NodeT, PortDirection::INPUT, PortIndex>(arrayIndex), std::forward<Args>(args)...)};
        if (m_inputPorts.find(PortIndex + arrayIndex) != m_inputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Input port with the following id registered multiple times: ", PortIndex + arrayIndex);
        }
        m_inputPorts[PortIndex + arrayIndex] = port;
    }
 
 
    template <typename NodeT, size_t PortIndex, typename... Args>
    void initOutputPort(Args&&... args)
    {
        static_assert(PortIndex - portSize<NodeT, PortDirection::INPUT>() < portSize<NodeT, PortDirection::OUTPUT>(), "Invalid port index");
        using DataType = decltype(portType<NodeT, PortDirection::OUTPUT, PortIndex>());
        std::shared_ptr<ManagedPortOutput<DataType>> port{std::make_shared<ManagedPortOutput<DataType>>(portName<NodeT, PortDirection::OUTPUT, PortIndex>(), std::forward<Args>(args)...)};
        if (m_outputPorts.find(PortIndex) != m_outputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Output port with the following id registered multiple times: ", PortIndex);
        }
        m_outputPorts[PortIndex] = port;
    }
 
 
    template <typename NodeT, size_t PortIndex, typename... Args>
    void initOutputArrayPorts(Args&&... args)
    {
        static_assert(PortIndex - portSize<NodeT, PortDirection::INPUT>() < portSize<NodeT, PortDirection::OUTPUT>(), "Invalid port index");
        constexpr size_t arraySize{descriptorPortSize<NodeT, PortDirection::OUTPUT, descriptorIndex<NodeT, PortDirection::OUTPUT, PortIndex>()>()};
        for (size_t i{0U}; i < arraySize; ++i)
        {
            initOutputArrayPort<NodeT, PortIndex>(i, std::forward<Args>(args)...);
        }
    }
 
 
    template <typename NodeT, size_t PortIndex, typename... Args>
    void initOutputArrayPort(size_t arrayIndex, Args&&... args)
    {
        static_assert(PortIndex - portSize<NodeT, PortDirection::INPUT>() < portSize<NodeT, PortDirection::OUTPUT>(), "Invalid port index");
        using DataType = decltype(portType<NodeT, PortDirection::OUTPUT, PortIndex>());
        if (arrayIndex >= descriptorPortSize<NodeT, PortDirection::OUTPUT, descriptorIndex<NodeT, PortDirection::OUTPUT, PortIndex>()>())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Invalid array index ", arrayIndex, " for array output port ", PortIndex);
        }
        std::shared_ptr<ManagedPortOutput<DataType>> port{std::make_shared<ManagedPortOutput<DataType>>(portName<NodeT, PortDirection::OUTPUT, PortIndex>(arrayIndex), std::forward<Args>(args)...)};
        if (m_outputPorts.find(PortIndex + arrayIndex) != m_outputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Output port with the following id registered multiple times: ", PortIndex + arrayIndex);
        }
        m_outputPorts[PortIndex + arrayIndex] = port;
    }
 
    template <typename NodeT, size_t PortIndex>
    ManagedPortInput<decltype(portType<NodeT, PortDirection::INPUT, PortIndex>())>& getInputPort()
    {
        static_assert(PortIndex < portSize<NodeT, PortDirection::INPUT>(), "Invalid port index");
        constexpr bool isArray{descriptorPortArray<NodeT, PortDirection::INPUT, descriptorIndex<NodeT, PortDirection::INPUT, PortIndex>()>()};
        static_assert(!isArray, "Input port is an array, must pass an array index");
        if (m_inputPorts.find(PortIndex) == m_inputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Input port with the following id not registered: ", PortIndex);
        }
        ManagedPortInputBase* portBase{m_inputPorts[PortIndex].get()};
        using DataType    = decltype(portType<NodeT, PortDirection::INPUT, PortIndex>());
        using PointerType = ManagedPortInput<DataType>*;
        // LCOV_EXCL_START the type is ensured by the template parameter and the exception in the defensive code can't be triggered
        // coverity[autosar_cpp14_m5_2_3_violation]
        PointerType port{dynamic_cast<PointerType>(portBase)};
        if (!port)
        {
            throw ExceptionWithStatus(DW_BAD_CAST, "Failed to cast the following input port to its declared type: ", PortIndex);
        }
        // LCOV_EXCL_STOP
        return *port;
    }
 
    template <typename NodeT, size_t PortIndex>
    ManagedPortInput<decltype(portType<NodeT, PortDirection::INPUT, PortIndex>())>& getInputPort(size_t arrayIndex)
    {
        static_assert(PortIndex < portSize<NodeT, PortDirection::INPUT>(), "Invalid port index");
        constexpr bool isArray{descriptorPortArray<NodeT, PortDirection::INPUT, descriptorIndex<NodeT, PortDirection::INPUT, PortIndex>()>()};
        static_assert(isArray, "Input port is not an array, must not pass an array index");
        constexpr size_t arraySize{descriptorPortSize<NodeT, PortDirection::INPUT, descriptorIndex<NodeT, PortDirection::INPUT, PortIndex>()>()};
        if (arrayIndex >= arraySize)
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "The array index is out of bound: ", arrayIndex);
        }
        if (m_inputPorts.find(PortIndex + arrayIndex) == m_inputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Input port with the following id not registered: ", PortIndex + arrayIndex);
        }
        ManagedPortInputBase* portBase{m_inputPorts[PortIndex + arrayIndex].get()};
        using DataType    = decltype(portType<NodeT, PortDirection::INPUT, PortIndex>());
        using PointerType = ManagedPortInput<DataType>*;
        // LCOV_EXCL_START the type is ensured by the template parameter and the exception in the defensive code can't be triggered
        // coverity[autosar_cpp14_m5_2_3_violation]
        PointerType port{dynamic_cast<PointerType>(portBase)};
        if (!port)
        {
            throw ExceptionWithStatus(DW_BAD_CAST, "Failed to cast the following input port to its declared type: ", PortIndex + arrayIndex);
        }
        // LCOV_EXCL_STOP
        return *port;
    }
 
    template <typename NodeT, size_t PortIndex>
    ManagedPortOutput<decltype(portType<NodeT, PortDirection::OUTPUT, PortIndex>())>& getOutputPort()
    {
        static_assert(PortIndex - portSize<NodeT, PortDirection::INPUT>() < portSize<NodeT, PortDirection::OUTPUT>(), "Invalid port index");
        constexpr bool isArray{descriptorPortArray<NodeT, PortDirection::OUTPUT, descriptorIndex<NodeT, PortDirection::OUTPUT, PortIndex>()>()};
        static_assert(!isArray, "Output port is an array, must pass an array index");
        if (m_outputPorts.find(PortIndex) == m_outputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Output port with the following id not registered: ", PortIndex);
        }
        ManagedPortOutputBase* portBase{m_outputPorts[PortIndex].get()};
        using DataType    = decltype(portType<NodeT, PortDirection::OUTPUT, PortIndex>());
        using PointerType = ManagedPortOutput<DataType>*;
        // LCOV_EXCL_START the type is ensured by the template parameter and the exception in the defensive code can't be triggered
        // coverity[autosar_cpp14_m5_2_3_violation]
        PointerType port{dynamic_cast<PointerType>(portBase)};
        if (!port)
        {
            throw ExceptionWithStatus(DW_BAD_CAST, "Failed to cast the following output port to its declared type: ", PortIndex);
        }
        // LCOV_EXCL_STOP
        return *port;
    }
 
    template <typename NodeT, size_t PortIndex>
    ManagedPortOutput<decltype(portType<NodeT, PortDirection::OUTPUT, PortIndex>())>& getOutputPort(size_t arrayIndex)
    {
        static_assert(PortIndex - portSize<NodeT, PortDirection::INPUT>() < portSize<NodeT, PortDirection::OUTPUT>(), "Invalid port index");
        constexpr bool isArray{descriptorPortArray<NodeT, PortDirection::OUTPUT, descriptorIndex<NodeT, PortDirection::OUTPUT, PortIndex>()>()};
        static_assert(isArray, "Output port is not an array, must not pass an array index");
        constexpr size_t arraySize{descriptorPortSize<NodeT, PortDirection::OUTPUT, descriptorIndex<NodeT, PortDirection::OUTPUT, PortIndex>()>()};
        if (arrayIndex >= arraySize)
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "The array index is out of bound: ", arrayIndex);
        }
        if (m_outputPorts.find(PortIndex + arrayIndex) == m_outputPorts.end())
        {
            throw ExceptionWithStatus(DW_INVALID_ARGUMENT, "Output port with the following id not registered: ", PortIndex + arrayIndex);
        }
        ManagedPortOutputBase* portBase{m_outputPorts[PortIndex + arrayIndex].get()};
        using DataType    = decltype(portType<NodeT, PortDirection::OUTPUT, PortIndex>());
        using PointerType = ManagedPortOutput<DataType>*;
        // LCOV_EXCL_START the type is ensured by the template parameter and the exception in the defensive code can't be triggered
        // coverity[autosar_cpp14_m5_2_3_violation]
        PointerType port{dynamic_cast<PointerType>(portBase)};
        if (!port)
        {
            throw ExceptionWithStatus(DW_BAD_CAST, "Failed to cast the following output port to its declared type: ", PortIndex + arrayIndex);
        }
        // LCOV_EXCL_STOP
        return *port;
    }
 
 
    dwStatus setup();
 
 
    dwStatus teardown();
 
 
    void resetPorts() override;
 
    dwStatus setIterationCount(uint32_t iterationCount) override;
 
    dwStatus setNodePeriod(uint32_t period) override;
 
    const dw::core::HeapHashMap<size_t, std::shared_ptr<ManagedPortInputBase>>& getRegisteredInputPorts() const
    {
        return m_inputPorts;
    }
 
    const dw::core::HeapHashMap<size_t, std::shared_ptr<ManagedPortOutputBase>>& getRegisteredOutputPorts() const
    {
        return m_outputPorts;
    }
 
    uint32_t getIterationCount() const;
    uint32_t getNodePeriod() const;
    dwStatus setState(const char* state) override
    {
        static_cast<void>(state);
        return DW_SUCCESS;
    }
 
protected:
    dw::core::HeapHashMap<size_t, std::shared_ptr<ManagedPortInputBase>> m_inputPorts;
    dw::core::HeapHashMap<size_t, std::shared_ptr<ManagedPortOutputBase>> m_outputPorts;
 
    std::atomic<bool> m_asyncResetFlag;
};
 
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_SIMPLENODE_HPP_