gpu_safe_call.hpp

/*
  Copyright 2022-2023 SINTEF AS

  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_GPU_SAFE_CALL_HPP
#define OPM_GPU_SAFE_CALL_HPP
#include <cuda_runtime.h>
#if CUDA_VERSION >= 12100
#include <fmt/core.h>
#else
#include <sstream>
#endif
#include <opm/common/ErrorMacros.hpp>
#include <opm/common/OpmLog/OpmLog.hpp>
#include <string_view>

namespace Opm::gpuistl::detail
{
inline std::string
getCudaErrorMessage(cudaError_t error,
                    const std::string_view& expression,
                    const std::string_view& filename,
                    const std::string_view& functionName,
                    size_t lineNumber)
{
#if CUDA_VERSION >= 12100
    return fmt::format(fmt::runtime("GPU expression did not execute correctly. Expression was: \n"
                       "    {}\n"
                       "GPU error was {}\n"
                       "in function {}, in {}, at line {}\n"),
                       expression,
                       cudaGetErrorString(error),
                       functionName,
                       filename,
                       lineNumber);
#else
    std::stringstream str;
    str << "GPU expression did not execute correctly. Expression was: \n"
        << "    " << expression
        << "\nGPU error was " << cudaGetErrorString(error)
        << "\nin function " << functionName << ", in " << filename
        << ", at line " << lineNumber << '\n';
    return str.str();
#endif
}

inline void
cudaSafeCall(cudaError_t error,
             const std::string_view& expression,
             const std::string_view& filename,
             const std::string_view& functionName,
             size_t lineNumber)
{
    if (error != cudaSuccess) {
        OPM_THROW(std::runtime_error, getCudaErrorMessage(error, expression, filename, functionName, lineNumber));
    }
}

inline void
cudaWarnIfError(cudaError_t error,
                const std::string_view& expression,
                const std::string_view& filename,
                const std::string_view& functionName,
                size_t lineNumber)
{
    if (error != cudaSuccess) {
        OpmLog::warning(getCudaErrorMessage(error, expression, filename, functionName, lineNumber));
    }
}
} // namespace Opm::gpuistl::detail

#define OPM_GPU_SAFE_CALL(expression)                                                                                 \
    ::Opm::gpuistl::detail::cudaSafeCall(expression, #expression, __FILE__, __func__, __LINE__)


#define OPM_GPU_WARN_IF_ERROR(expression)                                                                             \
    ::Opm::gpuistl::detail::cudaWarnIfError(expression, #expression, __FILE__, __func__, __LINE__)

#endif