PassDescriptor.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) 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_PASSDESCRIPTOR_HPP_
#define DW_FRAMEWORK_PASSDESCRIPTOR_HPP_

#include <dw/core/base/Types.h>
#include <dw/core/container/StringView.hpp>

#include <array>
#include <cstddef>
#include <tuple>
#include <type_traits>
#include <utility>

namespace dw
{
namespace framework
{

template <typename... Args>
constexpr auto describePassCollection(const Args&&... args)
{
    return std::make_tuple(std::forward<const Args>(args)...);
}

// coverity[autosar_cpp14_a0_1_1_violation]
// coverity[autosar_cpp14_m0_1_4_violation]
static constexpr size_t PASS_NAME{0U};
// coverity[autosar_cpp14_a0_1_1_violation]
// coverity[autosar_cpp14_m0_1_4_violation]
static constexpr size_t PASS_PROCESSOR_TYPE{1U};
// coverity[autosar_cpp14_a0_1_1_violation]
// coverity[autosar_cpp14_m0_1_4_violation]
static constexpr size_t PASS_DEPENDENCIES{2U};

constexpr std::tuple<dw::core::StringView, dwProcessorType> describePass(
    dw::core::StringView const&& name, dwProcessorType processorType)
{
    return std::make_tuple(
        // TODO(dwplc): FP -- must use std::move for && parameter
        // coverity[autosar_cpp14_a18_9_3_violation]
        std::move(name),
        std::move(processorType));
}

template <typename DependenciesT>
constexpr auto describePass(
    dw::core::StringView const&& name, dwProcessorType processorType, DependenciesT dependencies) -> std::tuple<dw::core::StringView, dwProcessorType, DependenciesT>
{
    return std::make_tuple(
        std::move(name),
        std::move(processorType),
        std::move(dependencies));
}

template <typename... Args>
constexpr auto describePassDependencies(const Args&&... args) -> std::array<dw::core::StringView, sizeof...(Args)>
{
    return {std::forward<const Args>(args)...};
}

template <typename Node>
constexpr auto describePasses()
{
    return Node::describePasses();
}

template <typename Node>
constexpr std::size_t passSize()
{
    return std::tuple_size<decltype(describePasses<Node>())>::value;
}

template <typename Node>
constexpr bool isValidPass(std::size_t passID)
{
    return passID < passSize<Node>();
}

namespace detail
{

template <
    typename Node, size_t Index,
    typename std::enable_if_t<Index == passSize<Node>(), void>* = nullptr>
constexpr std::size_t passIndex(dw::core::StringView identifier)
{
    (void)identifier;
    return 0;
}

template <
    typename Node, size_t Index,
    typename std::enable_if_t<Index<passSize<Node>(), void>* = nullptr> constexpr std::size_t passIndex(dw::core::StringView identifier)
{
    constexpr auto name = std::get<dw::framework::PASS_NAME>(std::get<Index>(describePasses<Node>()));
    if (name == identifier)
    {
        return 0;
    }
    return 1 + passIndex<Node, Index + 1>(identifier);
}

} // namespace detail

template <typename Node>
constexpr size_t passIndex(dw::core::StringView identifier)
{
    return detail::passIndex<Node, 0>(identifier);
}

template <typename Node>
constexpr bool isValidPass(dw::core::StringView identifier)
{
    constexpr size_t index = passIndex<Node>(identifier);
    return isValidPass<Node>(index);
}

template <typename Node, size_t Index>
constexpr dw::core::StringView passName()
{
    return std::get<dw::framework::PASS_NAME>(std::get<Index>(describePasses<Node>()));
}

template <typename Node, size_t Index>
constexpr dwProcessorType passProcessorType()
{
    return std::get<dw::framework::PASS_PROCESSOR_TYPE>(std::get<Index>(describePasses<Node>()));
}

template <typename Node, size_t Index>
constexpr bool hasPassDependencies()
{
    constexpr auto pass = std::get<Index>(describePasses<Node>());
    return std::tuple_size<decltype(pass)>() > PASS_DEPENDENCIES;
}

template <
    typename Node, size_t Index,
    typename std::enable_if_t<hasPassDependencies<Node, Index>(), void>* = nullptr>
constexpr auto passDependencies()
{
    return std::get<PASS_DEPENDENCIES>(std::get<Index>(describePasses<Node>()));
}

template <
    typename Node, size_t Index,
    typename std::enable_if_t<!hasPassDependencies<Node, Index>(), void>* = nullptr>
constexpr auto passDependencies()
{
    return std::array<dw::core::StringView, 0>();
}

} // namespace framework
} // namespace dw

#endif // DW_FRAMEWORK_PASSDESCRIPTOR_HPP_