/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.4.1/include/hip/hip_runtime.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.4.1/include/hip/hip_runtime.h Source File#

HIP Runtime API Reference: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.4.1/include/hip/hip_runtime.h Source File
hip_runtime.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2015 - 2021 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 #if !defined(__HIPCC_RTC__)
45 // Some standard header files, these are included by hc.hpp and so want to make them avail on both
46 // paths to provide a consistent include env and avoid "missing symbol" errors that only appears
47 // on NVCC path:
48 #include <stdint.h>
49 #include <stdio.h>
50 #include <stdlib.h>
51 #include <assert.h>
52 
53 #if __cplusplus > 199711L
54 #include <thread>
55 #endif
56 #endif // !defined(__HIPCC_RTC__)
57 
58 #include <hip/hip_version.h>
59 #include <hip/hip_common.h>
60 
61 #if (defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && !(defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
62 #include <hip/amd_detail/amd_hip_runtime.h>
63 #elif !(defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && (defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
64 #include <hip/nvidia_detail/nvidia_hip_runtime.h>
65 #else
66 #error("Must define exactly one of __HIP_PLATFORM_AMD__ or __HIP_PLATFORM_NVIDIA__");
67 #endif
68 
69 // The following are deprecation notices.
70 // They will be removed after upstream updation
71 #if 0 // Temporarily disable deprecation warning as it will fail rocgdb test
72 #if defined(__clang__)
73 //The following work for clang rather than for gnu gcc/g++/c++
74 #pragma GCC diagnostic push
75 #pragma GCC diagnostic warning "-Wcpp"
76 #ifdef __HCC__
77 #warning("__HCC__ is deprecated, please don't use it")
78 #endif
79 
80 #ifdef __HIP_ROCclr__
81 #warning("__HIP_ROCclr__ is deprecated, please don't use it")
82 #endif
83 
84 #ifdef __HIP_PLATFORM_HCC__
85 #warning("__HIP_PLATFORM_HCC__ is deprecated, please use __HIP_PLATFORM_AMD__ instead")
86 #endif
87 
88 #ifdef __HIP_PLATFORM_NVCC_
89 #warning("__HIP_PLATFORM_NVCC_ is deprecated, please use __HIP_PLATFORM_NVIDIA__ instead")
90 #endif
91 #pragma GCC diagnostic pop
92 #elif defined(__GNUC__)
93 //The following work for gnu gcc/g++/c++ rather than for clang
94 #ifdef __HCC__
95 #pragma message ("__HCC__ is deprecated, please don't use it")
96 #endif
97 
98 #ifdef __HIP_ROCclr__
99 #pragma message ("__HIP_ROCclr__ is deprecated, please don't use it")
100 #endif
101 
102 #ifdef __HIP_PLATFORM_HCC__
103 #pragma message ("__HIP_PLATFORM_HCC__ is deprecated, please use __HIP_PLATFORM_AMD__ instead")
104 #endif
105 
106 #ifdef __HIP_PLATFORM_NVCC_
107 #pragma message ("__HIP_PLATFORM_NVCC_ is deprecated, please use __HIP_PLATFORM_NVIDIA__ instead")
108 #endif
109 #endif // defined(__clang__)
110 #endif
111 
112 #if !defined(__HIPCC_RTC__)
113 #include <hip/hip_runtime_api.h>
114 #include <hip/library_types.h>
115 #endif // !defined(__HIPCC_RTC__)
116 #include <hip/hip_vector_types.h>
117 
118 #endif
hip_common.h
hip_runtime_api.h
Defines the API signatures for HIP runtime. This file can be compiled with a standard compiler.
hip_vector_types.h
library_types.h