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-2021 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/Types.hpp>
#include <dwcgf/Exception.hpp>
#include <dwcgf/channel/Channel.hpp>
#include <dw/core/container/StringView.hpp>
#include <dw/trace/Trace.hpp>

namespace dw
{
namespace framework
{

class Node;

class Pass
{
public:
    // coverity[autosar_cpp14_a0_1_1_violation]
    // coverity[autosar_cpp14_m0_1_4_violation]
    static constexpr 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;

    virtual Node* getNode() const = 0;

    // coverity[autosar_cpp14_m11_0_1_violation]
    dwProcessorType m_processor;
    // coverity[autosar_cpp14_m11_0_1_violation]
    dwProcessType m_processType;

    // coverity[autosar_cpp14_m11_0_1_violation]
    dwTime_t m_minTime;
    // coverity[autosar_cpp14_m11_0_1_violation]
    dwTime_t m_avgTime;
    // coverity[autosar_cpp14_m11_0_1_violation]
    dwTime_t m_maxTime;

    // coverity[autosar_cpp14_m11_0_1_violation]
    cudaStream_t m_cudaStream;
    // coverity[autosar_cpp14_m11_0_1_violation]
    NvMediaDla* m_dlaEngine;

protected:
    Pass(dwProcessorType const processor,
         dwProcessType const processType,
         dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime) noexcept
        : m_processor(processor)
        , m_processType(processType)
        , m_minTime(minTime)
        , m_avgTime(avgTime)
        , m_maxTime(maxTime)
        , m_cudaStream(DW_NULL_HANDLE)
        , m_dlaEngine(nullptr)
    {
    }
};

template <typename PassFunctionT>
class PassImpl : public Pass
{
public:
    // coverity[autosar_cpp14_a8_4_8_violation]
    PassImpl(Node* node,
             PassFunctionT const passFunc,
             dwProcessorType const processor,
             dwProcessType const processType,
             dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime)
        : Pass(processor, processType, minTime, avgTime, maxTime)
        , m_node(node)
        , m_functionInt(passFunc)
    {
    }

    // coverity[autosar_cpp14_a8_4_8_violation]
    PassImpl(Node* node,
             PassFunctionT const passFunc,
             dwProcessorType const processor,
             dwProcessType const processType,
             dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime,
             cudaStream_t const cudaStream)
        : Pass(processor, processType, minTime, avgTime, maxTime)
        , m_node(node)
        , m_functionInt(passFunc)
    {
        if (processor == DW_PROCESSOR_TYPE_GPU)
        {
            m_cudaStream = cudaStream;
        }
        else
        {
            throw Exception(DW_NOT_SUPPORTED, "PassImpl: Only GPU passes can use a cuda stream");
        }
    }

    // coverity[autosar_cpp14_a8_4_8_violation]
    PassImpl(Node* node,
             PassFunctionT const passFunc,
             dwProcessorType const processor,
             dwProcessType const processType,
             dwTime_t const minTime, dwTime_t const avgTime, dwTime_t const maxTime,
             NvMediaDla* const dlaEngine)
        : Pass(processor, processType, minTime, avgTime, maxTime)
        , m_node(node)
        , m_functionInt(passFunc)
    {
        if (processor == DW_PROCESSOR_TYPE_DLA_0 || processor == DW_PROCESSOR_TYPE_DLA_1)
        {
            m_dlaEngine = dlaEngine;
        }
        else
        {
            throw Exception(DW_NOT_SUPPORTED, "PassImpl: Only DLA passes can use a DLA handle");
        }
    }

    dwStatus run() final
    {
        // TODO(DRIV-7184) - return code of the function shall not be ignored
        return Exception::guard([&] {
            m_functionInt();
        });
    }

    void setRunnableId(dw::core::StringView const& runnableId) final
    {
        if (runnableId.size() >= 128 - 10 - 1)
        {
            throw Exception(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());
        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_