HIP: Heterogenous-computing Interface for Portability
|
Go to the documentation of this file.
24 #ifndef HIP_INCLUDE_HIP_HCC_DETAIL_HIP_RUNTIME_API_H
25 #define HIP_INCLUDE_HIP_HCC_DETAIL_HIP_RUNTIME_API_H
34 #ifndef GENERIC_GRID_LAUNCH
35 #define GENERIC_GRID_LAUNCH 1
38 #ifndef __HIP_ROCclr__
39 #define __HIP_ROCclr__ 0
43 #include <hip/hcc_detail/driver_types.h>
47 #if !__HIP_ROCclr__ && defined(__cplusplus)
49 #include <hip/hcc_detail/program_state.hpp>
53 #define DEPRECATED(msg) __declspec(deprecated(msg))
54 #else // !defined(_MSC_VER)
55 #define DEPRECATED(msg) __attribute__ ((deprecated(msg)))
56 #endif // !defined(_MSC_VER)
58 #define DEPRECATED_MSG "This API is marked as deprecated and may not be supported in future releases. For more details please refer https://github.com/ROCm-Developer-Tools/HIP/blob/master/docs/markdown/hip_deprecated_api_list.md"
60 #if defined(__HCC__) && (__hcc_workweek__ < 16155)
61 #error("This version of HIP requires a newer version of HCC.");
64 #define HIP_LAUNCH_PARAM_BUFFER_POINTER ((void*)0x01)
65 #define HIP_LAUNCH_PARAM_BUFFER_SIZE ((void*)0x02)
66 #define HIP_LAUNCH_PARAM_END ((void*)0x03)
76 #pragma GCC visibility push (default)
82 hipError_t hip_init();
96 typedef int hipDevice_t;
98 typedef enum hipDeviceP2PAttr {
99 hipDevP2PAttrPerformanceRank = 0,
100 hipDevP2PAttrAccessSupported,
101 hipDevP2PAttrNativeAtomicSupported,
102 hipDevP2PAttrHipArrayAccessSupported
107 #define hipIpcMemLazyEnablePeerAccess 0
109 #define HIP_IPC_HANDLE_SIZE 64
112 char reserved[HIP_IPC_HANDLE_SIZE];
121 char reserved[HIP_IPC_HANDLE_SIZE];
131 size_t constSizeBytes;
132 size_t localSizeBytes;
133 int maxDynamicSharedSizeBytes;
134 int maxThreadsPerBlock;
136 int preferredShmemCarveout;
138 size_t sharedSizeBytes;
144 hipLimitMallocHeapSize = 0x02,
151 #define hipStreamDefault \
154 #define hipStreamNonBlocking 0x01
158 #define hipEventDefault 0x0
159 #define hipEventBlockingSync \
161 #define hipEventDisableTiming \
163 #define hipEventInterprocess 0x4
164 #define hipEventReleaseToDevice \
166 #define hipEventReleaseToSystem \
175 #define hipHostMallocDefault 0x0
176 #define hipHostMallocPortable 0x1
177 #define hipHostMallocMapped \
179 #define hipHostMallocWriteCombined 0x4
181 #define hipHostMallocNumaUser \
184 #define hipHostMallocCoherent \
186 #define hipHostMallocNonCoherent \
191 #define hipMemAttachGlobal 0x01
192 #define hipMemAttachHost 0x02
193 #define hipMemAttachSingle 0x04
196 #define hipDeviceMallocDefault 0x0
197 #define hipDeviceMallocFinegrained 0x1
199 #define hipHostRegisterDefault 0x0
201 #define hipHostRegisterPortable 0x1
202 #define hipHostRegisterMapped \
204 #define hipHostRegisterIoMemory 0x4
206 #define hipExtHostRegisterCoarseGrained 0x8
208 #define hipDeviceScheduleAuto 0x0
209 #define hipDeviceScheduleSpin \
211 #define hipDeviceScheduleYield \
214 #define hipDeviceScheduleBlockingSync 0x4
216 #define hipDeviceScheduleMask 0x7
218 #define hipDeviceMapHost 0x8
219 #define hipDeviceLmemResizeToMax 0x16
221 #define hipArrayDefault 0x00
222 #define hipArrayLayered 0x01
223 #define hipArraySurfaceLoadStore 0x02
224 #define hipArrayCubemap 0x04
225 #define hipArrayTextureGather 0x08
227 #define hipOccupancyDefault 0x00
229 #define hipCooperativeLaunchMultiDeviceNoPreSync 0x01
230 #define hipCooperativeLaunchMultiDeviceNoPostSync 0x02
232 #define hipCpuDeviceId ((int)-1)
233 #define hipInvalidDeviceId ((int)-2)
236 #define hipExtAnyOrderLaunch 0x01
275 typedef enum hipJitOption {
276 hipJitOptionMaxRegisters = 0,
277 hipJitOptionThreadsPerBlock,
278 hipJitOptionWallTime,
279 hipJitOptionInfoLogBuffer,
280 hipJitOptionInfoLogBufferSizeBytes,
281 hipJitOptionErrorLogBuffer,
282 hipJitOptionErrorLogBufferSizeBytes,
283 hipJitOptionOptimizationLevel,
284 hipJitOptionTargetFromContext,
286 hipJitOptionFallbackStrategy,
287 hipJitOptionGenerateDebugInfo,
288 hipJitOptionLogVerbose,
289 hipJitOptionGenerateLineInfo,
290 hipJitOptionCacheMode,
292 hipJitOptionFastCompile,
293 hipJitOptionNumOptions
300 hipFuncAttributeMaxDynamicSharedMemorySize = 8,
301 hipFuncAttributePreferredSharedMemoryCarveout = 9,
335 __host__ __device__
dim3(uint32_t _x = 1, uint32_t _y = 1, uint32_t _z = 1) :
x(_x),
y(_y),
z(_z){};
348 #if __HIP_HAS_GET_PCH
354 void __hipGetPCH(
const char** pch,
unsigned int*size);
1214 hipError_t
hipMalloc(
void** ptr,
size_t size);
1244 DEPRECATED(
"use hipHostMalloc instead")
1275 hipError_t
hipHostMalloc(
void** ptr,
size_t size,
unsigned int flags);
1305 hipError_t
hipHostAlloc(
void** ptr,
size_t size,
unsigned int flags);
1367 hipError_t
hipHostRegister(
void* hostPtr,
size_t sizeBytes,
unsigned int flags);
1398 hipError_t
hipMallocPitch(
void** ptr,
size_t* pitch,
size_t width,
size_t height);
1422 hipError_t
hipMemAllocPitch(hipDeviceptr_t* dptr,
size_t* pitch,
size_t widthInBytes,
size_t height,
unsigned int elementSizeBytes);
1437 hipError_t
hipFree(
void* ptr);
1496 hipError_t
hipMemcpy(
void* dst, const
void* src,
size_t sizeBytes, hipMemcpyKind kind);
1499 hipError_t hipMemcpyWithStream(
void* dst, const
void* src,
size_t sizeBytes,
1518 hipError_t
hipMemcpyHtoD(hipDeviceptr_t dst,
void* src,
size_t sizeBytes);
1537 hipError_t
hipMemcpyDtoH(
void* dst, hipDeviceptr_t src,
size_t sizeBytes);
1556 hipError_t
hipMemcpyDtoD(hipDeviceptr_t dst, hipDeviceptr_t src,
size_t sizeBytes);
1613 hipError_t
hipMemcpyDtoDAsync(hipDeviceptr_t dst, hipDeviceptr_t src,
size_t sizeBytes,
1620 hipError_t hipGetSymbolAddress(
void** devPtr,
const void* symbol);
1621 hipError_t hipGetSymbolSize(
size_t* size,
const void* symbol);
1622 hipError_t hipMemcpyToSymbol(
const void* symbol,
const void* src,
1623 size_t sizeBytes,
size_t offset __dparm(0),
1624 hipMemcpyKind kind __dparm(hipMemcpyHostToDevice));
1625 hipError_t hipMemcpyToSymbolAsync(
const void* symbol,
const void* src,
1626 size_t sizeBytes,
size_t offset,
1627 hipMemcpyKind kind,
hipStream_t stream __dparm(0));
1628 hipError_t hipMemcpyFromSymbol(
void* dst,
const void* symbol,
1629 size_t sizeBytes,
size_t offset __dparm(0),
1630 hipMemcpyKind kind __dparm(hipMemcpyDeviceToHost));
1631 hipError_t hipMemcpyFromSymbolAsync(
void* dst,
const void* symbol,
1632 size_t sizeBytes,
size_t offset,
1638 #ifdef __cplusplus //Start : Not supported in gcc
1639 namespace hip_impl {
1641 __attribute__((visibility(
"hidden")))
1642 hipError_t read_agent_global_from_process(hipDeviceptr_t* dptr,
size_t* bytes,
1658 __attribute__((visibility("hidden")))
1659 hipError_t hipGetSymbolAddress(
void** devPtr, const
void* symbolName) {
1661 hip_impl::hip_init();
1663 return hip_impl::read_agent_global_from_process(devPtr, &size, (
const char*)symbolName);
1678 __attribute__((visibility(
"hidden")))
1679 hipError_t hipGetSymbolSize(
size_t* size, const
void* symbolName) {
1681 hip_impl::hip_init();
1682 void* devPtr =
nullptr;
1683 return hip_impl::read_agent_global_from_process(&devPtr, size, (
const char*)symbolName);
1685 #endif // End : Not supported in gcc
1687 #if defined(__cplusplus)
1692 namespace hip_impl {
1693 hipError_t hipMemcpyToSymbol(
void*,
const void*,
size_t,
size_t, hipMemcpyKind,
1698 #if defined(__cplusplus)
1727 __attribute__((visibility(
"hidden")))
1728 hipError_t hipMemcpyToSymbol(const
void* symbolName, const
void* src,
1729 size_t sizeBytes,
size_t offset __dparm(0),
1730 hipMemcpyKind kind __dparm(hipMemcpyHostToDevice)) {
1731 if (!symbolName)
return hipErrorInvalidSymbol;
1733 hipDeviceptr_t dst = NULL;
1734 hipGetSymbolAddress(&dst, (
const char*)symbolName);
1736 return hip_impl::hipMemcpyToSymbol(dst, src, sizeBytes, offset, kind,
1737 (
const char*)symbolName);
1741 #if defined(__cplusplus)
1746 namespace hip_impl {
1747 hipError_t hipMemcpyToSymbolAsync(
void*,
const void*,
size_t,
size_t,
1749 hipError_t hipMemcpyFromSymbol(
void*,
const void*,
size_t,
size_t,
1750 hipMemcpyKind,
const char*);
1751 hipError_t hipMemcpyFromSymbolAsync(
void*,
const void*,
size_t,
size_t,
1756 #if defined(__cplusplus)
1786 #ifdef __cplusplus //Start : Not supported in gcc
1788 __attribute__((visibility(
"hidden")))
1789 hipError_t hipMemcpyToSymbolAsync(const
void* symbolName, const
void* src,
1790 size_t sizeBytes,
size_t offset,
1791 hipMemcpyKind kind,
hipStream_t stream __dparm(0)) {
1792 if (!symbolName)
return hipErrorInvalidSymbol;
1794 hipDeviceptr_t dst = NULL;
1795 hipGetSymbolAddress(&dst, symbolName);
1797 return hip_impl::hipMemcpyToSymbolAsync(dst, src, sizeBytes, offset, kind,
1799 (
const char*)symbolName);
1803 __attribute__((visibility(
"hidden")))
1804 hipError_t hipMemcpyFromSymbol(
void* dst, const
void* symbolName,
1805 size_t sizeBytes,
size_t offset __dparm(0),
1806 hipMemcpyKind kind __dparm(hipMemcpyDeviceToHost)) {
1807 if (!symbolName)
return hipErrorInvalidSymbol;
1809 hipDeviceptr_t src = NULL;
1810 hipGetSymbolAddress(&src, symbolName);
1812 return hip_impl::hipMemcpyFromSymbol(dst, src, sizeBytes, offset, kind,
1813 (
const char*)symbolName);
1817 __attribute__((visibility(
"hidden")))
1818 hipError_t hipMemcpyFromSymbolAsync(
void* dst, const
void* symbolName,
1819 size_t sizeBytes,
size_t offset,
1822 if (!symbolName)
return hipErrorInvalidSymbol;
1824 hipDeviceptr_t src = NULL;
1825 hipGetSymbolAddress(&src, symbolName);
1827 return hip_impl::hipMemcpyFromSymbolAsync(dst, src, sizeBytes, offset, kind,
1829 (
const char*)symbolName);
1831 #endif // End : Not supported in gcc
1833 #endif // __HIP_ROCclr__
1862 hipError_t
hipMemcpyAsync(
void* dst,
const void* src,
size_t sizeBytes, hipMemcpyKind kind,
1874 hipError_t
hipMemset(
void* dst,
int value,
size_t sizeBytes);
1885 hipError_t
hipMemsetD8(hipDeviceptr_t dest,
unsigned char value,
size_t count);
1913 hipError_t
hipMemsetD16(hipDeviceptr_t dest,
unsigned short value,
size_t count);
1941 hipError_t
hipMemsetD32(hipDeviceptr_t dest,
int value,
size_t count);
1989 hipError_t
hipMemset2D(
void* dst,
size_t pitch,
int value,
size_t width,
size_t height);
2038 hipError_t hipMemPtrGetInfo(
void* ptr,
size_t* size);
2054 size_t height __dparm(0),
unsigned int flags __dparm(
hipArrayDefault));
2093 struct hipExtent extent,
unsigned int flags);
2110 unsigned int numLevels,
2111 unsigned int flags __dparm(0));
2125 unsigned int level);
2143 hipError_t
hipMemcpy2D(
void* dst,
size_t dpitch,
const void* src,
size_t spitch,
size_t width,
2144 size_t height, hipMemcpyKind kind);
2186 hipError_t
hipMemcpy2DAsync(
void* dst,
size_t dpitch,
const void* src,
size_t spitch,
size_t width,
2187 size_t height, hipMemcpyKind kind,
hipStream_t stream __dparm(0));
2207 size_t spitch,
size_t width,
size_t height, hipMemcpyKind kind);
2224 DEPRECATED(DEPRECATED_MSG)
2226 size_t count, hipMemcpyKind kind);
2243 DEPRECATED(DEPRECATED_MSG)
2245 size_t count, hipMemcpyKind kind);
2447 #ifndef USE_PEER_NON_UNIFIED
2448 #define USE_PEER_NON_UNIFIED 1
2451 #if USE_PEER_NON_UNIFIED == 1
2463 hipError_t
hipMemcpyPeer(
void* dst,
int dstDeviceId,
const void* src,
int srcDeviceId,
2503 hipError_t
hipInit(
unsigned int flags);
2525 DEPRECATED(DEPRECATED_MSG)
2538 DEPRECATED(DEPRECATED_MSG)
2551 DEPRECATED(DEPRECATED_MSG)
2564 DEPRECATED(DEPRECATED_MSG)
2577 DEPRECATED(DEPRECATED_MSG)
2590 DEPRECATED(DEPRECATED_MSG)
2604 DEPRECATED(DEPRECATED_MSG)
2624 DEPRECATED(DEPRECATED_MSG)
2640 DEPRECATED(DEPRECATED_MSG)
2656 DEPRECATED(DEPRECATED_MSG)
2672 DEPRECATED(DEPRECATED_MSG)
2688 DEPRECATED(DEPRECATED_MSG)
2702 DEPRECATED(DEPRECATED_MSG)
2715 DEPRECATED(DEPRECATED_MSG)
2737 DEPRECATED(DEPRECATED_MSG)
2756 DEPRECATED(DEPRECATED_MSG)
2837 hipError_t
hipDeviceGet(hipDevice_t* device,
int ordinal);
2870 int srcDevice,
int dstDevice);
2993 #if defined(__cplusplus)
2998 namespace hip_impl {
2999 class agent_globals_impl;
3000 class agent_globals {
3004 agent_globals(
const agent_globals&) =
delete;
3006 hipError_t read_agent_global_from_module(hipDeviceptr_t* dptr,
size_t* bytes,
3008 hipError_t read_agent_global_from_process(hipDeviceptr_t* dptr,
size_t* bytes,
3011 agent_globals_impl* impl;
3015 __attribute__((visibility(
"hidden")))
3016 agent_globals& get_agent_globals() {
3017 static agent_globals ag;
3023 __attribute__((visibility(
"hidden")))
3024 hipError_t read_agent_global_from_process(hipDeviceptr_t* dptr,
size_t* bytes,
3026 return get_agent_globals().read_agent_global_from_process(dptr, bytes, name);
3031 #if defined(__cplusplus)
3047 #endif // __HIP_ROCclr__
3075 hipJitOption* options,
void** optionValues);
3102 unsigned int gridDimZ,
unsigned int blockDimX,
3103 unsigned int blockDimY,
unsigned int blockDimZ,
3105 void** kernelParams,
void** extra);
3108 #if __HIP_ROCclr__ && !defined(__HCC__)
3124 hipError_t hipLaunchCooperativeKernel(
const void* f,
dim3 gridDim,
dim3 blockDimX,
3125 void** kernelParams,
unsigned int sharedMemBytes,
3138 hipError_t hipLaunchCooperativeKernelMultiDevice(
hipLaunchParams* launchParamsList,
3139 int numDevices,
unsigned int flags);
3158 int blockSizeLimit);
3175 int blockSizeLimit,
unsigned int flags);
3186 int* numBlocks,
hipFunction_t f,
int blockSize,
size_t dynSharedMemPerBlk);
3198 int* numBlocks,
hipFunction_t f,
int blockSize,
size_t dynSharedMemPerBlk,
unsigned int flags);
3209 int* numBlocks,
const void* f,
int blockSize,
size_t dynSharedMemPerBlk);
3221 int* numBlocks,
const void* f,
int blockSize,
size_t dynSharedMemPerBlk,
unsigned int flags __dparm(hipOccupancyDefault));
3235 const void* f,
size_t dynSharedMemPerBlk,
3236 int blockSizeLimit);
3250 int numDevices,
unsigned int flags);
3277 DEPRECATED(
"use roctracer/rocTX instead")
3286 DEPRECATED("use roctracer/rocTX instead")
3449 size_t sharedMem __dparm(0),
3489 size_t sharedMemBytes __dparm(0),
3537 const
void* dev_ptr,
3557 size_t num_attributes,
3558 const
void* dev_ptr,
3574 hipDeviceptr_t* dev_ptr,
3575 size_t length __dparm(0),
3578 #if __HIP_ROCclr__ || !defined(__HCC__)
3580 hipError_t hipExtLaunchKernel(
const void* function_address,
dim3 numBlocks,
dim3 dimBlocks,
3581 void** args,
size_t sharedMemBytes,
hipStream_t stream,
3584 DEPRECATED(DEPRECATED_MSG)
3585 hipError_t hipBindTexture(
3590 size_t size __dparm(UINT_MAX));
3592 DEPRECATED(DEPRECATED_MSG)
3593 hipError_t hipBindTexture2D(
3602 DEPRECATED(DEPRECATED_MSG)
3603 hipError_t hipBindTextureToArray(
3608 hipError_t hipBindTextureToMipmappedArray(
3613 DEPRECATED(DEPRECATED_MSG)
3614 hipError_t hipGetTextureAlignmentOffset(
3618 hipError_t hipGetTextureReference(
3620 const void* symbol);
3622 DEPRECATED(DEPRECATED_MSG)
3625 hipError_t hipCreateTextureObject(
3626 hipTextureObject_t* pTexObject,
3631 hipError_t hipDestroyTextureObject(hipTextureObject_t textureObject);
3633 hipError_t hipGetChannelDesc(
3637 hipError_t hipGetTextureObjectResourceDesc(
3639 hipTextureObject_t textureObject);
3641 hipError_t hipGetTextureObjectResourceViewDesc(
3643 hipTextureObject_t textureObject);
3645 hipError_t hipGetTextureObjectTextureDesc(
3647 hipTextureObject_t textureObject);
3649 hipError_t hipTexRefGetAddress(
3650 hipDeviceptr_t* dev_ptr,
3653 hipError_t hipTexRefGetAddressMode(
3654 enum hipTextureAddressMode* pam,
3658 hipError_t hipTexRefGetFilterMode(
3659 enum hipTextureFilterMode* pfm,
3662 hipError_t hipTexRefGetFlags(
3663 unsigned int* pFlags,
3666 hipError_t hipTexRefGetFormat(
3667 hipArray_Format* pFormat,
3671 hipError_t hipTexRefGetMaxAnisotropy(
3675 hipError_t hipTexRefGetMipmapFilterMode(
3676 enum hipTextureFilterMode* pfm,
3679 hipError_t hipTexRefGetMipmapLevelBias(
3683 hipError_t hipTexRefGetMipmapLevelClamp(
3684 float* pminMipmapLevelClamp,
3685 float* pmaxMipmapLevelClamp,
3688 hipError_t hipTexRefGetMipMappedArray(
3692 hipError_t hipTexRefSetAddress(
3695 hipDeviceptr_t dptr,
3698 hipError_t hipTexRefSetAddress2D(
3701 hipDeviceptr_t dptr,
3704 hipError_t hipTexRefSetAddressMode(
3707 enum hipTextureAddressMode am);
3709 hipError_t hipTexRefSetArray(
3712 unsigned int flags);
3714 hipError_t hipTexRefSetBorderColor(
3716 float* pBorderColor);
3718 hipError_t hipTexRefSetFilterMode(
3720 enum hipTextureFilterMode fm);
3722 hipError_t hipTexRefSetFlags(
3724 unsigned int Flags);
3726 hipError_t hipTexRefSetFormat(
3728 hipArray_Format fmt,
3729 int NumPackedComponents);
3731 hipError_t hipTexRefSetMaxAnisotropy(
3733 unsigned int maxAniso);
3735 hipError_t hipTexRefSetMipmapFilterMode(
3737 enum hipTextureFilterMode fm);
3739 hipError_t hipTexRefSetMipmapLevelBias(
3743 hipError_t hipTexRefSetMipmapLevelClamp(
3745 float minMipMapLevelClamp,
3746 float maxMipMapLevelClamp);
3748 hipError_t hipTexRefSetMipmappedArray(
3751 unsigned int Flags);
3753 hipError_t hipMipmappedArrayCreate(
3756 unsigned int numMipmapLevels);
3758 hipError_t hipMipmappedArrayDestroy(
3761 hipError_t hipMipmappedArrayGetLevel(
3764 unsigned int level);
3766 hipError_t hipTexObjectCreate(
3767 hipTextureObject_t* pTexObject,
3772 hipError_t hipTexObjectDestroy(
3773 hipTextureObject_t texObject);
3775 hipError_t hipTexObjectGetResourceDesc(
3777 hipTextureObject_t texObject);
3779 hipError_t hipTexObjectGetResourceViewDesc(
3781 hipTextureObject_t texObject);
3783 hipError_t hipTexObjectGetTextureDesc(
3785 hipTextureObject_t texObject);
3797 #if defined(__cplusplus) && !defined(__HCC__) && defined(__clang__) && defined(__HIP__)
3798 template <
typename T>
3800 T f,
size_t dynSharedMemPerBlk = 0,
int blockSizeLimit = 0) {
3804 template <
typename T>
3805 static hipError_t
__host__ inline hipOccupancyMaxPotentialBlockSizeWithFlags(
int* gridSize,
int* blockSize,
3806 T f,
size_t dynSharedMemPerBlk = 0,
int blockSizeLimit = 0,
unsigned int flags = 0 ) {
3809 #endif // defined(__cplusplus) && !defined(__HCC__) && defined(__clang__) && defined(__HIP__)
3811 #if defined(__cplusplus) && !defined(__HCC__)
3813 template <
typename T>
3814 hipError_t hipGetSymbolAddress(
void** devPtr,
const T &symbol) {
3815 return ::hipGetSymbolAddress(devPtr, (
const void *)&symbol);
3818 template <
typename T>
3819 hipError_t hipGetSymbolSize(
size_t* size,
const T &symbol) {
3820 return ::hipGetSymbolSize(size, (
const void *)&symbol);
3823 template <
typename T>
3824 hipError_t hipMemcpyToSymbol(
const T& symbol,
const void* src,
size_t sizeBytes,
3825 size_t offset __dparm(0),
3826 hipMemcpyKind kind __dparm(hipMemcpyHostToDevice)) {
3827 return ::hipMemcpyToSymbol((
const void*)&symbol, src, sizeBytes, offset, kind);
3830 template <
typename T>
3831 hipError_t hipMemcpyToSymbolAsync(
const T& symbol,
const void* src,
size_t sizeBytes,
size_t offset,
3832 hipMemcpyKind kind,
hipStream_t stream __dparm(0)) {
3833 return ::hipMemcpyToSymbolAsync((
const void*)&symbol, src, sizeBytes, offset, kind, stream);
3836 template <
typename T>
3837 hipError_t hipMemcpyFromSymbol(
void* dst,
const T &symbol,
3838 size_t sizeBytes,
size_t offset __dparm(0),
3839 hipMemcpyKind kind __dparm(hipMemcpyDeviceToHost)) {
3840 return ::hipMemcpyFromSymbol(dst, (
const void*)&symbol, sizeBytes, offset, kind);
3843 template <
typename T>
3844 hipError_t hipMemcpyFromSymbolAsync(
void* dst,
const T& symbol,
size_t sizeBytes,
size_t offset,
3845 hipMemcpyKind kind,
hipStream_t stream __dparm(0)) {
3846 return ::hipMemcpyFromSymbolAsync(dst, (
const void*)&symbol, sizeBytes, offset, kind, stream);
3852 #include <hip/hcc_detail/hip_prof_str.h>
3862 hipError_t hipRemoveApiCallback(uint32_t
id);
3863 hipError_t hipRegisterActivityCallback(uint32_t
id,
void* fun,
void* arg);
3864 hipError_t hipRemoveActivityCallback(uint32_t
id);
3865 const char* hipApiName(uint32_t
id);
3867 const char* hipKernelNameRefByPtr(
const void* hostFunction,
hipStream_t stream);
3877 int* numBlocks, T f,
int blockSize,
size_t dynSharedMemPerBlk) {
3879 numBlocks,
reinterpret_cast<const void*
>(f), blockSize, dynSharedMemPerBlk);
3884 int* numBlocks, T f,
int blockSize,
size_t dynSharedMemPerBlk,
unsigned int flags) {
3886 numBlocks,
reinterpret_cast<const void*
>(f), blockSize, dynSharedMemPerBlk, flags);
3892 DEPRECATED(DEPRECATED_MSG)
3893 hipError_t hipBindTexture(
size_t* offset,
textureReference* tex,
const void* devPtr,
3898 hipError_t ihipBindTextureImpl(
TlsData *tls,
int dim,
enum hipTextureReadMode readMode,
size_t* offset,
3919 template <
class T,
int dim, enum hipTextureReadMode readMode>
3920 DEPRECATED(DEPRECATED_MSG)
3921 hipError_t hipBindTexture(
size_t* offset,
struct texture<T, dim, readMode>& tex,
const void* devPtr,
3923 return ihipBindTextureImpl(
nullptr, dim, readMode, offset, devPtr, &desc, size, &tex);
3942 template <
class T,
int dim, enum hipTextureReadMode readMode>
3943 DEPRECATED(DEPRECATED_MSG)
3944 hipError_t hipBindTexture(
size_t* offset,
struct texture<T, dim, readMode>& tex,
const void* devPtr,
3945 size_t size = UINT_MAX) {
3946 return ihipBindTextureImpl(
nullptr, dim, readMode, offset, devPtr, &(tex.channelDesc), size, &tex);
3952 DEPRECATED(DEPRECATED_MSG)
3953 hipError_t hipBindTexture2D(
size_t* offset,
textureReference* tex,
const void* devPtr,
3959 hipError_t ihipBindTexture2DImpl(
int dim,
enum hipTextureReadMode readMode,
size_t* offset,
3965 template <
class T,
int dim, enum hipTextureReadMode readMode>
3966 DEPRECATED(DEPRECATED_MSG)
3967 hipError_t hipBindTexture2D(
size_t* offset,
struct texture<T, dim, readMode>& tex,
3968 const void* devPtr,
size_t width,
size_t height,
size_t pitch) {
3969 return ihipBindTexture2DImpl(dim, readMode, offset, devPtr, &(tex.channelDesc), width, height,
3975 template <
class T,
int dim, enum hipTextureReadMode readMode>
3976 DEPRECATED(DEPRECATED_MSG)
3977 hipError_t hipBindTexture2D(
size_t* offset,
struct texture<T, dim, readMode>& tex,
3979 size_t width,
size_t height,
size_t pitch) {
3980 return ihipBindTexture2DImpl(dim, readMode, offset, devPtr, &desc, width, height, &tex);
3986 DEPRECATED(DEPRECATED_MSG)
3992 hipError_t ihipBindTextureToArrayImpl(
TlsData *tls,
int dim,
enum hipTextureReadMode readMode,
3999 template <
class T,
int dim, enum hipTextureReadMode readMode>
4000 DEPRECATED(DEPRECATED_MSG)
4001 hipError_t hipBindTextureToArray(
struct texture<T, dim, readMode>& tex,
hipArray_const_t array) {
4002 return ihipBindTextureToArrayImpl(
nullptr, dim, readMode, array, tex.channelDesc, &tex);
4007 template <
class T,
int dim, enum hipTextureReadMode readMode>
4008 DEPRECATED(DEPRECATED_MSG)
4009 hipError_t hipBindTextureToArray(
struct texture<T, dim, readMode>& tex,
hipArray_const_t array,
4011 return ihipBindTextureToArrayImpl(
nullptr, dim, readMode, array, desc, &tex);
4016 template <
class T,
int dim, enum hipTextureReadMode readMode>
4017 DEPRECATED(DEPRECATED_MSG)
4018 inline static hipError_t hipBindTextureToArray(
struct texture<T, dim, readMode> *tex,
4021 return ihipBindTextureToArrayImpl(
nullptr, dim, readMode, array, *desc, tex);
4033 template <
class T,
int dim, enum hipTextureReadMode readMode>
4034 hipError_t hipBindTextureToMipmappedArray(
const texture<T, dim, readMode>& tex,
4041 template <
class T,
int dim, enum hipTextureReadMode readMode>
4042 hipError_t hipBindTextureToMipmappedArray(
const texture<T, dim, readMode>& tex,
4049 #if __HIP_ROCclr__ && !defined(__HCC__)
4051 template <
typename F>
4053 F kernel,
size_t dynSharedMemPerBlk, uint32_t blockSizeLimit) {
4058 inline hipError_t hipLaunchCooperativeKernel(T f,
dim3 gridDim,
dim3 blockDim,
4059 void** kernelParams,
unsigned int sharedMemBytes,
hipStream_t stream) {
4060 return hipLaunchCooperativeKernel(
reinterpret_cast<const void*
>(f), gridDim,
4061 blockDim, kernelParams, sharedMemBytes, stream);
4065 inline hipError_t hipLaunchCooperativeKernelMultiDevice(
hipLaunchParams* launchParamsList,
4066 unsigned int numDevices,
unsigned int flags = 0) {
4067 return hipLaunchCooperativeKernelMultiDevice(launchParamsList, numDevices, flags);
4073 unsigned int numDevices,
unsigned int flags = 0) {
4087 DEPRECATED(DEPRECATED_MSG)
4092 extern hipError_t ihipUnbindTextureImpl(
const hipTextureObject_t& textureObject);
4096 template <
class T,
int dim, enum hipTextureReadMode readMode>
4097 DEPRECATED(DEPRECATED_MSG)
4098 hipError_t hipUnbindTexture(
struct texture<T, dim, readMode>& tex) {
4099 return ihipUnbindTextureImpl(tex.textureObject);
4106 DEPRECATED(DEPRECATED_MSG)
4107 hipError_t hipGetTextureAlignmentOffset(
size_t* offset,
const textureReference* texref);
4109 hipError_t hipGetTextureReference(
const textureReference** texref,
const void* symbol);
4111 hipError_t hipCreateTextureObject(hipTextureObject_t* pTexObject,
const hipResourceDesc* pResDesc,
4115 hipError_t hipDestroyTextureObject(hipTextureObject_t textureObject);
4118 hipTextureObject_t textureObject);
4120 hipTextureObject_t textureObject);
4121 hipError_t hipGetTextureObjectTextureDesc(
hipTextureDesc* pTexDesc,
4122 hipTextureObject_t textureObject);
4127 hipError_t hipTexRefSetAddressMode(
textureReference* tex,
int dim, hipTextureAddressMode am);
4129 hipError_t hipTexRefGetAddressMode(hipTextureAddressMode* am,
textureReference tex,
int dim);
4131 hipError_t hipTexRefSetFilterMode(
textureReference* tex, hipTextureFilterMode fm);
4135 hipError_t hipTexRefSetFormat(
textureReference* tex, hipArray_Format fmt,
int NumPackedComponents);
4137 hipError_t hipTexRefSetAddress(
size_t* offset,
textureReference* tex, hipDeviceptr_t devPtr,
4140 hipError_t hipTexRefGetAddress(hipDeviceptr_t* dev_ptr,
textureReference tex);
4143 hipDeviceptr_t devPtr,
size_t pitch);
4151 template <
class T,
int dim, enum hipTextureReadMode readMode>
4152 DEPRECATED(DEPRECATED_MSG)
4153 static inline hipError_t hipBindTexture(
size_t* offset,
const struct texture<T, dim, readMode>& tex,
4154 const void* devPtr,
size_t size = UINT_MAX) {
4155 return hipBindTexture(offset, &tex, devPtr, &tex.channelDesc, size);
4158 template <
class T,
int dim, enum hipTextureReadMode readMode>
4159 DEPRECATED(DEPRECATED_MSG)
4160 static inline hipError_t
4161 hipBindTexture(
size_t* offset,
const struct texture<T, dim, readMode>& tex,
const void* devPtr,
4163 return hipBindTexture(offset, &tex, devPtr, &desc, size);
4166 template<
class T,
int dim, enum hipTextureReadMode readMode>
4167 DEPRECATED(DEPRECATED_MSG)
4168 static inline hipError_t hipBindTexture2D(
4170 const struct texture<T, dim, readMode> &tex,
4176 return hipBindTexture2D(offset, &tex, devPtr, &tex.channelDesc, width, height, pitch);
4179 template<
class T,
int dim, enum hipTextureReadMode readMode>
4180 DEPRECATED(DEPRECATED_MSG)
4181 static inline hipError_t hipBindTexture2D(
4183 const struct texture<T, dim, readMode> &tex,
4190 return hipBindTexture2D(offset, &tex, devPtr, &desc, width, height, pitch);
4193 template<
class T,
int dim, enum hipTextureReadMode readMode>
4194 DEPRECATED(DEPRECATED_MSG)
4195 static inline hipError_t hipBindTextureToArray(
4196 const struct texture<T, dim, readMode> &tex,
4200 hipError_t err = hipGetChannelDesc(&desc, array);
4201 return (err ==
hipSuccess) ? hipBindTextureToArray(&tex, array, &desc) : err;
4204 template<
class T,
int dim, enum hipTextureReadMode readMode>
4205 DEPRECATED(DEPRECATED_MSG)
4206 static inline hipError_t hipBindTextureToArray(
4207 const struct texture<T, dim, readMode> &tex,
4211 return hipBindTextureToArray(&tex, array, &desc);
4214 template<
class T,
int dim, enum hipTextureReadMode readMode>
4215 static inline hipError_t hipBindTextureToMipmappedArray(
4216 const struct texture<T, dim, readMode> &tex,
4225 err = hipGetChannelDesc(&desc, levelArray);
4226 return (err ==
hipSuccess) ? hipBindTextureToMipmappedArray(&tex, mipmappedArray, &desc) : err;
4229 template<
class T,
int dim, enum hipTextureReadMode readMode>
4230 static inline hipError_t hipBindTextureToMipmappedArray(
4231 const struct texture<T, dim, readMode> &tex,
4235 return hipBindTextureToMipmappedArray(&tex, mipmappedArray, &desc);
4238 template<
class T,
int dim, enum hipTextureReadMode readMode>
4239 DEPRECATED(DEPRECATED_MSG)
4240 static inline hipError_t hipUnbindTexture(
4241 const struct texture<T, dim, readMode> &tex)
4243 return hipUnbindTexture(&tex);
4256 #pragma GCC visibility pop
Definition: hip_runtime_api.h:128
hipError_t hipCtxSynchronize(void)
Blocks until the default context has completed all preceding requested tasks.
Definition: hip_context.cpp:249
hipError_t hipPointerGetAttributes(hipPointerAttribute_t *attributes, const void *ptr)
Return attributes for the specified pointer.
Definition: hip_memory.cpp:617
hipError_t hipMemset3DAsync(hipPitchedPtr pitchedDevPtr, int value, hipExtent extent, hipStream_t stream __dparm(0))
Fills asynchronously the memory area pointed to by pitchedDevPtr with the constant value.
hipError_t hipMemcpy3D(const struct hipMemcpy3DParms *p)
Copies data between host and device.
Definition: hip_memory.cpp:1712
hipError_t hipMemRangeGetAttributes(void **data, size_t *data_sizes, hipMemRangeAttribute *attributes, size_t num_attributes, const void *dev_ptr, size_t count)
Query attributes of a given memory range in AMD HMM.
hipError_t hipCtxGetCurrent(hipCtx_t *ctx)
Get the handle of the current/ default context.
Definition: hip_context.cpp:167
hipError_t hipMallocPitch(void **ptr, size_t *pitch, size_t width, size_t height)
Definition: hip_memory.cpp:851
hipError_t hipSetDevice(int deviceId)
Set default device to be used for subsequent hip API calls from this thread.
Definition: hip_device.cpp:132
hipError_t hipDeviceGetP2PAttribute(int *value, hipDeviceP2PAttr attr, int srcDevice, int dstDevice)
Returns a value for attr of link between two devices.
hipError_t hipMemsetD16Async(hipDeviceptr_t dest, unsigned short value, size_t count, hipStream_t stream __dparm(0))
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant short value v...
hipError_t hipMemcpy2DFromArrayAsync(void *dst, size_t dpitch, hipArray_const_t src, size_t wOffset, size_t hOffset, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream __dparm(0))
Copies data between host and device asynchronously.
const char * hipGetErrorString(hipError_t hipError)
Return handy text string message to explain the error which occurred.
Definition: hip_error.cpp:54
hipError_t hipGetDeviceFlags(unsigned int *flags)
Gets the flags set for current device.
hipError_t hipDeviceGetByPCIBusId(int *device, const char *pciBusId)
Returns a handle to a compute device.
Definition: hip_device.cpp:492
hipError_t hipMalloc3DArray(hipArray **array, const struct hipChannelFormatDesc *desc, struct hipExtent extent, unsigned int flags)
Allocate an array on the device.
Definition: hip_memory.cpp:1091
hipError_t hipChooseDevice(int *device, const hipDeviceProp_t *prop)
Device which matches hipDeviceProp_t is returned.
Definition: hip_device.cpp:518
hipError_t hipIpcCloseMemHandle(void *devPtr)
Close memory mapped with hipIpcOpenMemHandle.
Definition: hip_memory.cpp:2539
hipError_t hipMemcpy2DAsync(void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream __dparm(0))
Copies data between host and device.
hipError_t hipLaunchKernel(const void *function_address, dim3 numBlocks, dim3 dimBlocks, void **args, size_t sharedMemBytes __dparm(0), hipStream_t stream __dparm(0))
C compliant kernel launch API.
hipError_t hipMemsetD32(hipDeviceptr_t dest, int value, size_t count)
Fills the memory area pointed to by dest with the constant integer value for specified number of time...
Definition: hip_memory.cpp:2281
Definition: hip_hcc_internal.h:408
hipError_t hipStreamCreate(hipStream_t *stream)
Create an asynchronous stream.
Definition: hip_stream.cpp:106
hipError_t hipOccupancyMaxActiveBlocksPerMultiprocessorWithFlags(int *numBlocks, const void *f, int blockSize, size_t dynSharedMemPerBlk, unsigned int flags __dparm(hipOccupancyDefault))
Returns occupancy for a device function.
hipError_t hipDeviceGetStreamPriorityRange(int *leastPriority, int *greatestPriority)
Returns numerical values that correspond to the least and greatest stream priority.
Definition: hip_stream.cpp:122
Definition: hip_runtime_api.h:120
@ hipMemAdviseSetPreferredLocation
Definition: hip_runtime_api.h:247
hipError_t hipStreamCreateWithPriority(hipStream_t *stream, unsigned int flags, int priority)
Create an asynchronous stream with the specified priority.
Definition: hip_stream.cpp:113
hipError_t hipCtxPushCurrent(hipCtx_t ctx)
Push the context to be set as current/ default context.
Definition: hip_context.cpp:154
hipError_t hipCtxGetDevice(hipDevice_t *device)
Get the handle of the device associated with current/default context.
Definition: hip_context.cpp:191
hipFuncCache_t
Definition: hip_runtime_api.h:308
Definition: hip_hcc_internal.h:185
hipError_t hipPeekAtLastError(void)
Return last error returned by any HIP runtime API call.
Definition: hip_error.cpp:41
hipError_t hipMemcpy3DAsync(const struct hipMemcpy3DParms *p, hipStream_t stream __dparm(0))
Copies data between host and device asynchronously.
hipError_t hipDeviceGetPCIBusId(char *pciBusId, int len, int device)
Returns a PCI Bus Id string for the device, overloaded to take int device ID.
Definition: hip_device.cpp:460
hipError_t hipHostGetFlags(unsigned int *flagsPtr, void *hostPtr)
Return flags associated with host pointer.
Definition: hip_memory.cpp:1133
hipError_t hipMemGetAddressRange(hipDeviceptr_t *pbase, size_t *psize, hipDeviceptr_t dptr)
Get information on memory allocations.
Definition: hip_memory.cpp:2437
hipError_t hipExtLaunchMultiKernelMultiDevice(hipLaunchParams *launchParamsList, int numDevices, unsigned int flags)
Launches kernels on multiple devices and guarantees all specified kernels are dispatched on respectiv...
unsigned long long hipSurfaceObject_t
Definition: hip_surface_types.h:36
hipError_t hipStreamWaitEvent(hipStream_t stream, hipEvent_t event, unsigned int flags)
Make the specified compute stream wait for an event.
Definition: hip_stream.cpp:130
@ hipFuncCachePreferEqual
prefer equal size L1 cache and shared memory
Definition: hip_runtime_api.h:312
hipError_t hipGetDevice(int *deviceId)
Return the default device id for the calling host thread.
Definition: hip_device.cpp:32
hipError_t hipModuleOccupancyMaxPotentialBlockSizeWithFlags(int *gridSize, int *blockSize, hipFunction_t f, size_t dynSharedMemPerBlk, int blockSizeLimit, unsigned int flags)
determine the grid and block sizes to achieves maximum occupancy for a kernel
Definition: hip_module.cpp:1672
hipError_t hipMallocArray(hipArray **array, const hipChannelFormatDesc *desc, size_t width, size_t height __dparm(0), unsigned int flags __dparm(hipArrayDefault))
Allocate an array on the device.
hipError_t hipMemcpyToArray(hipArray *dst, size_t wOffset, size_t hOffset, const void *src, size_t count, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:1494
hipError_t hipModuleLoadData(hipModule_t *module, const void *image)
builds module from code object which resides in host memory. Image is pointer to that location.
Definition: hip_module.cpp:1508
Definition: driver_types.h:394
hipError_t hipMemcpyDtoDAsync(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream)
Copy data from Device to Device asynchronously.
Definition: hip_memory.cpp:1429
hipError_t hipModuleLaunchKernel(hipFunction_t f, unsigned int gridDimX, unsigned int gridDimY, unsigned int gridDimZ, unsigned int blockDimX, unsigned int blockDimY, unsigned int blockDimZ, unsigned int sharedMemBytes, hipStream_t stream, void **kernelParams, void **extra)
launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelp...
hipError_t hipMemcpy2DFromArray(void *dst, size_t dpitch, hipArray_const_t src, size_t wOffset, size_t hOffset, size_t width, size_t height, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:2154
hipError_t hipDevicePrimaryCtxRelease(hipDevice_t dev)
Release the primary context on the GPU.
Definition: hip_context.cpp:285
hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int *apiVersion)
Returns the approximate HIP api version.
Definition: hip_context.cpp:207
hipError_t hipHostMalloc(void **ptr, size_t size, unsigned int flags)
Allocate device accessible page locked host memory.
Definition: hip_memory.cpp:762
uint32_t y
y
Definition: hip_runtime_api.h:332
hipError_t hipDeviceGetName(char *name, int len, hipDevice_t device)
Returns an identifer string for the device.
Definition: hip_device.cpp:446
hipError_t hipMemcpyParam2DAsync(const hip_Memcpy2D *pCopy, hipStream_t stream __dparm(0))
Copies memory for 2D arrays.
hipError_t hipModuleUnload(hipModule_t module)
Frees the module.
Definition: hip_module.cpp:1244
hipError_t hipDeviceEnablePeerAccess(int peerDeviceId, unsigned int flags)
Enable direct access from current device's virtual address space to memory allocations physically loc...
Definition: hip_peer.cpp:200
hipError_t hipMallocMipmappedArray(hipMipmappedArray_t *mipmappedArray, const struct hipChannelFormatDesc *desc, struct hipExtent extent, unsigned int numLevels, unsigned int flags __dparm(0))
Allocate a mipmapped array on the device.
hipSharedMemConfig
Definition: hip_runtime_api.h:318
hipError_t hipDrvMemcpy3D(const HIP_MEMCPY3D *pCopy)
Copies data between host and device.
uint32_t x
x
Definition: hip_runtime_api.h:331
hipError_t hipFuncGetAttribute(int *value, hipFunction_attribute attrib, hipFunction_t hfunc)
Find out a specific attribute for a given function.
Definition: hip_module.cpp:1427
hipError_t hipDeviceComputeCapability(int *major, int *minor, hipDevice_t device)
Returns the compute capability of the device.
Definition: hip_device.cpp:434
hipError_t hipModuleOccupancyMaxPotentialBlockSize(int *gridSize, int *blockSize, hipFunction_t f, size_t dynSharedMemPerBlk, int blockSizeLimit)
determine the grid and block sizes to achieves maximum occupancy for a kernel
Definition: hip_module.cpp:1662
void(* hipStreamCallback_t)(hipStream_t stream, hipError_t status, void *userData)
Definition: hip_runtime_api.h:972
hipMemoryAdvise
Definition: hip_runtime_api.h:243
Definition: driver_types.h:91
hipError_t hipGetMipmappedArrayLevel(hipArray_t *levelArray, hipMipmappedArray_const_t mipmappedArray, unsigned int level)
Gets a mipmap level of a HIP mipmapped array.
hipError_t hipCtxGetFlags(unsigned int *flags)
Return flags used for creating default context.
Definition: hip_context.cpp:254
hipError_t __hipPushCallConfiguration(dim3 gridDim, dim3 blockDim, size_t sharedMem __dparm(0), hipStream_t stream __dparm(0))
Push configuration of a kernel launch.
hipError_t hipDevicePrimaryCtxGetState(hipDevice_t dev, unsigned int *flags, int *active)
Get the state of the primary context.
Definition: hip_context.cpp:263
hipError_t hipDeviceSetCacheConfig(hipFuncCache_t cacheConfig)
Set L1/Shared cache partition.
Definition: hip_device.cpp:74
hipError_t hipCtxDestroy(hipCtx_t ctx)
Destroy a HIP context.
Definition: hip_context.cpp:109
hipError_t hipCtxEnablePeerAccess(hipCtx_t peerCtx, unsigned int flags)
Enables direct access to memory allocations in a peer context.
Definition: hip_peer.cpp:221
hipError_t hipMemcpyAtoH(void *dst, hipArray *srcArray, size_t srcOffset, size_t count)
Copies data between host and device.
Definition: hip_memory.cpp:1544
hipError_t hipGetDeviceCount(int *count)
Return number of compute-capable devices.
Definition: hip_device.cpp:69
hipSuccess
Successful completion.
Definition: hip_runtime_api.h:203
hipError_t hipSetupArgument(const void *arg, size_t size, size_t offset)
Set a kernel argument.
Definition: hip_clang.cpp:467
hipError_t hipHostUnregister(void *hostPtr)
Un-register host pointer.
Definition: hip_memory.cpp:1233
hipError_t hipStreamGetFlags(hipStream_t stream, unsigned int *flags)
Return flags associated with this stream.
Definition: hip_stream.cpp:223
hipError_t hipMemsetD8Async(hipDeviceptr_t dest, unsigned char value, size_t count, hipStream_t stream __dparm(0))
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value va...
hipError_t hipExtStreamCreateWithCUMask(hipStream_t *stream, uint32_t cuMaskSize, const uint32_t *cuMask)
Create an asynchronous stream with the specified CU mask.
hipError_t hipStreamSynchronize(hipStream_t stream)
Wait for all commands in stream to complete.
Definition: hip_stream.cpp:184
const char * hipGetErrorName(hipError_t hip_error)
Return name of the specified error code in text form.
Definition: hip_error.cpp:48
hipError_t hipDeviceGet(hipDevice_t *device, int ordinal)
Returns a handle to a compute device.
Definition: hip_context.cpp:70
#define __host__
Definition: host_defines.h:41
hipError_t hipMemcpyDtoD(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes)
Copy data from Device to Device.
Definition: hip_memory.cpp:1390
Definition: driver_types.h:383
hipError_t hipMallocManaged(void **dev_ptr, size_t size, unsigned int flags __dparm(hipMemAttachGlobal))
Allocates memory that will be automatically managed by AMD HMM.
hipError_t hipMemcpyHtoD(hipDeviceptr_t dst, void *src, size_t sizeBytes)
Copy data from Host to Device.
Definition: hip_memory.cpp:1374
hipError_t hipDriverGetVersion(int *driverVersion)
Returns the approximate HIP driver version.
Definition: hip_context.cpp:85
hipError_t hipMemcpy2DToArray(hipArray *dst, size_t wOffset, size_t hOffset, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:1444
hipError_t hipMemAllocPitch(hipDeviceptr_t *dptr, size_t *pitch, size_t widthInBytes, size_t height, unsigned int elementSizeBytes)
Definition: hip_memory.cpp:862
Definition: hip_runtime_api.h:84
hipError_t hipMemAllocHost(void **ptr, size_t size)
Allocate pinned host memory [Deprecated].
Definition: hip_runtime_api.h:881
hipError_t hipMallocHost(void **ptr, size_t size)
Allocate pinned host memory [Deprecated].
Definition: hip_runtime_api.h:875
hipError_t hipFuncSetCacheConfig(const void *func, hipFuncCache_t config)
Set Cache configuration for a specific function.
Definition: hip_device.cpp:108
Defines surface types for HIP runtime.
hipError_t hipMemsetD32Async(hipDeviceptr_t dst, int value, size_t count, hipStream_t stream __dparm(0))
Fills the memory area pointed to by dev with the constant integer value for specified number of times...
hipError_t hipRuntimeGetVersion(int *runtimeVersion)
Returns the approximate HIP Runtime version.
Definition: hip_context.cpp:97
hipError_t hipConfigureCall(dim3 gridDim, dim3 blockDim, size_t sharedMem __dparm(0), hipStream_t stream __dparm(0))
Configure a kernel launch.
hipError_t hipEventQuery(hipEvent_t event)
Query event status.
Definition: hip_event.cpp:394
Definition: hip_hcc_internal.h:938
hipError_t hipStreamGetPriority(hipStream_t stream, int *priority)
Query the priority of a stream.
Definition: hip_stream.cpp:238
@ hipSharedMemBankSizeFourByte
Definition: hip_runtime_api.h:320
hipError_t hipEventSynchronize(hipEvent_t event)
Wait for an event to complete.
Definition: hip_event.cpp:300
@ hipFuncCachePreferNone
no preference for shared memory or L1 (default)
Definition: hip_runtime_api.h:309
hipError_t hipOccupancyMaxActiveBlocksPerMultiprocessor(int *numBlocks, const void *f, int blockSize, size_t dynSharedMemPerBlk)
Returns occupancy for a device function.
Definition: hip_module.cpp:1683
hipError_t hipHostFree(void *ptr)
Free memory allocated by the hcc hip host memory allocation API This API performs an implicit hipDevi...
Definition: hip_memory.cpp:2396
hipError_t hipIpcOpenMemHandle(void **devPtr, hipIpcMemHandle_t handle, unsigned int flags)
Opens an interprocess memory handle exported from another process and returns a device pointer usable...
Definition: hip_memory.cpp:2494
hipError_t hipMemsetD16(hipDeviceptr_t dest, unsigned short value, size_t count)
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant short value v...
Definition: hip_memory.cpp:2271
Definition: driver_types.h:116
Definition: hip_hcc_internal.h:759
@ hipMemRangeAttributeAccessedBy
Definition: hip_runtime_api.h:265
hipError_t hipDeviceGetLimit(size_t *pValue, enum hipLimit_t limit)
Get Resource limits of current device.
Definition: hip_device.cpp:94
void ** args
Arguments.
Definition: hip_runtime_api.h:343
hipError_t hipMalloc(void **ptr, size_t size)
Allocate memory on the default accelerator.
Definition: hip_memory.cpp:695
hipError_t hipMemPrefetchAsync(const void *dev_ptr, size_t count, int device, hipStream_t stream __dparm(0))
Prefetches memory to the specified destination device using AMD HMM.
Definition: hip_runtime_api.h:111
hipError_t hipEventElapsedTime(float *ms, hipEvent_t start, hipEvent_t stop)
Return the elapsed time between two events.
Definition: hip_event.cpp:344
hipError_t hipInit(unsigned int flags)
Explicitly initializes the HIP runtime.
Definition: hip_context.cpp:39
hipError_t hipGetLastError(void)
Return last error returned by any HIP runtime API call and resets the stored error code to hipSuccess...
Definition: hip_error.cpp:32
Definition: hip_hcc_internal.h:580
Definition: driver_types.h:166
Definition: driver_types.h:78
hipError_t hipIpcGetMemHandle(hipIpcMemHandle_t *handle, void *devPtr)
Gets an interprocess memory handle for an existing device memory allocation.
Definition: hip_memory.cpp:2458
hipError_t hipCtxDisablePeerAccess(hipCtx_t peerCtx)
Disable direct access from current context's virtual address space to memory allocations physically l...
Definition: hip_peer.cpp:227
hipError_t hipHostGetDevicePointer(void **devPtr, void *hstPtr, unsigned int flags)
Get Device pointer from Host Pointer allocated through hipHostMalloc.
hipError_t hipMemGetInfo(size_t *free, size_t *total)
Query memory info. Return snapshot of free memory, and total allocatable memory on the device.
Definition: hip_memory.cpp:2296
hipError_t hipEventDestroy(hipEvent_t event)
Destroy the specified event.
Definition: hip_event.cpp:278
hipError_t hipDeviceSetSharedMemConfig(hipSharedMemConfig config)
The bank width of shared memory on current device is set.
Definition: hip_device.cpp:116
hipError_t hipDeviceReset(void)
The state of current device is discarded and updated to a fresh state.
Definition: hip_device.cpp:148
hipError_t hipSetDeviceFlags(unsigned flags)
The current device behavior is changed according the flags passed.
Definition: driver_types.h:69
@ hipMemAdviseUnsetReadMostly
Undo the effect of hipMemAdviseSetReadMostly.
Definition: hip_runtime_api.h:246
Definition: hip_runtime_api.h:330
hipError_t hipStreamQuery(hipStream_t stream)
Return hipSuccess if all of the operations in the specified stream have completed,...
Definition: hip_stream.cpp:161
hipError_t hipLaunchByPtr(const void *func)
Launch a kernel.
Definition: hip_clang.cpp:485
hipError_t hipExtMallocWithFlags(void **ptr, size_t sizeBytes, unsigned int flags)
Allocate memory on the default accelerator.
Definition: hip_memory.cpp:723
hipError_t hipDevicePrimaryCtxSetFlags(hipDevice_t dev, unsigned int flags)
Set flags for the primary context.
Definition: hip_context.cpp:321
Definition: hip_runtime_api.h:168
hipError_t hipFree(void *ptr)
Free memory allocated by the hcc hip memory allocation API. This API performs an implicit hipDeviceSy...
Definition: hip_memory.cpp:2344
void * func
Device function symbol.
Definition: hip_runtime_api.h:340
#define hipArrayDefault
Default HIP array allocation flag.
Definition: hip_runtime_api.h:221
hipError_t hipDevicePrimaryCtxRetain(hipCtx_t *pctx, hipDevice_t dev)
Retain the primary context on the GPU.
Definition: hip_context.cpp:296
hipError_t hipOccupancyMaxPotentialBlockSize(int *gridSize, int *blockSize, const void *f, size_t dynSharedMemPerBlk, int blockSizeLimit)
determine the grid and block sizes to achieves maximum occupancy for a kernel
hipError_t hipModuleLoad(hipModule_t *module, const char *fname)
Loads code object from file into a hipModule_t.
Definition: hip_module.cpp:1513
hipError_t hipModuleOccupancyMaxActiveBlocksPerMultiprocessorWithFlags(int *numBlocks, hipFunction_t f, int blockSize, size_t dynSharedMemPerBlk, unsigned int flags)
Returns occupancy for a device function.
Definition: hip_module.cpp:1714
hipError_t hipFreeHost(void *ptr)
Free memory allocated by the hcc hip host memory allocation API. [Deprecated].
Definition: hip_runtime_api.h:932
hipError_t hipMemcpyHtoA(hipArray *dstArray, size_t dstOffset, const void *srcHost, size_t count)
Copies data between host and device.
Definition: hip_memory.cpp:1528
hipError_t hipModuleGetFunction(hipFunction_t *function, hipModule_t module, const char *kname)
Function with kname will be extracted if present in module.
Definition: hip_module.cpp:1309
hipError_t hipStreamAddCallback(hipStream_t stream, hipStreamCallback_t callback, void *userData, unsigned int flags)
Adds a callback to be called on the host after all currently enqueued items in the stream have comple...
Definition: hip_stream.cpp:258
hipStream_t stream
Stream identifier.
Definition: hip_runtime_api.h:345
hipError_t hipMemcpyDtoHAsync(void *dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream)
Copy data from Device to Host asynchronously.
Definition: hip_memory.cpp:1437
@ hipMemRangeAttributeReadMostly
Definition: hip_runtime_api.h:262
@ hipMemRangeAttributeLastPrefetchLocation
The last location to which the range was prefetched.
Definition: hip_runtime_api.h:267
hipError_t hipFuncGetAttributes(struct hipFuncAttributes *attr, const void *func)
Find out attributes for a given function.
Definition: hip_module.cpp:1393
hipError_t hipDrvMemcpy3DAsync(const HIP_MEMCPY3D *pCopy, hipStream_t stream)
Copies data between host and device asynchronously.
hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream)
Record an event in the specified stream.
Definition: hip_event.cpp:213
dim3 gridDim
Grid dimentions.
Definition: hip_runtime_api.h:341
hipError_t hipMemcpy2D(void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:2020
Definition: driver_types.h:370
Definition: driver_types.h:363
hipError_t hipModuleGetGlobal(void **, size_t *, hipModule_t, const char *)
returns device memory pointer and size of the kernel present in the module with symbol name
Definition: hip_module.cpp:1113
@ hipSharedMemBankSizeDefault
The compiler selects a device-specific value for the banking.
Definition: hip_runtime_api.h:319
hipError_t hipMemset2D(void *dst, size_t pitch, int value, size_t width, size_t height)
Fills the memory area pointed to by dst with the constant value.
Definition: hip_memory.cpp:2251
hipError_t hipMemset3D(hipPitchedPtr pitchedDevPtr, int value, hipExtent extent)
Fills synchronously the memory area pointed to by pitchedDevPtr with the constant value.
Definition: hip_memory.cpp:2286
hipError_t hipMemRangeGetAttribute(void *data, size_t data_size, hipMemRangeAttribute attribute, const void *dev_ptr, size_t count)
Query an attribute of a given memory range in AMD HMM.
hipError_t hipStreamCreateWithFlags(hipStream_t *stream, unsigned int flags)
Create an asynchronous stream.
Definition: hip_stream.cpp:97
hipError_t hipDeviceGetAttribute(int *pi, hipDeviceAttribute_t attr, int deviceId)
Query for a specific device attribute.
Definition: hip_device.cpp:354
hipError_t hipMemcpyFromArray(void *dst, hipArray_const_t srcArray, size_t wOffset, size_t hOffset, size_t count, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:1511
Definition: hip_module.cpp:108
hipError_t hipMemcpyPeerAsync(void *dst, int dstDeviceId, const void *src, int srcDevice, size_t sizeBytes, hipStream_t stream __dparm(0))
Copies memory from one device to memory on another device.
hipError_t hipMemcpyHtoDAsync(hipDeviceptr_t dst, void *src, size_t sizeBytes, hipStream_t stream)
Copy data from Host to Device asynchronously.
Definition: hip_memory.cpp:1422
hipError_t hipMemcpyDtoH(void *dst, hipDeviceptr_t src, size_t sizeBytes)
Copy data from Device to Host.
Definition: hip_memory.cpp:1382
hipError_t hipDeviceGetCacheConfig(hipFuncCache_t *cacheConfig)
Set Cache configuration for a specific function.
Definition: hip_device.cpp:82
hipError_t hipMemcpyPeer(void *dst, int dstDeviceId, const void *src, int srcDeviceId, size_t sizeBytes)
Copies memory from one device to memory on another device.
Definition: hip_peer.cpp:207
hipError_t hipMemAdvise(const void *dev_ptr, size_t count, hipMemoryAdvise advice, int device)
Advise about the usage of a given memory range to AMD HMM.
hipError_t hipFreeMipmappedArray(hipMipmappedArray_t mipmappedArray)
Frees a mipmapped array on the device.
hipError_t hipRegisterApiCallback(uint32_t id, void *fun, void *arg)
Definition: hip_intercept.cpp:33
hipError_t hipGetDeviceProperties(hipDeviceProp_t *prop, int deviceId)
Returns device properties.
Definition: hip_device.cpp:381
hipError_t hipMemcpy(void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind)
Copy data from src to dst.
Definition: hip_memory.cpp:1367
hipError_t hipEventCreateWithFlags(hipEvent_t *event, unsigned flags)
Create an event with the specified flags.
Definition: hip_event.cpp:201
@ hipMemAdviseUnsetAccessedBy
Definition: hip_runtime_api.h:252
hipError_t hipCtxGetSharedMemConfig(hipSharedMemConfig *pConfig)
Get Shared memory bank configuration.
Definition: hip_context.cpp:241
hipError_t hipDeviceTotalMem(size_t *bytes, hipDevice_t device)
Returns the total amount of memory on the device.
Definition: hip_device.cpp:480
hipError_t hipFreeArray(hipArray *array)
Frees an array on the device.
Definition: hip_memory.cpp:2409
Defines the different newt vector types for HIP runtime.
Definition: texture_types.h:74
hipError_t hipCtxPopCurrent(hipCtx_t *ctx)
Pop the current/default context and return the popped context.
Definition: hip_context.cpp:133
hipError_t hipDeviceCanAccessPeer(int *canAccessPeer, int deviceId, int peerDeviceId)
Determine if a device can access a peer's memory.
Definition: hip_peer.cpp:186
@ hipMemAdviseUnsetPreferredLocation
Clear the preferred location for the data.
Definition: hip_runtime_api.h:249
hipError_t hipCtxSetCurrent(hipCtx_t ctx)
Set the passed context as current/default.
Definition: hip_context.cpp:178
Definition: driver_types.h:288
Definition: texture_types.h:95
Definition: driver_types.h:323
uint32_t z
z
Definition: hip_runtime_api.h:333
hipError_t hipMemsetD8(hipDeviceptr_t dest, unsigned char value, size_t count)
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value va...
Definition: hip_memory.cpp:2261
hipError_t hipCtxSetCacheConfig(hipFuncCache_t cacheConfig)
Set L1/Shared cache partition.
Definition: hip_context.cpp:225
hipError_t hipMemset2DAsync(void *dst, size_t pitch, int value, size_t width, size_t height, hipStream_t stream __dparm(0))
Fills asynchronously the memory area pointed to by dst with the constant value.
Definition: driver_types.h:62
hipError_t hipCtxCreate(hipCtx_t *ctx, unsigned int flags, hipDevice_t device)
Create a context and set it as current/ default context.
Definition: hip_context.cpp:52
dim3 blockDim
Block dimentions.
Definition: hip_runtime_api.h:342
#define hipMemAttachGlobal
Memory can be accessed by any stream on any device.
Definition: hip_runtime_api.h:191
Definition: hip_runtime_api.h:339
@ hipFuncCachePreferShared
prefer larger shared memory and smaller L1 cache
Definition: hip_runtime_api.h:310
@ hipMemRangeAttributePreferredLocation
The preferred location of the range.
Definition: hip_runtime_api.h:264
@ hipMemAdviseSetReadMostly
Definition: hip_runtime_api.h:244
hipFuncAttribute
Definition: hip_runtime_api.h:299
hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config)
Set Shared memory bank configuration.
Definition: hip_context.cpp:233
hipError_t hipStreamAttachMemAsync(hipStream_t stream, hipDeviceptr_t *dev_ptr, size_t length __dparm(0), unsigned int flags __dparm(hipMemAttachSingle))
Attach memory to a stream asynchronously in AMD HMM.
@ hipSharedMemBankSizeEightByte
Definition: hip_runtime_api.h:322
hipError_t hipModuleOccupancyMaxActiveBlocksPerMultiprocessor(int *numBlocks, hipFunction_t f, int blockSize, size_t dynSharedMemPerBlk)
Returns occupancy for a device function.
Definition: hip_module.cpp:1693
hipDeviceAttribute_t
Definition: hip_runtime_api.h:296
hipError_t hipFuncSetSharedMemConfig(const void *func, hipSharedMemConfig config)
Set shared memory configuation for a specific function.
Definition: hip_module.cpp:1419
hipError_t hipExtGetLinkTypeAndHopCount(int device1, int device2, uint32_t *linktype, uint32_t *hopcount)
Returns the link type and hop count between two devices.
Definition: hip_device.cpp:605
@ hipMemAdviseSetAccessedBy
Definition: hip_runtime_api.h:250
Definition: driver_types.h:262
Definition: hip_hcc_internal.h:415
hipError_t hipDeviceSynchronize(void)
Waits on all active streams on current device.
Definition: hip_device.cpp:143
size_t sharedMem
Shared memory.
Definition: hip_runtime_api.h:344
hipError_t hipProfilerStart()
Start recording of profiling information When using this API, start the profiler with profiling disab...
Definition: hip_hcc.cpp:2496
hipError_t hipDeviceGetSharedMemConfig(hipSharedMemConfig *pConfig)
Returns bank width of shared memory for current device.
Definition: hip_device.cpp:124
hipError_t hipMemcpyAsync(void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind, hipStream_t stream __dparm(0))
Copies sizeBytes bytes from the memory area pointed to by src to the memory area pointed to by offset...
hipError_t hipStreamDestroy(hipStream_t stream)
Destroys the specified stream.
Definition: hip_stream.cpp:195
hipError_t hipHostRegister(void *hostPtr, size_t sizeBytes, unsigned int flags)
Register host memory so it can be accessed from the current device.
Definition: hip_memory.cpp:1158
hipError_t hipFuncSetAttribute(const void *func, hipFuncAttribute attr, int value)
Set attribute for a specific function.
Definition: hip_module.cpp:1411
hipError_t hipProfilerStop()
Stop recording of profiling information. When using this API, start the profiler with profiling disab...
Definition: hip_hcc.cpp:2502
hipError_t hipModuleLoadDataEx(hipModule_t *module, const void *image, unsigned int numOptions, hipJitOption *options, void **optionValues)
builds module from code object which resides in host memory. Image is pointer to that location....
Definition: hip_module.cpp:1527
hipError_t hipEventCreate(hipEvent_t *event)
Definition: hip_event.cpp:207
Definition: driver_types.h:338
hipError_t hipMemsetAsync(void *dst, int value, size_t sizeBytes, hipStream_t stream __dparm(0))
Fills the first sizeBytes bytes of the memory area pointed to by dev with the constant byte value val...
hipError_t hipCtxGetCacheConfig(hipFuncCache_t *cacheConfig)
Set Cache configuration for a specific function.
Definition: hip_context.cpp:217
@ hipFuncCachePreferL1
prefer larger L1 cache and smaller shared memory
Definition: hip_runtime_api.h:311
#define hipMemAttachSingle
the associated device
Definition: hip_runtime_api.h:193
hipError_t hipMemcpyParam2D(const hip_Memcpy2D *pCopy)
Copies memory for 2D arrays.
Definition: hip_memory.cpp:2144
hipError_t hipHostAlloc(void **ptr, size_t size, unsigned int flags)
Allocate device accessible page locked host memory [Deprecated].
Definition: hip_runtime_api.h:887
hipError_t hipMemset(void *dst, int value, size_t sizeBytes)
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value va...
Definition: hip_memory.cpp:2220
hipError_t hipDeviceDisablePeerAccess(int peerDeviceId)
Disable direct access from current device's virtual address space to memory allocations physically lo...
Definition: hip_peer.cpp:193
hipError_t __hipPopCallConfiguration(dim3 *gridDim, dim3 *blockDim, size_t *sharedMem, hipStream_t *stream)
Pop configuration of a kernel launch.
Definition: hip_clang.cpp:409
hipError_t hipDevicePrimaryCtxReset(hipDevice_t dev)
Resets the primary context on the GPU.
Definition: hip_context.cpp:308
hipMemRangeAttribute
Definition: hip_runtime_api.h:261