1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Kokkos v. 3.0
6 // Copyright (2020) National Technology & Engineering
7 // Solutions of Sandia, LLC (NTESS).
8 //
9 // Under the terms of Contract DE-NA0003525 with NTESS,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Christian R. Trott (crtrott@sandia.gov)
40 //
41 // ************************************************************************
42 //@HEADER
43 */
44
45 #ifndef KOKKOS_HIP_ERROR_HPP
46 #define KOKKOS_HIP_ERROR_HPP
47
48 #include <Kokkos_Macros.hpp>
49 #include <impl/Kokkos_Error.hpp>
50
51 #include <hip/hip_runtime.h>
52
53 #include <ostream>
54
55 namespace Kokkos {
56 namespace Impl {
57
58 void hip_internal_error_throw(hipError_t e, const char* name,
59 const char* file = nullptr, const int line = 0);
60
hip_internal_safe_call(hipError_t e,const char * name,const char * file=nullptr,const int line=0)61 inline void hip_internal_safe_call(hipError_t e, const char* name,
62 const char* file = nullptr,
63 const int line = 0) {
64 if (hipSuccess != e) {
65 hip_internal_error_throw(e, name, file, line);
66 }
67 }
68
69 } // namespace Impl
70 } // namespace Kokkos
71
72 #define HIP_SAFE_CALL(call) \
73 Kokkos::Impl::hip_internal_safe_call(call, #call, __FILE__, __LINE__)
74
75 namespace Kokkos {
76 namespace Experimental {
77
78 class HIPRawMemoryAllocationFailure : public RawMemoryAllocationFailure {
79 private:
80 hipError_t m_error_code = hipSuccess;
81
get_failure_mode(hipError_t error_code)82 static FailureMode get_failure_mode(hipError_t error_code) {
83 switch (error_code) {
84 case hipErrorMemoryAllocation: return FailureMode::OutOfMemoryError;
85 case hipErrorInvalidValue: return FailureMode::InvalidAllocationSize;
86 default: return FailureMode::Unknown;
87 }
88 }
89
90 public:
HIPRawMemoryAllocationFailure(size_t arg_attempted_size,hipError_t arg_error_code,AllocationMechanism arg_mechanism)91 HIPRawMemoryAllocationFailure(size_t arg_attempted_size,
92 hipError_t arg_error_code,
93 AllocationMechanism arg_mechanism) noexcept
94 : RawMemoryAllocationFailure(
95 arg_attempted_size, /* HIPSpace doesn't handle alignment? */ 1,
96 get_failure_mode(arg_error_code), arg_mechanism),
97 m_error_code(arg_error_code) {}
98
append_additional_error_information(std::ostream & o) const99 void append_additional_error_information(std::ostream& o) const override {
100 if (m_error_code != hipSuccess) {
101 o << " The HIP allocation returned the error code \"\""
102 << hipGetErrorName(m_error_code) << "\".";
103 }
104 }
105 };
106
107 } // namespace Experimental
108 } // namespace Kokkos
109
110 #endif
111