ScopedMemoryAllocation.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
 
#ifndef NVNEURAL_SCOPEDMEMORYALLOCATION_H
#define NVNEURAL_SCOPEDMEMORYALLOCATION_H
 
namespace nvneural {
 
    class ScopedMemoryAllocation
    {
    public:
        ScopedMemoryAllocation(INetworkBackend* pBackend, size_t bufferSize)
            : m_pBackend{pBackend}
            , m_hBuffer{nullptr}
        {
            const NeuralResult status = pBackend->allocateMemoryBlock(&m_hBuffer, bufferSize);
            if (failed(status))
            {
                m_hBuffer = nullptr;
            }
        }
 
        ScopedMemoryAllocation(INetworkBackend* pBackend, size_t bufferSize, const char* pTrackingKey)
            : m_pBackend{pBackend}
            , m_hBuffer{nullptr}
        {
            NeuralResult status;
            RefPtr<INetworkBackend2> pBackend2 = RefPtr<INetworkBackend>::fromPointer(pBackend).as<INetworkBackend2>();
            if (pBackend2)
            {
                status = pBackend2->allocateMemoryBlock(&m_hBuffer, bufferSize, pTrackingKey);
            }
            else
            {
                status = pBackend->allocateMemoryBlock(&m_hBuffer, bufferSize);
            }
            if (failed(status))
            {
                m_hBuffer = nullptr;
            }
        }
 
        ScopedMemoryAllocation(const ScopedMemoryAllocation& copyFrom) = delete;
 
        explicit ScopedMemoryAllocation(ScopedMemoryAllocation&& moveFrom)
            : m_pBackend{moveFrom.m_pBackend}
            , m_hBuffer{moveFrom.m_hBuffer}
        {
        }
 
        ~ScopedMemoryAllocation()
        {
            if (m_hBuffer)
            {
                m_pBackend->freeMemoryBlock(m_hBuffer);
            }
        }
 
        ScopedMemoryAllocation& operator=(const ScopedMemoryAllocation& copyFrom) = delete;
 
        ScopedMemoryAllocation& operator=(ScopedMemoryAllocation&& moveFrom)
        {
            std::swap(m_pBackend, moveFrom.m_pBackend);
            std::swap(m_hBuffer, moveFrom.m_hBuffer);
            return *this;
        }
 
        explicit operator bool() const
        {
            return nullptr != m_hBuffer;
        }
 
        MemoryHandle handle() const
        {
            return m_hBuffer;
        }
 
        void* asPointer()
        {
            return m_pBackend->getAddressForMemoryBlock(m_hBuffer);
        }
 
    private:
        INetworkBackend* m_pBackend;
        MemoryHandle m_hBuffer;
    };
 
} // namespace nvneural
 
#endif // NVNEURAL_SCOPEDMEMORYALLOCATION_H