hipcub/config.hpp Source File

• hipcub

config.hpp

1 /******************************************************************************

2  * Copyright (c) 2010-2011, Duane Merrill. All rights reserved.

3  * Copyright (c) 2011-2018, NVIDIA CORPORATION. All rights reserved.

4  * Modifications Copyright (c) 2019-2024, Advanced Micro Devices, Inc. All rights reserved.

5  *

6  * Redistribution and use in source and binary forms, with or without

7  * modification, are permitted provided that the following conditions are met:

8  * * Redistributions of source code must retain the above copyright

9  * notice, this list of conditions and the following disclaimer.

10  * * Redistributions in binary form must reproduce the above copyright

11  * notice, this list of conditions and the following disclaimer in the

12  * documentation and/or other materials provided with the distribution.

13  * * Neither the name of the NVIDIA CORPORATION nor the

14  * names of its contributors may be used to endorse or promote products

15  * derived from this software without specific prior written permission.

16  *

17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

20  * DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE FOR ANY

21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

27  *

28  ******************************************************************************/

29 

30 #ifndef HIPCUB_CONFIG_HPP_

31 #define HIPCUB_CONFIG_HPP_

32 

33 #include <hip/hip_runtime.h>

34 

35 #define HIPCUB_NAMESPACE hipcub

36 

37 #define BEGIN_HIPCUB_NAMESPACE \

38  namespace hipcub {

39 

40 #define END_HIPCUB_NAMESPACE \

41  } /* hipcub */

42 

43 #ifdef __HIP_PLATFORM_AMD__

44  #define HIPCUB_ROCPRIM_API 1

45  #define HIPCUB_RUNTIME_FUNCTION __host__

46 

47  #include <rocprim/device/config_types.hpp>

48 

49 BEGIN_HIPCUB_NAMESPACE

50 namespace detail

51 {

52 inline unsigned int host_warp_size_wrapper()

53 {

54  int device_id = 0;

55  unsigned int host_warp_size = 0;

56  hipError_t error = hipGetDevice(&device_id);

57  if(error != hipSuccess)

58  {

59  fprintf(stderr, "HIP error: %d line: %d: %s\n", error, __LINE__, hipGetErrorString(error));

60  fflush(stderr);

61  }

62  if(::rocprim::host_warp_size(device_id, host_warp_size) != hipSuccess)

63  {

64  return 0u;

65  }

66  return host_warp_size;

67 }

68 } // namespace detail

69 END_HIPCUB_NAMESPACE

70 

71  #define HIPCUB_WARP_THREADS ::rocprim::warp_size()

72  #define HIPCUB_DEVICE_WARP_THREADS ::rocprim::device_warp_size()

73  #define HIPCUB_HOST_WARP_THREADS ::hipcub::detail::host_warp_size_wrapper()

74  #define HIPCUB_ARCH 1 // ignored with rocPRIM backend

75 #elif defined(__HIP_PLATFORM_NVIDIA__)

76  #define HIPCUB_CUB_API 1

77  #define HIPCUB_RUNTIME_FUNCTION CUB_RUNTIME_FUNCTION

78 

79  #include <cub/util_arch.cuh>

80  #define HIPCUB_WARP_THREADS CUB_PTX_WARP_THREADS

81  #define HIPCUB_DEVICE_WARP_THREADS CUB_PTX_WARP_THREADS

82  #define HIPCUB_HOST_WARP_THREADS CUB_PTX_WARP_THREADS

83  #define HIPCUB_ARCH CUB_PTX_ARCH

84  BEGIN_HIPCUB_NAMESPACE

85  using namespace cub;

86  END_HIPCUB_NAMESPACE

87 #endif

88 

90 #define HIPCUB_WARP_SIZE_32 32u

91 #define HIPCUB_WARP_SIZE_64 64u

92 #define HIPCUB_MAX_WARP_SIZE HIPCUB_WARP_SIZE_64

93 

94 #define HIPCUB_HOST __host__

95 #define HIPCUB_DEVICE __device__

96 #define HIPCUB_HOST_DEVICE __host__ __device__

97 #define HIPCUB_SHARED_MEMORY __shared__

98 

99 // Helper macros to disable warnings in clang

100 #ifdef __clang__

101 #define HIPCUB_PRAGMA_TO_STR(x) _Pragma(#x)

102 #define HIPCUB_CLANG_SUPPRESS_WARNING_PUSH _Pragma("clang diagnostic push")

103 #define HIPCUB_CLANG_SUPPRESS_WARNING(w) HIPCUB_PRAGMA_TO_STR(clang diagnostic ignored w)

104 #define HIPCUB_CLANG_SUPPRESS_WARNING_POP _Pragma("clang diagnostic pop")

105 #define HIPCUB_CLANG_SUPPRESS_WARNING_WITH_PUSH(w) \

