TheRock/rocm-libraries/projects/rocfft/shared/hip_object_wrapper.h

/******************************************************************************
* Copyright (C) 2023-2026 Advanced Micro Devices, Inc. All rights reserved.
*
* 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 ROCFFT_HIP_OBJ_WRAPPER_H
#define ROCFFT_HIP_OBJ_WRAPPER_H

#include "rocfft_hip.h"
#include <type_traits>

// RAII wrapper around HIP objects (or rocfft objects if TSuccess == rocfft_status_success)
template <typename T, auto TCreate, auto TDestroy, auto TSuccess = hipSuccess>
struct hip_object_wrapper_t
{
    hip_object_wrapper_t()
        : obj(nullptr)
    {
    }

    template <typename... Args>
    void alloc(Args&&... arg)
    {
        free();
        const auto ret = TCreate(&obj, std::forward<Args>(arg)...);
        if(ret != TSuccess)
        {
            if constexpr(std::is_same_v<decltype(TSuccess), hipError_t>)
                throw hip_runtime_error("hip object allocation failure", ret);
            else
                throw std::runtime_error("object allocation failure");
        }
    }

    template <typename... Args>
    auto alloc_with_err(Args&&... arg)
    {
        free();
        return TCreate(&obj, std::forward<Args>(arg)...);
    }

    void free()
    {
        if(obj)
        {
            (void)TDestroy(obj);
            obj = nullptr;
        }
    }

    operator const T&() const
    {
        return obj;
    }
    operator T&()
    {
        return obj;
    }

    operator bool() const
    {
        return obj != nullptr;
    }

    ~hip_object_wrapper_t()
    {
        free();
    }

    hip_object_wrapper_t(const hip_object_wrapper_t&) = delete;
    hip_object_wrapper_t& operator=(const hip_object_wrapper_t&) = delete;
    hip_object_wrapper_t(hip_object_wrapper_t&& other)
        : obj(other.obj)
    {
        other.obj = nullptr;
    }

    hip_object_wrapper_t& operator=(hip_object_wrapper_t&& other)
    {
        std::swap(obj, other.obj);
        return *this;
    }

private:
    T obj;
};

typedef hip_object_wrapper_t<hipStream_t, hipStreamCreate, hipStreamDestroy>  hipStream_wrapper_t;
typedef hip_object_wrapper_t<hipEvent_t, hipEventCreate, hipEventDestroy>     hipEvent_wrapper_t;
typedef hip_object_wrapper_t<hipModule_t, hipModuleLoadData, hipModuleUnload> hipModule_wrapper_t;

#endif // ROCFFT_HIP_OBJ_WRAPPER_H