HIP: Heterogenous-computing Interface for Portability
hip_runtime.h
1 /*
2 Copyright (c) 2015 - present Advanced Micro Devices, Inc. All rights reserved.
3 
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21 */
22 
28 //
32 //
36 
37 #ifndef HIP_INCLUDE_HIP_HIP_RUNTIME_H
38 #define HIP_INCLUDE_HIP_HIP_RUNTIME_H
39 
40 #if (__gfx1010__ || __gfx1011__ || __gfx1012__ || __gfx1030__ || __gfx1031__) && __AMDGCN_WAVEFRONT_SIZE == 64
41 #error HIP is not supported on GFX10 with wavefront size 64
42 #endif
43 
44 // Some standard header files, these are included by hc.hpp and so want to make them avail on both
45 // paths to provide a consistent include env and avoid "missing symbol" errors that only appears
46 // on NVCC path:
47 #include <stdint.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <assert.h>
51 
52 #if __cplusplus > 199711L
53 #include <thread>
54 #endif
55 
56 #include <hip/hip_version.h>
57 #include <hip/hip_common.h>
58 
59 #if (defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && !(defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
61 #elif !(defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && (defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
62 #include <hip/nvidia_detail/hip_runtime.h>
63 #else
64 #error("Must define exactly one of __HIP_PLATFORM_AMD__ or __HIP_PLATFORM_NVIDIA__");
65 #endif
66 
67 // The following are deprecation notices.
68 // They will be removed after upstream updation
69 #if 0 // Temporarily disable deprecation warning as it will fail rocgdb test
70 #if defined(__clang__)
71 //The following work for clang rather than for gnu gcc/g++/c++
72 #pragma GCC diagnostic push
73 #pragma GCC diagnostic warning "-Wcpp"
74 #ifdef __HCC__
75 #warning("__HCC__ is deprecated, please don't use it")
76 #endif
77 
78 #ifdef __HIP_ROCclr__
79 #warning("__HIP_ROCclr__ is deprecated, please don't use it")
80 #endif
81 
82 #ifdef __HIP_PLATFORM_HCC__
83 #warning("__HIP_PLATFORM_HCC__ is deprecated, please use __HIP_PLATFORM_AMD__ instead")
84 #endif
85 
86 #ifdef __HIP_PLATFORM_NVCC_
87 #warning("__HIP_PLATFORM_NVCC_ is deprecated, please use __HIP_PLATFORM_NVIDIA__ instead")
88 #endif
89 #pragma GCC diagnostic pop
90 #elif defined(__GNUC__)
91 //The following work for gnu gcc/g++/c++ rather than for clang
92 #ifdef __HCC__
93 #pragma message ("__HCC__ is deprecated, please don't use it")
94 #endif
95 
96 #ifdef __HIP_ROCclr__
97 #pragma message ("__HIP_ROCclr__ is deprecated, please don't use it")
98 #endif
99 
100 #ifdef __HIP_PLATFORM_HCC__
101 #pragma message ("__HIP_PLATFORM_HCC__ is deprecated, please use __HIP_PLATFORM_AMD__ instead")
102 #endif
103 
104 #ifdef __HIP_PLATFORM_NVCC_
105 #pragma message ("__HIP_PLATFORM_NVCC_ is deprecated, please use __HIP_PLATFORM_NVIDIA__ instead")
106 #endif
107 #endif // defined(__clang__)
108 #endif
109 
110 #include <hip/hip_runtime_api.h>
111 #include <hip/hip_vector_types.h>
112 #include <hip/library_types.h>
113 
114 #endif
hip_runtime_api.h
Defines the API signatures for HIP runtime. This file can be compiled with a standard compiler.
hip_runtime.h
Contains definitions of APIs for HIP runtime.