106  HIPCUB_CLANG_SUPPRESS_WARNING_PUSH HIPCUB_CLANG_SUPPRESS_WARNING(w)

107 #else // __clang__

108 #define HIPCUB_CLANG_SUPPRESS_WARNING_PUSH

109 #define HIPCUB_CLANG_SUPPRESS_WARNING(w)

110 #define HIPCUB_CLANG_SUPPRESS_WARNING_POP

111 #define HIPCUB_CLANG_SUPPRESS_WARNING_WITH_PUSH(w)

112 #endif // __clang__

113 

114 #define HIPCUB_CLANG_SUPPRESS_DEPRECATED_PUSH \

115  HIPCUB_CLANG_SUPPRESS_WARNING_PUSH \

116  HIPCUB_CLANG_SUPPRESS_WARNING("-Wdeprecated") \

117  HIPCUB_CLANG_SUPPRESS_WARNING("-Wdeprecated-declarations")

118 #define HIPCUB_CLANG_SUPPRESS_DEPRECATED_POP HIPCUB_CLANG_SUPPRESS_WARNING_POP

119 

121 #if (defined(DEBUG) || defined(_DEBUG)) && !defined(HIPCUB_STDERR)

122  #define HIPCUB_STDERR

123 #endif

124 

125 BEGIN_HIPCUB_NAMESPACE

126 

131 inline

132 hipError_t Debug(

133  hipError_t error,

134  const char* filename,

135  int line)

136 {

137  (void)filename;

138  (void)line;

139 #ifdef HIPCUB_STDERR

140  if (error)

141  {

142  fprintf(stderr, "HIP error %d [%s, %d]: %s\n", error, filename, line, hipGetErrorString(error));

143  fflush(stderr);

144  }

145 #endif

146  return error;

147 }

148 

152 inline void Log(const char* message, const char* filename, int line)

153 {

154  printf("hipcub: %s [%s:%d]\n", message, filename, line);

155 }

156 

157 END_HIPCUB_NAMESPACE

158 

159 #ifndef HipcubDebug

160  #define HipcubDebug(e) ::hipcub::Debug((hipError_t)(e), __FILE__, __LINE__)

161 #endif

162 

163 #ifndef HipcubLog

164  #define HipcubLog(msg) ::hipcub::Log(msg, __FILE__, __LINE__)

165 #endif

166 

167 #if __cpp_if_constexpr

168  #define HIPCUB_IF_CONSTEXPR constexpr

169 #else

170  #if defined(_MSC_VER) && !defined(__clang__)

171  // MSVC (and not Clang pretending to be MSVC) unconditionally exposes if constexpr (even in C++14 mode),

172  // moreover it triggers warning C4127 (conditional expression is constant) when not using it. nvcc will

173  // be calling cl.exe for host-side codegen.

174  #define HIPCUB_IF_CONSTEXPR constexpr

175  #else

176  #define HIPCUB_IF_CONSTEXPR

177  #endif

178 #endif

179 

180 #ifdef DOXYGEN_SHOULD_SKIP_THIS // Documentation only

181 

186  #define HIPCUB_DEBUG_SYNC

187 

188 #endif // DOXYGEN_SHOULD_SKIP_THIS

189 

190 #if defined(HIPCUB_CUB_API) && defined(HIPCUB_DEBUG_SYNC) && !defined(CUB_DEBUG_SYNC)

191  #define CUB_DEBUG_SYNC

192 #endif

193 

194 #if !defined(HIPCUB_DEBUG_SYNC) \

195  && (defined(CUB_DEBUG_SYNC) || defined(CUB_DEBUG_HOST_ASSERTIONS) \

196  || defined(CUB_DEBUG_DEVICE_ASSERTIONS) || defined(CUB_DEBUG_ALL))

197  #define HIPCUB_DEBUG_SYNC

198 #endif

199 

200 #ifdef HIPCUB_ROCPRIM_API

201  // TODO C++17: use an inline constexpr variable

202  #ifdef HIPCUB_DEBUG_SYNC

203  #define HIPCUB_DETAIL_DEBUG_SYNC_VALUE true

204  #else

205  #define HIPCUB_DETAIL_DEBUG_SYNC_VALUE false

206  #endif

207 #endif // HIPCUB_ROCPRIM_API

208 

209 #endif // HIPCUB_CONFIG_HPP_

hipcub::Debug

hipError_t Debug(hipError_t error, const char *filename, int line)

Don't use this function directly, but via the HipcubDebug macro instead. If error is not hipSuccess,...

Definition: config.hpp:132

hipcub::Log

void Log(const char *message, const char *filename, int line)

Don't use this function directly, but via the HipcubLog macro instead. Prints the provided message co...

Definition: config.hpp:152