HIP: Heterogenous-computing Interface for Portability
|
Go to the documentation of this file.
30 #ifndef HIP_INCLUDE_HIP_HIP_RUNTIME_API_H
31 #define HIP_INCLUDE_HIP_HIP_RUNTIME_API_H
35 #include <hip/hip_version.h>
36 #include <hip/hip_common.h>
40 HIP_ERROR_INVALID_VALUE,
41 HIP_ERROR_NOT_INITIALIZED,
42 HIP_ERROR_LAUNCH_OUT_OF_RESOURCES
168 unsigned allocationFlags;
182 #if __cplusplus >= 201703L
183 #define __HIP_NODISCARD [[nodiscard]]
185 #define __HIP_NODISCARD
196 typedef enum __HIP_NODISCARD hipError_t {
199 hipErrorOutOfMemory = 2,
203 hipErrorNotInitialized = 3,
205 hipErrorInitializationError = 3,
206 hipErrorDeinitialized = 4,
207 hipErrorProfilerDisabled = 5,
208 hipErrorProfilerNotInitialized = 6,
209 hipErrorProfilerAlreadyStarted = 7,
210 hipErrorProfilerAlreadyStopped = 8,
211 hipErrorInvalidConfiguration = 9,
212 hipErrorInvalidSymbol = 13,
215 hipErrorInsufficientDriver = 35,
216 hipErrorMissingConfiguration = 52,
217 hipErrorPriorLaunchFailure = 53,
218 hipErrorInvalidDeviceFunction = 98,
221 hipErrorInvalidImage = 200,
223 hipErrorContextAlreadyCurrent = 202,
224 hipErrorMapFailed = 205,
227 hipErrorUnmapFailed = 206,
228 hipErrorArrayIsMapped = 207,
229 hipErrorAlreadyMapped = 208,
230 hipErrorNoBinaryForGpu = 209,
231 hipErrorAlreadyAcquired = 210,
232 hipErrorNotMapped = 211,
233 hipErrorNotMappedAsArray = 212,
234 hipErrorNotMappedAsPointer = 213,
235 hipErrorECCNotCorrectable = 214,
236 hipErrorUnsupportedLimit = 215,
237 hipErrorContextAlreadyInUse = 216,
238 hipErrorPeerAccessUnsupported = 217,
240 hipErrorInvalidGraphicsContext = 219,
241 hipErrorInvalidSource = 300,
242 hipErrorFileNotFound = 301,
243 hipErrorSharedObjectSymbolNotFound = 302,
244 hipErrorSharedObjectInitFailed = 303,
245 hipErrorOperatingSystem = 304,
246 hipErrorInvalidHandle = 400,
249 hipErrorNotFound = 500,
251 hipErrorIllegalAddress = 700,
256 hipErrorLaunchTimeOut = 702,
261 hipErrorSetOnActiveProcess = 708,
274 hipErrorUnknown = 999,
283 #undef __HIP_NODISCARD
355 enum hipComputeMode {
356 hipComputeModeDefault = 0,
357 hipComputeModeExclusive = 1,
358 hipComputeModeProhibited = 2,
359 hipComputeModeExclusiveProcess = 3
366 #if defined(__HIP_PLATFORM_HCC__) && !defined(__HIP_PLATFORM_NVCC__)
368 #elif defined(__HIP_PLATFORM_NVCC__) && !defined(__HIP_PLATFORM_HCC__)
369 #include "hip/nvcc_detail/hip_runtime_api.h"
371 #error("Must define exactly one of __HIP_PLATFORM_HCC__ or __HIP_PLATFORM_NVCC__");
386 #if defined(__cplusplus) && !defined(__HIP_DISABLE_CPP_FUNCTIONS__)
388 static inline hipError_t
hipMalloc(T** devPtr,
size_t size) {
@ hipDeviceAttributeMaxPitch
Maximum pitch in bytes allowed by memory copies.
Definition: hip_runtime_api.h:337
int regsPerBlock
Registers per block.
Definition: hip_runtime_api.h:88
@ hipDeviceAttributeMemoryBusWidth
Global memory bus width in bits.
Definition: hip_runtime_api.h:308
hipErrorInvalidMemcpyDirection
Invalid memory copy direction.
Definition: hip_runtime_api.h:214
unsigned hasGlobalInt64Atomics
64-bit integer atomics for global memory.
Definition: hip_runtime_api.h:54
int minor
Definition: hip_runtime_api.h:100
@ hipDeviceAttributeMaxBlockDimX
Maximum x-dimension of a block.
Definition: hip_runtime_api.h:292
hipErrorInvalidDevicePointer
Invalid Device Pointer.
Definition: hip_runtime_api.h:213
hipErrorMapBufferObjectFailed
Produced when the IPC memory attach failed from ROCr.
Definition: hip_runtime_api.h:226
size_t texturePitchAlignment
Pitch alignment requirement for texture references bound to pitched memory.
Definition: hip_runtime_api.h:129
@ hipDeviceAttributeMaxGridDimX
Maximum x-dimension of a grid.
Definition: hip_runtime_api.h:295
unsigned hasThreadFenceSystem
__threadfence_system.
Definition: hip_runtime_api.h:67
int maxTexture3D[3]
Maximum dimensions (width, height, depth) of 3D images, in image elements.
Definition: hip_runtime_api.h:124
int cooperativeMultiDeviceUnmatchedBlockDim
Definition: hip_runtime_api.h:137
hipErrorHostMemoryNotRegistered
Produced when trying to unlock a non-page-locked memory.
Definition: hip_runtime_api.h:265
hipErrorRuntimeOther
Definition: hip_runtime_api.h:278
@ hipDeviceAttributeClockRate
Peak clock frequency in kilohertz.
Definition: hip_runtime_api.h:306
int asicRevision
Revision of the GPU in this device.
Definition: hip_runtime_api.h:142
@ hipDeviceAttributeMaxGridDimZ
Maximum z-dimension of a grid.
Definition: hip_runtime_api.h:297
@ hipMemoryTypeDevice
Definition: hip_runtime_api.h:151
@ hipDeviceAttributeMaxRegistersPerBlock
Definition: hip_runtime_api.h:302
hipErrorNoDevice
Call to hipGetDeviceCount returned 0 devices.
Definition: hip_runtime_api.h:219
int isLargeBar
1: if it is a large PCI bar device, else 0
Definition: hip_runtime_api.h:141
@ hipDeviceAttributeComputeCapabilityMinor
Minor compute capability version number.
Definition: hip_runtime_api.h:316
@ hipDeviceAttributeAsicRevision
Revision of the GPU in this device.
Definition: hip_runtime_api.h:352
int l2CacheSize
L2 cache size.
Definition: hip_runtime_api.h:104
size_t textureAlignment
Alignment requirement for textures.
Definition: hip_runtime_api.h:128
hipError_t hipHostMalloc(void **ptr, size_t size, unsigned int flags)
Allocate device accessible page locked host memory.
Definition: hip_memory.cpp:762
@ hipDeviceAttributeKernelExecTimeout
Run time limit for kernels executed on the device.
Definition: hip_runtime_api.h:340
@ hipDeviceAttributeL2CacheSize
Definition: hip_runtime_api.h:311
@ hipDeviceAttributeCooperativeMultiDeviceUnmatchedGridDim
Definition: hip_runtime_api.h:346
@ hipDeviceAttributeMaxTexture3DWidth
Maximum dimension width of 3D images in image elements.
Definition: hip_runtime_api.h:330
unsigned hasSurfaceFuncs
Surface functions.
Definition: hip_runtime_api.h:71
@ hipDeviceAttributeIntegrated
iGPU
Definition: hip_runtime_api.h:324
int isMultiGpuBoard
1 if device is on a multi-GPU board, 0 if not.
Definition: hip_runtime_api.h:115
@ hipDeviceAttributeMaxGridDimY
Maximum y-dimension of a grid.
Definition: hip_runtime_api.h:296
@ hipMemoryTypeHost
Memory is physically located on host.
Definition: hip_runtime_api.h:150
hipErrorInvalidContext
Produced when input context is invalid.
Definition: hip_runtime_api.h:222
unsigned hasSharedInt64Atomics
64-bit integer atomics for shared memory.
Definition: hip_runtime_api.h:55
int computeMode
Compute mode.
Definition: hip_runtime_api.h:106
@ hipDeviceAttributeIsMultiGpuBoard
Multiple GPU devices.
Definition: hip_runtime_api.h:323
int clockRate
Max clock frequency of the multiProcessors in khz.
Definition: hip_runtime_api.h:93
unsigned int * hdpRegFlushCntl
Addres of HDP_REG_COHERENCY_FLUSH_CNTL register.
Definition: hip_runtime_api.h:126
hipErrorPeerAccessNotEnabled
Peer access was never enabled from the current device.
Definition: hip_runtime_api.h:259
unsigned hasDynamicParallelism
Dynamic parallelism.
Definition: hip_runtime_api.h:73
int canMapHostMemory
Check whether HIP can map host memory.
Definition: hip_runtime_api.h:116
size_t sharedMemPerBlock
Size of shared memory region (in bytes).
Definition: hip_runtime_api.h:87
@ hipDeviceAttributeCooperativeMultiDeviceLaunch
Support cooperative launch on multiple devices.
Definition: hip_runtime_api.h:326
int maxThreadsPerMultiProcessor
Maximum resident threads per multi-processor.
Definition: hip_runtime_api.h:105
int major
Definition: hip_runtime_api.h:97
@ hipDeviceAttributeMaxSharedMemoryPerBlock
Definition: hip_runtime_api.h:298
hipSuccess
Successful completion.
Definition: hip_runtime_api.h:197
@ hipDeviceAttributeMaxThreadsPerBlock
Maximum number of threads per block.
Definition: hip_runtime_api.h:291
int gcnArch
AMD GCN Arch Value. Eg: 803, 701.
Definition: hip_runtime_api.h:117
Definition: hip_runtime_api.h:45
int kernelExecTimeoutEnabled
Run time limit for kernels executed on the device.
Definition: hip_runtime_api.h:130
int maxTexture1D
Maximum number of elements in 1D images.
Definition: hip_runtime_api.h:122
@ hipDeviceAttributeMaxBlockDimZ
Maximum z-dimension of a block.
Definition: hip_runtime_api.h:294
hipError_t hipMallocManaged(void **dev_ptr, size_t size, unsigned int flags __dparm(hipMemAttachGlobal))
Allocates memory that will be automatically managed by AMD HMM.
unsigned hasDoubles
Double-precision floating point.
Definition: hip_runtime_api.h:58
hipErrorInvalidKernelFile
In CUDA DRV, it is CUDA_ERROR_INVALID_PTX.
Definition: hip_runtime_api.h:239
int maxThreadsPerBlock
Max work items per work group or workgroup max size.
Definition: hip_runtime_api.h:90
@ hipDeviceAttributeMaxBlockDimY
Maximum y-dimension of a block.
Definition: hip_runtime_api.h:293
Definition: hip_runtime_api.h:84
@ hipDeviceAttributeCooperativeMultiDeviceUnmatchedBlockDim
Definition: hip_runtime_api.h:348
@ hipDeviceAttributeMaxTexture2DHeight
Maximum dimension height of 2D images in image elements.
Definition: hip_runtime_api.h:329
unsigned hasSharedInt32Atomics
32-bit integer atomics for shared memory.
Definition: hip_runtime_api.h:49
hipErrorInvalidValue
Definition: hip_runtime_api.h:198
size_t memPitch
Maximum pitch in bytes allowed by memory copies.
Definition: hip_runtime_api.h:127
int pciBusID
PCI Bus ID.
Definition: hip_runtime_api.h:112
@ hipDeviceAttributeComputeCapabilityMajor
Major compute capability version number.
Definition: hip_runtime_api.h:315
@ hipDeviceAttributeMaxTexture3DDepth
Maximum dimensions depth of 3D images in image elements.
Definition: hip_runtime_api.h:332
hipErrorRuntimeMemory
Definition: hip_runtime_api.h:276
@ hipDeviceAttributeMaxThreadsPerMultiProcessor
Definition: hip_runtime_api.h:313
hipDeviceArch_t arch
Architectural feature flags. New for HIP.
Definition: hip_runtime_api.h:109
Contains C function APIs for HIP runtime. This file does not use any HCC builtin or special language ...
@ hipDeviceAttributeHdpRegFlushCntl
Address of the HDP_REG_COHERENCY_FLUSH_CNTL register.
Definition: hip_runtime_api.h:335
@ hipDeviceAttributePciBusId
PCI Bus ID.
Definition: hip_runtime_api.h:319
int tccDriver
1:If device is Tesla device using TCC driver, else 0
Definition: hip_runtime_api.h:132
hipError_t hipMalloc(void **ptr, size_t size)
Allocate memory on the default accelerator.
Definition: hip_memory.cpp:695
@ hipMemoryTypeUnified
Not used currently.
Definition: hip_runtime_api.h:155
@ hipDeviceAttributeTexturePitchAlignment
Pitch alignment requirement for 2D texture references bound to pitched memory;.
Definition: hip_runtime_api.h:339
@ hipDeviceAttributeWarpSize
Warp size in threads.
Definition: hip_runtime_api.h:301
unsigned hasGlobalInt32Atomics
32-bit integer atomics for global memory.
Definition: hip_runtime_api.h:47
unsigned hasSyncThreadsExt
__syncthreads_count, syncthreads_and, syncthreads_or.
Definition: hip_runtime_api.h:68
@ hipMemoryTypeArray
Definition: hip_runtime_api.h:153
hipErrorInvalidDevice
DeviceID must be in range 0...#compute-devices.
Definition: hip_runtime_api.h:220
unsigned hasFunnelShift
Funnel two words into one with shift&mask caps.
Definition: hip_runtime_api.h:64
@ hipDeviceAttributeMaxTexture3DHeight
Maximum dimensions height of 3D images in image elements.
Definition: hip_runtime_api.h:331
@ hipDeviceAttributeMemoryClockRate
Peak memory clock frequency in kilohertz.
Definition: hip_runtime_api.h:307
hipErrorNotReady
Definition: hip_runtime_api.h:250
struct hipPointerAttribute_t hipPointerAttribute_t
int maxGridSize[3]
Max grid dimensions (XYZ).
Definition: hip_runtime_api.h:92
@ hipDeviceAttributeComputeMode
Compute mode that device is currently in.
Definition: hip_runtime_api.h:310
@ hipDeviceAttributePciDeviceId
PCI Device ID.
Definition: hip_runtime_api.h:320
size_t maxSharedMemoryPerMultiProcessor
Maximum Shared Memory Per Multiprocessor.
Definition: hip_runtime_api.h:114
int clockInstructionRate
Definition: hip_runtime_api.h:107
unsigned int * hdpMemFlushCntl
Addres of HDP_MEM_COHERENCY_FLUSH_CNTL register.
Definition: hip_runtime_api.h:125
Definition: hip_runtime_api.h:162
@ hipDeviceAttributeTotalConstantMemory
Constant memory size in bytes.
Definition: hip_runtime_api.h:300
unsigned hasWarpShuffle
Warp shuffle operations. (__shfl_*).
Definition: hip_runtime_api.h:63
int memoryBusWidth
Global memory bus width in bits.
Definition: hip_runtime_api.h:95
unsigned hasWarpVote
Warp vote instructions (__any, __all).
Definition: hip_runtime_api.h:61
char name[256]
Device name.
Definition: hip_runtime_api.h:85
unsigned hasGlobalFloatAtomicExch
32-bit float atomic exch for global memory.
Definition: hip_runtime_api.h:48
int concurrentKernels
Device can possibly execute multiple kernels concurrently.
Definition: hip_runtime_api.h:110
unsigned hasWarpBallot
Warp ballot instructions (__ballot).
Definition: hip_runtime_api.h:62
size_t totalGlobalMem
Size of global memory region (in bytes).
Definition: hip_runtime_api.h:86
@ hipDeviceAttributeTextureAlignment
Alignment requirement for textures.
Definition: hip_runtime_api.h:338
#define hipHostMallocDefault
Flags that can be used with hipHostMalloc.
Definition: hip_runtime_api.h:175
char gcnArchName[256]
AMD GCN Arch Name.
Definition: hip_runtime_api.h:118
@ hipDeviceAttributeCanMapHostMemory
Device can map host memory into device address space.
Definition: hip_runtime_api.h:341
int maxThreadsDim[3]
Max number of threads in each dimension (XYZ) of a block.
Definition: hip_runtime_api.h:91
int cooperativeMultiDeviceLaunch
HIP device supports cooperative launch on multiple devices.
Definition: hip_runtime_api.h:121
unsigned has3dGrid
Grid and group dims are 3D (rather than 2D).
Definition: hip_runtime_api.h:72
@ hipDeviceAttributeMaxTexture1DWidth
Maximum number of elements in 1D images.
Definition: hip_runtime_api.h:327
@ hipDeviceAttributeCooperativeLaunch
Support cooperative launch.
Definition: hip_runtime_api.h:325
@ hipDeviceAttributeMultiprocessorCount
Number of multiprocessors on the device.
Definition: hip_runtime_api.h:309
int pciDeviceID
PCI Device ID.
Definition: hip_runtime_api.h:113
int memoryClockRate
Max global memory clock frequency in khz.
Definition: hip_runtime_api.h:94
hipErrorCooperativeLaunchTooLarge
Definition: hip_runtime_api.h:269
int warpSize
Warp size.
Definition: hip_runtime_api.h:89
hipErrorAssert
Produced when the kernel calls assert.
Definition: hip_runtime_api.h:262
int cooperativeMultiDeviceUnmatchedFunc
Definition: hip_runtime_api.h:133
int cooperativeMultiDeviceUnmatchedGridDim
Definition: hip_runtime_api.h:135
unsigned hasFloatAtomicAdd
32-bit float atomic add in global and shared memory.
Definition: hip_runtime_api.h:51
int cooperativeLaunch
HIP device supports cooperative launch.
Definition: hip_runtime_api.h:120
unsigned hasSharedFloatAtomicExch
32-bit float atomic exch for shared memory.
Definition: hip_runtime_api.h:50
@ hipDeviceAttributeCooperativeMultiDeviceUnmatchedSharedMem
Definition: hip_runtime_api.h:350
int multiProcessorCount
Number of multi-processors (compute units).
Definition: hip_runtime_api.h:103
int integrated
APU vs dGPU.
Definition: hip_runtime_api.h:119
int ECCEnabled
Device has ECC support enabled.
Definition: hip_runtime_api.h:131
size_t totalConstMem
Size of shared memory region (in bytes).
Definition: hip_runtime_api.h:96
int maxTexture2D[2]
Maximum dimensions (width, height) of 2D images, in image elements.
Definition: hip_runtime_api.h:123
#define hipMemAttachGlobal
Memory can be accessed by any stream on any device.
Definition: hip_runtime_api.h:191
hipErrorHostMemoryAlreadyRegistered
Produced when trying to lock a page-locked memory.
Definition: hip_runtime_api.h:263
hipDeviceAttribute_t
Definition: hip_runtime_api.h:290
hipErrorMemoryAllocation
Memory allocation error.
Definition: hip_runtime_api.h:202
hipErrorLaunchFailure
An exception occurred on the device while executing a kernel.
Definition: hip_runtime_api.h:267
@ hipDeviceAttributeConcurrentKernels
Definition: hip_runtime_api.h:317
int cooperativeMultiDeviceUnmatchedSharedMem
Definition: hip_runtime_api.h:139
hipErrorNotSupported
Produced when the hip API is not supported/implemented.
Definition: hip_runtime_api.h:273
hipErrorLaunchOutOfResources
Out of resources error.
Definition: hip_runtime_api.h:255
hipErrorInvalidResourceHandle
Resource handle (hipEvent_t or hipStream_t) invalid.
Definition: hip_runtime_api.h:248
hipMemoryType
Definition: hip_runtime_api.h:149
@ hipDeviceAttributeMaxTexture2DWidth
Maximum dimension width of 2D images in image elements.
Definition: hip_runtime_api.h:328
int pciDomainID
PCI Domain ID.
Definition: hip_runtime_api.h:111
@ hipDeviceAttributeCooperativeMultiDeviceUnmatchedFunc
Definition: hip_runtime_api.h:344
@ hipDeviceAttributeHdpMemFlushCntl
Address of the HDP_MEM_COHERENCY_FLUSH_CNTL register.
Definition: hip_runtime_api.h:334
@ hipDeviceAttributeEccEnabled
Device has ECC support enabled.
Definition: hip_runtime_api.h:342
struct hipDeviceProp_t hipDeviceProp_t
@ hipDeviceAttributeMaxSharedMemoryPerMultiprocessor
Definition: hip_runtime_api.h:321
hipErrorPeerAccessAlreadyEnabled
Peer access was already enabled from the current device.
Definition: hip_runtime_api.h:257