Pass.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) 2018-2023 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_PASS_HPP_
#define DW_FRAMEWORK_PASS_HPP_
 
#include <dwcgf/Exception.hpp>
#include <dwcgf/channel/Channel.hpp>
#include <dwshared/dwfoundation/dw/core/container/StringView.hpp>
#include <dwshared/dwfoundation/dw/core/container/HashContainer.hpp>
 
namespace dw
{
namespace framework
{
 
class Node;
 
class Pass
{
public:
    // coverity[autosar_cpp14_a0_1_1_violation] FP: nvbugs/2813925
    // coverity[autosar_cpp14_a5_1_1_violation]
    // coverity[autosar_cpp14_m0_1_4_violation] RFD Pending: TID-2055
    static constexpr const size_t MAX_NAME_LEN{256U};
 
    virtual ~Pass() = default;
    Pass(Pass const&) = delete;
    Pass(Pass&&) = delete;
    Pass& operator=(Pass const&) & = delete;
    Pass& operator=(Pass&&) & = delete;
 
    virtual dwStatus run() = 0;
 
    virtual void setRunnableId(dw::core::StringView const& runnableId) = 0;
    virtual dw::core::FixedString<MAX_NAME_LEN> const& getRunnableId(bool isSubmitPass) const = 0;
    dw::core::HeapHashMap<dwStatus, uint32_t> const& getPassReturnErrorMap() { return m_passReturnErrorMapping; }
 
    virtual Node& getNode() const = 0;
 
    dwProcessorType m_processor;
 
    cudaStream_t m_cudaStream;
 
    bool m_isFirstIteration;
 
protected:
    Pass(dwProcessorType const processor,
         std::initializer_list<std::pair<dwStatus, uint32_t>> const& returnMapping = {});
 
private:
    dw::core::HeapHashMap<dwStatus, uint32_t> m_passReturnErrorMapping;
};
 
template <typename PassFunctionT>
class PassImpl : public Pass
{
    static_assert(std::is_convertible<PassFunctionT, std::function<dwStatus()>>::value, "PassFunctionT must be callable without arguments and return dwStatus");
 
public:
    PassImpl(Node& node,
             PassFunctionT const passFunc,
             dwProcessorType const processor,
             std::initializer_list<std::pair<dwStatus, uint32_t>> const& returnMapping = {})
        : Pass(processor, returnMapping)
        , m_node(node)
        , m_functionInt(passFunc)
    {
    }
 
    PassImpl(Node& node,
             PassFunctionT const passFunc,
             dwProcessorType const processor,
             cudaStream_t const cudaStream,
             std::initializer_list<std::pair<dwStatus, uint32_t>> const& returnMapping = {})
        : Pass(processor, returnMapping)
        , m_node(node)
        , m_functionInt(passFunc)
    {
        if (processor == DW_PROCESSOR_TYPE_GPU)
        {
            m_cudaStream = cudaStream;
        }
        else
        {
            throw ExceptionWithStatus(DW_NOT_SUPPORTED, "PassImpl: Only GPU passes can use a cuda stream");
        }
    }
 
    dwStatus run() final
    {
        // TODO(DRIV-7184) - return code of the function shall not be ignored
        return ExceptionGuard::guard([&] {
            m_functionInt();
        },
                                     dw::core::Logger::Verbosity::WARN);
    }
 
    void setRunnableId(dw::core::StringView const& runnableId) final
    {
        // coverity[autosar_cpp14_a5_1_1_violation]
        if (runnableId.size() >= 128U - 10U - 1U)
        {
            throw ExceptionWithStatus(DW_BUFFER_FULL, "setRunnableId() runnable id exceeds capacity: ", runnableId);
        }
        m_runnableId       = dw::core::FixedString<128>(runnableId.data(), runnableId.size());
        m_runnableIdSubmit = dw::core::FixedString<128>(runnableId.data(), runnableId.size());
        // coverity[autosar_cpp14_a5_1_1_violation]
        m_runnableIdSubmit += "_submittee";
    }
 
    dw::core::FixedString<MAX_NAME_LEN> const& getRunnableId(bool isSubmitPass) const final
    {
        if (isSubmitPass)
        {
            return m_runnableIdSubmit;
        }
        return m_runnableId;
    }
 
    Node& getNode() const final
    {
        return m_node;
    }
 
private:
    Node& m_node;
    PassFunctionT m_functionInt;
    dw::core::FixedString<MAX_NAME_LEN> m_runnableId;
    dw::core::FixedString<MAX_NAME_LEN> m_runnableIdSubmit;
};
 
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_PASS_HPP_