mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
Added cublasWarnIfError/CUBLAS_WARN_IF_ERROR.
This commit is contained in:
Kjetil Olsen Lye
parent
e4c0ce08dc
commit
cab0efeec5
@ -30,7 +30,7 @@ CuBlasHandle::CuBlasHandle()
|
||||
|
||||
CuBlasHandle::~CuBlasHandle()
|
||||
{
|
||||
OPM_CUBLAS_SAFE_CALL(cublasDestroy(m_handle));
|
||||
OPM_CUBLAS_WARN_IF_ERROR(cublasDestroy(m_handle));
|
||||
}
|
||||
|
||||
cublasHandle_t
|
||||
|
||||
@ -22,6 +22,7 @@
|
||||
#include <exception>
|
||||
#include <fmt/core.h>
|
||||
#include <opm/common/ErrorMacros.hpp>
|
||||
#include <opm/common/OpmLog/OpmLog.hpp>
|
||||
#include <string_view>
|
||||
|
||||
|
||||
@ -35,33 +36,76 @@ namespace Opm::cuistl::detail
|
||||
return #x; \
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief getCublasErrorMessage Converts an error code returned from a cublas function a human readable string.
|
||||
* @param code an error code from a cublas routine
|
||||
* @return a human readable string.
|
||||
*/
|
||||
inline std::string
|
||||
getCublasErrorMessage(int code)
|
||||
namespace
|
||||
{
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_SUCCESS);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_NOT_INITIALIZED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_ALLOC_FAILED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_INVALID_VALUE);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_ARCH_MISMATCH);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_MAPPING_ERROR);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_EXECUTION_FAILED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_INTERNAL_ERROR);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_NOT_SUPPORTED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_LICENSE_ERROR);
|
||||
/**
|
||||
* @brief getCublasErrorMessage Converts an error code returned from a cublas function a human readable string.
|
||||
* @param code an error code from a cublas routine
|
||||
* @return a human readable string.
|
||||
*/
|
||||
inline std::string getCublasErrorCodeToString(int code)
|
||||
{
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_SUCCESS);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_NOT_INITIALIZED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_ALLOC_FAILED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_INVALID_VALUE);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_ARCH_MISMATCH);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_MAPPING_ERROR);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_EXECUTION_FAILED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_INTERNAL_ERROR);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_NOT_SUPPORTED);
|
||||
CHECK_CUBLAS_ERROR_TYPE(code, CUBLAS_STATUS_LICENSE_ERROR);
|
||||
|
||||
return fmt::format("UNKNOWN CUBLAS ERROR {}.", code);
|
||||
}
|
||||
return fmt::format("UNKNOWN CUBLAS ERROR {}.", code);
|
||||
}
|
||||
|
||||
#undef CHECK_CUBLAS_ERROR_TYPE
|
||||
|
||||
} // namespace
|
||||
|
||||
/**
|
||||
* @brief getCublasErrorMessage generates the error message to display for a given error.
|
||||
*
|
||||
* @param error the error code from cublas
|
||||
* @param expression the expresison (say "cublasCreate(&handle)")
|
||||
* @param filename the code file the error occured in (typically __FILE__)
|
||||
* @param functionName name of the function the error occured in (typically __func__)
|
||||
* @param lineNumber the line number the error occured in (typically __LINE__)
|
||||
*
|
||||
* @todo Refactor to use std::source_location once we shift to C++20
|
||||
*
|
||||
* @return An error message to be displayed.
|
||||
*
|
||||
* @note This function is mostly for internal use.
|
||||
*/
|
||||
inline std::string
|
||||
getCublasErrorMessage(cublasStatus_t error,
|
||||
const std::string_view& expression,
|
||||
const std::string_view& filename,
|
||||
const std::string_view& functionName,
|
||||
size_t lineNumber)
|
||||
{
|
||||
return fmt::format("cuBLAS expression did not execute correctly. Expression was: \n\n"
|
||||
" {}\n\n"
|
||||
"in function {}, in {}, at line {}.\n"
|
||||
"CuBLAS error code was: {}\n",
|
||||
expression,
|
||||
functionName,
|
||||
filename,
|
||||
lineNumber,
|
||||
getCublasErrorCodeToString(error));
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief cublasSafeCall checks the return type of the CUBLAS expression (function call) and throws an exception if it
|
||||
* does not equal CUBLAS_STATUS_SUCCESS.
|
||||
*
|
||||
* @param error the error code from cublas
|
||||
* @param expression the expresison (say "cublasCreate(&handle)")
|
||||
* @param filename the code file the error occured in (typically __FILE__)
|
||||
* @param functionName name of the function the error occured in (typically __func__)
|
||||
* @param lineNumber the line number the error occured in (typically __LINE__)
|
||||
*
|
||||
* Example usage:
|
||||
* @code{.cpp}
|
||||
* #include <opm/simulators/linalg/cuistl/detail/cublas_safe_call.hpp>
|
||||
@ -85,18 +129,51 @@ cublasSafeCall(cublasStatus_t error,
|
||||
size_t lineNumber)
|
||||
{
|
||||
if (error != CUBLAS_STATUS_SUCCESS) {
|
||||
OPM_THROW(std::runtime_error,
|
||||
fmt::format("cuBLAS expression did not execute correctly. Expression was: \n\n"
|
||||
" {}\n\n"
|
||||
"in function {}, in {}, at line {}.\n"
|
||||
"CuBLAS error code was: {}\n",
|
||||
expression,
|
||||
functionName,
|
||||
filename,
|
||||
lineNumber,
|
||||
getCublasErrorMessage(error)));
|
||||
OPM_THROW(std::runtime_error, getCublasErrorMessage(error, expression, filename, functionName, lineNumber));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief cublasWarnIfError checks the return type of the CUBLAS expression (function call) and issues a warning if it
|
||||
* does not equal CUBLAS_STATUS_SUCCESS.
|
||||
*
|
||||
* @param error the error code from cublas
|
||||
* @param expression the expresison (say "cublasCreate(&handle)")
|
||||
* @param filename the code file the error occured in (typically __FILE__)
|
||||
* @param functionName name of the function the error occured in (typically __func__)
|
||||
* @param lineNumber the line number the error occured in (typically __LINE__)
|
||||
*
|
||||
* @return the error sent in (for convenience).
|
||||
*
|
||||
* Example usage:
|
||||
* @code{.cpp}
|
||||
* #include <opm/simulators/linalg/cuistl/detail/cublas_safe_call.hpp>
|
||||
* #include <cublas_v2.h>
|
||||
*
|
||||
* void some_function() {
|
||||
* cublasHandle_t cublasHandle;
|
||||
* cublasWarnIfError(cublasCreate(&cublasHandle), "cublasCreate(&cublasHandle)", __FILE__, __func__, __LINE__);
|
||||
* }
|
||||
* @endcode
|
||||
*
|
||||
* @note It is probably easier to use the macro OPM_CUBLAS_WARN_IF_ERROR
|
||||
* @note Prefer the cublasSafeCall/OPM_CUBLAS_SAFE_CALL counterpart unless you really don't want to throw an exception.
|
||||
*
|
||||
* @todo Refactor to use std::source_location once we shift to C++20
|
||||
*/
|
||||
inline cublasStatus_t
|
||||
cublasWarnIfError(cublasStatus_t error,
|
||||
const std::string_view& expression,
|
||||
const std::string_view& filename,
|
||||
const std::string_view& functionName,
|
||||
size_t lineNumber)
|
||||
{
|
||||
if (error != CUBLAS_STATUS_SUCCESS) {
|
||||
OpmLog::warning(getCublasErrorMessage(error, expression, filename, functionName, lineNumber));
|
||||
}
|
||||
|
||||
return error;
|
||||
}
|
||||
} // namespace Opm::cuistl::detail
|
||||
|
||||
/**
|
||||
@ -119,4 +196,24 @@ cublasSafeCall(cublasStatus_t error,
|
||||
#define OPM_CUBLAS_SAFE_CALL(expression) \
|
||||
::Opm::cuistl::detail::cublasSafeCall(expression, #expression, __FILE__, __func__, __LINE__)
|
||||
|
||||
/**
|
||||
* @brief OPM_CUBLAS_WARN_IF_ERROR checks the return type of the cublas expression (function call) and issues a warning
|
||||
* if it does not equal CUBLAS_STATUS_SUCCESS.
|
||||
*
|
||||
* Example usage:
|
||||
* @code{.cpp}
|
||||
* #include <cublas_v2.h>
|
||||
* #include <opm/simulators/linalg/cuistl/detail/cublas_safe_call.hpp>
|
||||
*
|
||||
* void some_function() {
|
||||
* cublasHandle_t cublasHandle;
|
||||
* OPM_CUBLAS_WARN_IF_ERROR(cublasCreate(&cublasHandle));
|
||||
* }
|
||||
* @endcode
|
||||
*
|
||||
* @note Prefer the cublasSafeCall/OPM_CUBLAS_SAFE_CALL counterpart unless you really don't want to throw an exception.
|
||||
*/
|
||||
#define OPM_CUBLAS_WARN_IF_ERROR(expression) \
|
||||
::Opm::cuistl::detail::cublasWarnIfError(expression, #expression, __FILE__, __func__, __LINE__)
|
||||
|
||||
#endif // OPM_CUBLAS_SAFE_CALL_HPP
|
||||
|
||||
Loading…
Reference in New Issue
Block a user