gpu_pointer_attributes.hpp

Go to the documentation of this file.

/*
  Copyright 2025 Equinor ASA
  This file is part of the Open Porous Media project (OPM).
  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef OPM_SIMULATORS_LINALG_GPUISTL_DETAIL_GPU_POINTER_ATTRIBUTES_HPP
#define OPM_SIMULATORS_LINALG_GPUISTL_DETAIL_GPU_POINTER_ATTRIBUTES_HPP
 
#include <opm/simulators/linalg/gpuistl/detail/gpu_safe_call.hpp>
 
#include <opm/common/ErrorMacros.hpp>
 
#include <cuda.h>
#include <cuda_runtime.h>
 
#include <format>
#include <memory>
#include <source_location>
#include <stdexcept>
#include <string_view>
 
namespace Opm::gpuistl::detail
{
 
template <class T>
inline bool
isGPUPointer(const T* ptr)
{
    if (ptr == nullptr) {
        return false;
    }
    cudaPointerAttributes attributes {};
    OPM_GPU_SAFE_CALL(cudaPointerGetAttributes(&attributes, ptr));
 
    return attributes.type == cudaMemoryTypeDevice;
}
 
 
template <class T, class D>
inline bool
isGPUPointer(const std::unique_ptr<T, D>& ptr)
{
    return isGPUPointer(ptr.get());
}
 
template <class T>
inline bool
isGPUPointer(const std::shared_ptr<T>& ptr)
{
    return isGPUPointer(ptr.get());
}
 
 
// Check if the pointer is a CPU pointer -----------------------------------------
 
template <class T>
inline bool
isCPUPointer(const T* ptr)
{
    if (ptr == nullptr) {
        return false;
    }
 
    cudaPointerAttributes attributes {};
    OPM_GPU_SAFE_CALL(cudaPointerGetAttributes(&attributes, ptr));
 
    // Enumerator value 0 == Unregistered on CUDA 11+ / modern HIP.
    // Do not name cudaMemoryTypeUnregistered: hipify-perl will not translate it.
    const auto pointerTypeUnregistered = static_cast<cudaMemoryType>(0);
    return attributes.type == cudaMemoryTypeHost || attributes.type == pointerTypeUnregistered;
}
 
 
template <class T, class D>
inline bool
isCPUPointer(const std::unique_ptr<T, D>& ptr)
{
    return isCPUPointer(ptr.get());
}
 
template <class T>
inline bool
isCPUPointer(const std::shared_ptr<T>& ptr)
{
    return isCPUPointer(ptr.get());
}
 
inline void
assertHostPointer([[maybe_unused]] const void* ptr,
                  [[maybe_unused]] std::string_view name,
                  [[maybe_unused]] const std::source_location location
                  = std::source_location::current())
{
#ifndef NDEBUG
    if (!isCPUPointer(ptr)) {
        OPM_THROW(std::invalid_argument,
                  std::format("{} is not a CPU pointer\n"
                              "  file: {}\n"
                              "  line: {}\n"
                              "  column: {}\n"
                              "  function: {}",
                              name,
                              location.file_name(),
                              location.line(),
                              location.column(),
                              location.function_name()));
    }
#endif
}
 
inline void
assertDevicePointer([[maybe_unused]] const void* ptr,
                    [[maybe_unused]] std::string_view name,
                    [[maybe_unused]] const std::source_location location
                    = std::source_location::current())
{
#ifndef NDEBUG
    if (!isGPUPointer(ptr)) {
        OPM_THROW(std::invalid_argument,
                  std::format("{} is not a device/GPU pointer\n"
                              "  file: {}\n"
                              "  line: {}\n"
                              "  column: {}\n"
                              "  function: {}",
                              name,
                              location.file_name(),
                              location.line(),
                              location.column(),
                              location.function_name()));
    }
#endif
}
 
} // namespace Opm::gpuistl::detail
 
#define OPM_GPUISTL_DETAIL_ASSERT_HOST_POINTER(x) ::Opm::gpuistl::detail::assertHostPointer((x), #x)
 
#define OPM_GPUISTL_DETAIL_ASSERT_DEVICE_POINTER(x)                                                \
    ::Opm::gpuistl::detail::assertDevicePointer((x), #x)
 
#endif