Program Listing for File Requirements.hpp

↰ Return to documentation for file (nvcv_types/include/nvcv/alloc/Requirements.hpp)

/*
 * SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef NVCV_REQUIREMENTS_HPP
#define NVCV_REQUIREMENTS_HPP

#include "../detail/CheckError.hpp"
#include "Requirements.h"

namespace nvcv {

class Requirements final
{
public:
    class ConstMemory
    {
        friend class Requirements;
        ConstMemory(const NVCVMemRequirements &reqs);

    protected:
        const NVCVMemRequirements &m_reqs;

    public:
        static constexpr int size();
        int64_t              numBlocks(int log2BlockSizeBytes) const;

        const NVCVMemRequirements &cdata() const;
    };

    class Memory : public ConstMemory
    {
        friend class Requirements;
        Memory(NVCVMemRequirements &reqs);

    public:
        void addBuffer(int64_t bufSize, int64_t bufAlignment);

        using ConstMemory::cdata;
        NVCVMemRequirements &cdata();
    };

    Requirements();
    explicit Requirements(NVCVRequirements reqs);

    ConstMemory cudaMem() const;
    Memory      cudaMem();

    ConstMemory hostMem() const;
    Memory      hostMem();

    ConstMemory hostPinnedMem() const;
    Memory      hostPinnedMem();

    NVCVRequirements       &cdata();
    const NVCVRequirements &cdata() const;

    Requirements &operator+=(const Requirements &that);
    Requirements  operator+(const Requirements &that) const;

private:
    NVCVRequirements m_reqs;
};

int64_t CalcTotalSizeBytes(const Requirements::ConstMemory &mem);

// Implementation

inline Requirements::ConstMemory::ConstMemory(const NVCVMemRequirements &reqs)
    : m_reqs(reqs)
{
}

inline constexpr int Requirements::ConstMemory::size()
{
    return NVCV_MAX_MEM_REQUIREMENTS_LOG2_BLOCK_SIZE;
}

inline const NVCVMemRequirements &Requirements::ConstMemory::cdata() const
{
    return m_reqs;
}

inline int64_t CalcTotalSizeBytes(const Requirements::ConstMemory &mem)
{
    int64_t sizeBytes;
    detail::CheckThrow(nvcvMemRequirementsCalcTotalSizeBytes(&mem.cdata(), &sizeBytes));
    return sizeBytes;
}

inline int64_t Requirements::ConstMemory::numBlocks(int log2BlockSizeBytes) const
{
    if (log2BlockSizeBytes < 0 || log2BlockSizeBytes >= this->size())
    {
        throw Exception(Status::ERROR_INVALID_ARGUMENT, "log2 of block size is out of valid range");
    }
    return this->cdata().numBlocks[log2BlockSizeBytes];
}

inline Requirements::Memory::Memory(NVCVMemRequirements &reqs)
    : ConstMemory(reqs)
{
}

inline NVCVMemRequirements &Requirements::Memory::cdata()
{
    return const_cast<NVCVMemRequirements &>(m_reqs);
}

inline void Requirements::Memory::addBuffer(int64_t bufSize, int64_t bufAlign)
{
    detail::CheckThrow(nvcvMemRequirementsAddBuffer(&this->cdata(), bufSize, bufAlign));
}

inline Requirements::Requirements()
{
    detail::CheckThrow(nvcvRequirementsInit(&m_reqs));
}

inline Requirements::Requirements(NVCVRequirements reqs)
    : m_reqs(std::move(reqs))
{
}

inline auto Requirements::cudaMem() const -> ConstMemory
{
    return ConstMemory{m_reqs.cudaMem};
}

inline auto Requirements::cudaMem() -> Memory
{
    return Memory{m_reqs.cudaMem};
}

inline auto Requirements::hostMem() const -> ConstMemory
{
    return ConstMemory{m_reqs.hostMem};
}

inline auto Requirements::hostMem() -> Memory
{
    return Memory{m_reqs.hostMem};
}

inline auto Requirements::hostPinnedMem() const -> ConstMemory
{
    return ConstMemory{m_reqs.hostPinnedMem};
}

inline auto Requirements::hostPinnedMem() -> Memory
{
    return Memory{m_reqs.hostPinnedMem};
}

inline NVCVRequirements &Requirements::cdata()
{
    return m_reqs;
}

inline const NVCVRequirements &Requirements::cdata() const
{
    return m_reqs;
}

inline Requirements &Requirements::operator+=(const Requirements &that)
{
    detail::CheckThrow(nvcvRequirementsAdd(&m_reqs, &that.cdata()));
    return *this;
}

inline Requirements Requirements::operator+(const Requirements &that) const
{
    return Requirements{*this} += that;
}

} // namespace nvcv

#endif // NVCV_REQUIREMENTS_HPP