| 1 |
//===----------------------------------------------------------------------===// |
| 2 |
// |
| 3 |
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 |
// See https://llvm.org/LICENSE.txt for license information. |
| 5 |
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 |
// |
| 7 |
//===----------------------------------------------------------------------===// |
| 8 |
/// |
| 9 |
/// \file |
| 10 |
/// This file contains the definition of wrappers that manage device resources |
| 11 |
/// like buffers, binaries, and kernels. |
| 12 |
/// |
| 13 |
//===----------------------------------------------------------------------===// |
| 14 |
|
| 15 |
#ifndef MATHTEST_DEVICERESOURCES_HPP |
| 16 |
#define MATHTEST_DEVICERESOURCES_HPP |
| 17 |
|
| 18 |
#include "mathtest/OffloadForward.hpp" |
| 19 |
|
| 20 |
#include "llvm/ADT/ArrayRef.h" |
| 21 |
|
| 22 |
#include <cstddef> |
| 23 |
#include <memory> |
| 24 |
#include <utility> |
| 25 |
|
| 26 |
namespace mathtest { |
| 27 |
|
| 28 |
class DeviceContext; |
| 29 |
|
| 30 |
namespace detail { |
| 31 |
|
| 32 |
void freeDeviceMemory(void *Address) noexcept; |
| 33 |
} // namespace detail |
| 34 |
|
| 35 |
//===----------------------------------------------------------------------===// |
| 36 |
// ManagedBuffer |
| 37 |
//===----------------------------------------------------------------------===// |
| 38 |
|
| 39 |
template <typename T> class [[nodiscard]] ManagedBuffer { |
| 40 |
public: |
| 41 |
~ManagedBuffer() noexcept { |
| 42 |
if (Address) |
| 43 |
detail::freeDeviceMemory(Address); |
| 44 |
} |
| 45 |
|
| 46 |
ManagedBuffer(const ManagedBuffer &) = delete; |
| 47 |
ManagedBuffer &operator=(const ManagedBuffer &) = delete; |
| 48 |
|
| 49 |
ManagedBuffer(ManagedBuffer &&Other) noexcept |
| 50 |
: Address(Other.Address), Size(Other.Size) { |
| 51 |
Other.Address = nullptr; |
| 52 |
Other.Size = 0; |
| 53 |
} |
| 54 |
|
| 55 |
ManagedBuffer &operator=(ManagedBuffer &&Other) noexcept { |
| 56 |
if (this == &Other) |
| 57 |
return *this; |
| 58 |
|
| 59 |
if (Address) |
| 60 |
detail::freeDeviceMemory(Address); |
| 61 |
|
| 62 |
Address = Other.Address; |
| 63 |
Size = Other.Size; |
| 64 |
|
| 65 |
Other.Address = nullptr; |
| 66 |
Other.Size = 0; |
| 67 |
|
| 68 |
return *this; |
| 69 |
} |
| 70 |
|
| 71 |
[[nodiscard]] T *data() noexcept { return Address; } |
| 72 |
|
| 73 |
[[nodiscard]] const T *data() const noexcept { return Address; } |
| 74 |
|
| 75 |
[[nodiscard]] std::size_t getSize() const noexcept { return Size; } |
| 76 |
|
| 77 |
[[nodiscard]] operator llvm::MutableArrayRef<T>() noexcept { |
| 78 |
return llvm::MutableArrayRef<T>(data(), getSize()); |
| 79 |
} |
| 80 |
|
| 81 |
[[nodiscard]] operator llvm::ArrayRef<T>() const noexcept { |
| 82 |
return llvm::ArrayRef<T>(data(), getSize()); |
| 83 |
} |
| 84 |
|
| 85 |
private: |
| 86 |
friend class DeviceContext; |
| 87 |
|
| 88 |
explicit ManagedBuffer(T *Address, std::size_t Size) noexcept |
| 89 |
: Address(Address), Size(Size) {} |
| 90 |
|
| 91 |
T *Address = nullptr; |
| 92 |
std::size_t Size = 0; |
| 93 |
}; |
| 94 |
|
| 95 |
//===----------------------------------------------------------------------===// |
| 96 |
// DeviceImage |
| 97 |
//===----------------------------------------------------------------------===// |
| 98 |
|
| 99 |
class [[nodiscard]] DeviceImage { |
| 100 |
public: |
| 101 |
~DeviceImage() noexcept; |
| 102 |
DeviceImage &operator=(DeviceImage &&Other) noexcept; |
| 103 |
|
| 104 |
DeviceImage(const DeviceImage &) = delete; |
| 105 |
DeviceImage &operator=(const DeviceImage &) = delete; |
| 106 |
|
| 107 |
DeviceImage(DeviceImage &&Other) noexcept; |
| 108 |
|
| 109 |
private: |
| 110 |
friend class DeviceContext; |
| 111 |
|
| 112 |
explicit DeviceImage(ol_device_handle_t DeviceHandle, |
| 113 |
ol_program_handle_t Handle) noexcept; |
| 114 |
|
| 115 |
ol_device_handle_t DeviceHandle = nullptr; |
| 116 |
ol_program_handle_t Handle = nullptr; |
| 117 |
}; |
| 118 |
|
| 119 |
//===----------------------------------------------------------------------===// |
| 120 |
// DeviceKernel |
| 121 |
//===----------------------------------------------------------------------===// |
| 122 |
|
| 123 |
template <typename KernelSignature> class [[nodiscard]] DeviceKernel { |
| 124 |
public: |
| 125 |
DeviceKernel() = delete; |
| 126 |
|
| 127 |
DeviceKernel(const DeviceKernel &) = default; |
| 128 |
DeviceKernel &operator=(const DeviceKernel &) = default; |
| 129 |
DeviceKernel(DeviceKernel &&) noexcept = default; |
| 130 |
DeviceKernel &operator=(DeviceKernel &&) noexcept = default; |
| 131 |
|
| 132 |
private: |
| 133 |
friend class DeviceContext; |
| 134 |
|
| 135 |
explicit DeviceKernel(std::shared_ptr<DeviceImage> Image, |
| 136 |
ol_symbol_handle_t Kernel) |
| 137 |
: Image(std::move(Image)), Handle(Kernel) {} |
| 138 |
|
| 139 |
std::shared_ptr<DeviceImage> Image; |
| 140 |
ol_symbol_handle_t Handle = nullptr; |
| 141 |
}; |
| 142 |
} // namespace mathtest |
| 143 |
|
| 144 |
#endif // MATHTEST_DEVICERESOURCES_HPP |