Added error macros to check last CUDA error.

CMakeLists_files.cmake

@@ -148,6 +148,7 @@ if(CUDA_FOUND)
   list (APPEND PUBLIC_HEADER_FILES opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp)
   list (APPEND PUBLIC_HEADER_FILES opm/simulators/linalg/cuistl/detail/cusparse_safe_call.hpp)
   list (APPEND PUBLIC_HEADER_FILES opm/simulators/linalg/cuistl/detail/cublas_safe_call.hpp)
+  list (APPEND PUBLIC_HEADER_FILES opm/simulators/linalg/cuistl/detail/cuda_check_last_error.hpp)
 endif()
 if(OPENCL_FOUND)
   list (APPEND MAIN_SOURCE_FILES opm/simulators/linalg/bda/BlockedMatrix.cpp)
@@ -228,6 +229,7 @@ if(CUDA_FOUND)
   list(APPEND TEST_SOURCE_FILES tests/cuistl/test_cusparse_safe_call.cpp)
   list(APPEND TEST_SOURCE_FILES tests/cuistl/test_cublas_safe_call.cpp)
   list(APPEND TEST_SOURCE_FILES tests/cuistl/test_cuda_safe_call.cpp)
+  list(APPEND TEST_SOURCE_FILES tests/cuistl/test_cuda_check_last_error.cpp)
 endif()
 if(OPENCL_FOUND)
   list(APPEND TEST_SOURCE_FILES tests/test_openclSolver.cpp)

opm/simulators/linalg/cuistl/detail/cuda_check_last_error.hpp

@@ -0,0 +1,101 @@
+/*
+  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_CUDA_CHECK_LAST_ERROR_HPP
+#define OPM_CUDA_CHECK_LAST_ERROR_HPP
+#include <cuda_runtime.h>
+#include <fmt/core.h>
+#include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
+
+/**
+ * @brief OPM_CUDA_CHECK_LAST_ERROR checks the return type of cudaDeviceSynchronize(),
+ * and throws an exception if cudaDeviceSynchronize() does not equal cudaSuccess.
+ *
+ * Example usage:
+ * @code{.cpp}
+ * #include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
+ *
+ * void some_function() {
+ *     OPM_CUDA_CHECK_LAST_ERROR;
+ * }
+ * @endcode
+ *
+ * @note This can be used to debug the code, or simply make sure that no error has occured.
+ * @note This is a rather heavy operation, so prefer to use only in Debug mode (see OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE_IF_DEBUG)
+ */
+#define OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE OPM_CUDA_SAFE_CALL(cudaDeviceSynchronize())
+
+#ifdef NDEBUG
+#define OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE_IF_DEBUG
+#else
+/**
+ * @brief OPM_CUDA_CHECK_LAST_ERROR_IF_DEBUG checks the return type of cudaDeviceSynchronize only if NDEBUG is not defined,
+ * and throws an exception if cudaDeviceSynchronize() does not equal cudaSuccess.
+ *
+ * Example usage:
+ * @code{.cpp}
+ * #include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
+ *
+ * void some_function() {
+ *     OPM_CUDA_CHECK_LAST_ERROR;
+ * }
+ * @endcode
+ *
+ * @note This can be used to debug the code, or simply make sure that no error has occured.
+ */
+#define OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE_IF_DEBUG OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE
+#endif
+
+
+/**
+ * @brief OPM_CUDA_CHECK_LAST_ERROR checks the return type of cudaGetLastError(),
+ * and throws an exception if cudaGetLastError() does not equal cudaSuccess.
+ *
+ * Example usage:
+ * @code{.cpp}
+ * #include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
+ *
+ * void some_function() {
+ *     OPM_CUDA_CHECK_LAST_ERROR;
+ * }
+ * @endcode
+ *
+ * @note This can be used to debug the code, or simply make sure that no error has occured.
+ */
+#define OPM_CUDA_CHECK_LAST_ERROR OPM_CUDA_SAFE_CALL(cudaGetLastError())
+#ifdef NDEBUG
+#define OPM_CUDA_CHECK_LAST_ERROR_IF_DEBUG
+#else
+/**
+ * @brief OPM_CUDA_CHECK_LAST_ERROR_IF_DEBUG checks the return type of cudaGetLastError() only if NDEBUG is not defined,
+ * and throws an exception if cudaGetLastError() does not equal cudaSuccess.
+ *
+ * Example usage:
+ * @code{.cpp}
+ * #include <opm/simulators/linalg/cuistl/detail/cuda_safe_call.hpp>
+ *
+ * void some_function() {
+ *     OPM_CUDA_CHECK_LAST_ERROR;
+ * }
+ * @endcode
+ *
+ * @note This can be used to debug the code, or simply make sure that no error has occured.
+ */
+#define OPM_CUDA_CHECK_LAST_ERROR_IF_DEBUG OPM_CUDA_CHECK_LAST_ERROR
+#endif
+#endif

tests/cuistl/test_cuda_check_last_error.cpp

@@ -0,0 +1,38 @@
+/*
+  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/>.
+*/
+#include <config.h>
+
+#define BOOST_TEST_MODULE TestCudaCheckLastError
+
+#include <boost/test/unit_test.hpp>
+#include <opm/simulators/linalg/cuistl/detail/cuda_check_last_error.hpp>
+
+
+BOOST_AUTO_TEST_CASE(TestNoThrowLastError)
+{
+    BOOST_CHECK_NO_THROW(OPM_CUDA_CHECK_LAST_ERROR;);
+    BOOST_CHECK_NO_THROW(OPM_CUDA_CHECK_LAST_ERROR_IF_DEBUG;);
+}
+
+
+BOOST_AUTO_TEST_CASE(TestNoThrowDeviceSynchronize)
+{
+    BOOST_CHECK_NO_THROW(OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE;);
+    BOOST_CHECK_NO_THROW(OPM_CUDA_CHECK_DEVICE_SYNCHRONIZE_IF_DEBUG;);
+}