Driver Types

Driver Types#

HIP Runtime API Reference: Driver Types

Data Structures
struct	hipChannelFormatDesc

struct	HIP_ARRAY_DESCRIPTOR

struct	HIP_ARRAY3D_DESCRIPTOR

struct	hip_Memcpy2D

struct	hipMipmappedArray_t

struct	HIP_TEXTURE_DESC

struct	hipResourceDesc

struct	HIP_RESOURCE_DESC

struct	hipResourceViewDesc

struct	HIP_RESOURCE_VIEW_DESC

struct	hipPitchedPtr

struct	hipExtent

struct	hipPos

struct	hipMemcpy3DParms

struct	HIP_MEMCPY3D

struct	hipMemLocation

struct	hipMemcpyAttributes

struct	hipOffset3D

struct	hipMemcpy3DOperand

struct	hipMemcpy3DBatchOp

struct	hipMemcpy3DPeerParms

Macros
#define	HIP_TRSA_OVERRIDE_FORMAT 0x01
	The hipTexRefSetArray function flags parameter override format value.

#define	HIP_TRSF_READ_AS_INTEGER 0x01
	The hipTexRefSetFlags function flags parameter read as integer value.

#define	HIP_TRSF_NORMALIZED_COORDINATES 0x02
	The hipTexRefSetFlags function flags parameter normalized coordinate value.

#define	HIP_TRSF_SRGB 0x10
	The hipTexRefSetFlags function flags parameter srgb value.

Typedefs
typedef void *	hipDeviceptr_t

typedef struct hipArray *	hipArray_t

typedef const struct hipArray *	hipArray_const_t

typedef hipMipmappedArray_t	hipmipmappedArray

typedef const struct hipMipmappedArray *	hipMipmappedArray_const_t

Enumerations
enum	hipChannelFormatKind { hipChannelFormatKindSigned = 0 , hipChannelFormatKindUnsigned = 1 , hipChannelFormatKindFloat = 2 , hipChannelFormatKindNone = 3 }

enum	hipArray_Format { HIP_AD_FORMAT_UNSIGNED_INT8 = 0x01 , HIP_AD_FORMAT_UNSIGNED_INT16 = 0x02 , HIP_AD_FORMAT_UNSIGNED_INT32 = 0x03 , HIP_AD_FORMAT_SIGNED_INT8 = 0x08 , HIP_AD_FORMAT_SIGNED_INT16 = 0x09 , HIP_AD_FORMAT_SIGNED_INT32 = 0x0a , HIP_AD_FORMAT_HALF = 0x10 , HIP_AD_FORMAT_FLOAT = 0x20 }

enum	hipResourceType { hipResourceTypeArray = 0x00 , hipResourceTypeMipmappedArray = 0x01 , hipResourceTypeLinear = 0x02 , hipResourceTypePitch2D = 0x03 }

enum	hipResourcetype { HIP_RESOURCE_TYPE_ARRAY = 0x00 , HIP_RESOURCE_TYPE_MIPMAPPED_ARRAY = 0x01 , HIP_RESOURCE_TYPE_LINEAR = 0x02 , HIP_RESOURCE_TYPE_PITCH2D = 0x03 }

enum	HIPaddress_mode { HIP_TR_ADDRESS_MODE_WRAP = 0 , HIP_TR_ADDRESS_MODE_CLAMP = 1 , HIP_TR_ADDRESS_MODE_MIRROR = 2 , HIP_TR_ADDRESS_MODE_BORDER = 3 }

enum	HIPfilter_mode { HIP_TR_FILTER_MODE_POINT = 0 , HIP_TR_FILTER_MODE_LINEAR = 1 }

enum	hipResourceViewFormat { hipResViewFormatNone = 0x00 , hipResViewFormatUnsignedChar1 = 0x01 , hipResViewFormatUnsignedChar2 = 0x02 , hipResViewFormatUnsignedChar4 = 0x03 , hipResViewFormatSignedChar1 = 0x04 , hipResViewFormatSignedChar2 = 0x05 , hipResViewFormatSignedChar4 = 0x06 , hipResViewFormatUnsignedShort1 = 0x07 , hipResViewFormatUnsignedShort2 = 0x08 , hipResViewFormatUnsignedShort4 = 0x09 , hipResViewFormatSignedShort1 = 0x0a , hipResViewFormatSignedShort2 = 0x0b , hipResViewFormatSignedShort4 = 0x0c , hipResViewFormatUnsignedInt1 = 0x0d , hipResViewFormatUnsignedInt2 = 0x0e , hipResViewFormatUnsignedInt4 = 0x0f , hipResViewFormatSignedInt1 = 0x10 , hipResViewFormatSignedInt2 = 0x11 , hipResViewFormatSignedInt4 = 0x12 , hipResViewFormatHalf1 = 0x13 , hipResViewFormatHalf2 = 0x14 , hipResViewFormatHalf4 = 0x15 , hipResViewFormatFloat1 = 0x16 , hipResViewFormatFloat2 = 0x17 , hipResViewFormatFloat4 = 0x18 , hipResViewFormatUnsignedBlockCompressed1 = 0x19 , hipResViewFormatUnsignedBlockCompressed2 = 0x1a , hipResViewFormatUnsignedBlockCompressed3 = 0x1b , hipResViewFormatUnsignedBlockCompressed4 = 0x1c , hipResViewFormatSignedBlockCompressed4 = 0x1d , hipResViewFormatUnsignedBlockCompressed5 = 0x1e , hipResViewFormatSignedBlockCompressed5 = 0x1f , hipResViewFormatUnsignedBlockCompressed6H = 0x20 , hipResViewFormatSignedBlockCompressed6H = 0x21 , hipResViewFormatUnsignedBlockCompressed7 = 0x22 }

enum	HIPresourceViewFormat { HIP_RES_VIEW_FORMAT_NONE = 0x00 , HIP_RES_VIEW_FORMAT_UINT_1X8 = 0x01 , HIP_RES_VIEW_FORMAT_UINT_2X8 = 0x02 , HIP_RES_VIEW_FORMAT_UINT_4X8 = 0x03 , HIP_RES_VIEW_FORMAT_SINT_1X8 = 0x04 , HIP_RES_VIEW_FORMAT_SINT_2X8 = 0x05 , HIP_RES_VIEW_FORMAT_SINT_4X8 = 0x06 , HIP_RES_VIEW_FORMAT_UINT_1X16 = 0x07 , HIP_RES_VIEW_FORMAT_UINT_2X16 = 0x08 , HIP_RES_VIEW_FORMAT_UINT_4X16 = 0x09 , HIP_RES_VIEW_FORMAT_SINT_1X16 = 0x0a , HIP_RES_VIEW_FORMAT_SINT_2X16 = 0x0b , HIP_RES_VIEW_FORMAT_SINT_4X16 = 0x0c , HIP_RES_VIEW_FORMAT_UINT_1X32 = 0x0d , HIP_RES_VIEW_FORMAT_UINT_2X32 = 0x0e , HIP_RES_VIEW_FORMAT_UINT_4X32 = 0x0f , HIP_RES_VIEW_FORMAT_SINT_1X32 = 0x10 , HIP_RES_VIEW_FORMAT_SINT_2X32 = 0x11 , HIP_RES_VIEW_FORMAT_SINT_4X32 = 0x12 , HIP_RES_VIEW_FORMAT_FLOAT_1X16 = 0x13 , HIP_RES_VIEW_FORMAT_FLOAT_2X16 = 0x14 , HIP_RES_VIEW_FORMAT_FLOAT_4X16 = 0x15 , HIP_RES_VIEW_FORMAT_FLOAT_1X32 = 0x16 , HIP_RES_VIEW_FORMAT_FLOAT_2X32 = 0x17 , HIP_RES_VIEW_FORMAT_FLOAT_4X32 = 0x18 , HIP_RES_VIEW_FORMAT_UNSIGNED_BC1 = 0x19 , HIP_RES_VIEW_FORMAT_UNSIGNED_BC2 = 0x1a , HIP_RES_VIEW_FORMAT_UNSIGNED_BC3 = 0x1b , HIP_RES_VIEW_FORMAT_UNSIGNED_BC4 = 0x1c , HIP_RES_VIEW_FORMAT_SIGNED_BC4 = 0x1d , HIP_RES_VIEW_FORMAT_UNSIGNED_BC5 = 0x1e , HIP_RES_VIEW_FORMAT_SIGNED_BC5 = 0x1f , HIP_RES_VIEW_FORMAT_UNSIGNED_BC6H = 0x20 , HIP_RES_VIEW_FORMAT_SIGNED_BC6H = 0x21 , HIP_RES_VIEW_FORMAT_UNSIGNED_BC7 = 0x22 }

enum	hipMemcpyKind { hipMemcpyHostToHost = 0 , hipMemcpyHostToDevice = 1 , hipMemcpyDeviceToHost = 2 , hipMemcpyDeviceToDevice = 3 , hipMemcpyDefault = 4 , hipMemcpyDeviceToDeviceNoCU = 1024 }

enum	hipMemLocationType { hipMemLocationTypeInvalid = 0 , hipMemLocationTypeNone = 0 , hipMemLocationTypeDevice = 1 , hipMemLocationTypeHost = 2 , hipMemLocationTypeHostNuma = 3 , hipMemLocationTypeHostNumaCurrent }

enum	hipMemcpyFlags { hipMemcpyFlagDefault = 0x0 , hipMemcpyFlagPreferOverlapWithCompute = 0x1 }

enum	hipMemcpySrcAccessOrder { hipMemcpySrcAccessOrderInvalid = 0x0 , hipMemcpySrcAccessOrderStream = 0x1 , hipMemcpySrcAccessOrderDuringApiCall , hipMemcpySrcAccessOrderAny , hipMemcpySrcAccessOrderMax = 0x7FFFFFFF }

enum	hipMemcpy3DOperandType { hipMemcpyOperandTypePointer = 0x1 , hipMemcpyOperandTypeArray = 0x2 , hipMemcpyOperandTypeMax = 0x7FFFFFFF }

enum	hipFunction_attribute { HIP_FUNC_ATTRIBUTE_MAX_THREADS_PER_BLOCK , HIP_FUNC_ATTRIBUTE_SHARED_SIZE_BYTES , HIP_FUNC_ATTRIBUTE_CONST_SIZE_BYTES , HIP_FUNC_ATTRIBUTE_LOCAL_SIZE_BYTES , HIP_FUNC_ATTRIBUTE_NUM_REGS , HIP_FUNC_ATTRIBUTE_PTX_VERSION , HIP_FUNC_ATTRIBUTE_BINARY_VERSION , HIP_FUNC_ATTRIBUTE_CACHE_MODE_CA , HIP_FUNC_ATTRIBUTE_MAX_DYNAMIC_SHARED_SIZE_BYTES , HIP_FUNC_ATTRIBUTE_PREFERRED_SHARED_MEMORY_CARVEOUT , HIP_FUNC_ATTRIBUTE_MAX }

enum	hipPointer_attribute { HIP_POINTER_ATTRIBUTE_CONTEXT = 1 , HIP_POINTER_ATTRIBUTE_MEMORY_TYPE , HIP_POINTER_ATTRIBUTE_DEVICE_POINTER , HIP_POINTER_ATTRIBUTE_HOST_POINTER , HIP_POINTER_ATTRIBUTE_P2P_TOKENS , HIP_POINTER_ATTRIBUTE_SYNC_MEMOPS , HIP_POINTER_ATTRIBUTE_BUFFER_ID , HIP_POINTER_ATTRIBUTE_IS_MANAGED , HIP_POINTER_ATTRIBUTE_DEVICE_ORDINAL , HIP_POINTER_ATTRIBUTE_IS_LEGACY_HIP_IPC_CAPABLE , HIP_POINTER_ATTRIBUTE_RANGE_START_ADDR , HIP_POINTER_ATTRIBUTE_RANGE_SIZE , HIP_POINTER_ATTRIBUTE_MAPPED , HIP_POINTER_ATTRIBUTE_ALLOWED_HANDLE_TYPES , HIP_POINTER_ATTRIBUTE_IS_GPU_DIRECT_RDMA_CAPABLE , HIP_POINTER_ATTRIBUTE_ACCESS_FLAGS , HIP_POINTER_ATTRIBUTE_MEMPOOL_HANDLE }

Detailed Description

This section describes the driver data types.

Macro Definition Documentation

◆ HIP_TRSA_OVERRIDE_FORMAT

#define HIP_TRSA_OVERRIDE_FORMAT 0x01

The hipTexRefSetArray function flags parameter override format value.

◆ HIP_TRSF_NORMALIZED_COORDINATES

#define HIP_TRSF_NORMALIZED_COORDINATES 0x02

The hipTexRefSetFlags function flags parameter normalized coordinate value.

◆ HIP_TRSF_READ_AS_INTEGER

#define HIP_TRSF_READ_AS_INTEGER 0x01

The hipTexRefSetFlags function flags parameter read as integer value.

◆ HIP_TRSF_SRGB

#define HIP_TRSF_SRGB 0x10

The hipTexRefSetFlags function flags parameter srgb value.

Typedef Documentation

◆ hipArray_const_t

typedef const struct hipArray* hipArray_const_t

◆ hipArray_t

typedef struct hipArray* hipArray_t

◆ hipDeviceptr_t

typedef void* hipDeviceptr_t

◆ hipmipmappedArray

typedef hipMipmappedArray_t hipmipmappedArray

◆ hipMipmappedArray_const_t

typedef const struct hipMipmappedArray* hipMipmappedArray_const_t

Enumeration Type Documentation

◆ HIPaddress_mode

enum HIPaddress_mode

HIP texture address modes

Enumerator
HIP_TR_ADDRESS_MODE_WRAP	Wrap address mode.
HIP_TR_ADDRESS_MODE_CLAMP	Clamp address mode.
HIP_TR_ADDRESS_MODE_MIRROR	Mirror address mode.
HIP_TR_ADDRESS_MODE_BORDER	Border address mode.

◆ hipArray_Format

enum hipArray_Format

HIP array format

Enumerator
HIP_AD_FORMAT_UNSIGNED_INT8	Unsigned 8-bit array format.
HIP_AD_FORMAT_UNSIGNED_INT16	Unsigned 16-bit array format.
HIP_AD_FORMAT_UNSIGNED_INT32	Unsigned 32-bit array format.
HIP_AD_FORMAT_SIGNED_INT8	Signed 8-bit array format.
HIP_AD_FORMAT_SIGNED_INT16	Signed 16-bit array format.
HIP_AD_FORMAT_SIGNED_INT32	Signed 32-bit array format.
HIP_AD_FORMAT_HALF	Half array format.
HIP_AD_FORMAT_FLOAT	Float array format.

◆ hipChannelFormatKind

enum hipChannelFormatKind

HIP channel format kinds

Enumerator
hipChannelFormatKindSigned	Signed channel format.
hipChannelFormatKindUnsigned	Unsigned channel format.
hipChannelFormatKindFloat	Float channel format.
hipChannelFormatKindNone	No channel format.

◆ HIPfilter_mode

enum HIPfilter_mode

HIP filter modes

Enumerator
HIP_TR_FILTER_MODE_POINT	Filter mode point.
HIP_TR_FILTER_MODE_LINEAR	Filter mode linear.

◆ hipFunction_attribute

enum hipFunction_attribute

Enumerator
HIP_FUNC_ATTRIBUTE_MAX_THREADS_PER_BLOCK	The maximum number of threads per block. Depends on function and device.
HIP_FUNC_ATTRIBUTE_SHARED_SIZE_BYTES	The statically allocated shared memory size in bytes per block required by the function.
HIP_FUNC_ATTRIBUTE_CONST_SIZE_BYTES	The user-allocated constant memory by the function in bytes.
HIP_FUNC_ATTRIBUTE_LOCAL_SIZE_BYTES	The local memory usage of each thread by this function in bytes.
HIP_FUNC_ATTRIBUTE_NUM_REGS	The number of registers used by each thread of this function.
HIP_FUNC_ATTRIBUTE_PTX_VERSION	PTX version.
HIP_FUNC_ATTRIBUTE_BINARY_VERSION	Binary version.
HIP_FUNC_ATTRIBUTE_CACHE_MODE_CA	Cache mode.
HIP_FUNC_ATTRIBUTE_MAX_DYNAMIC_SHARED_SIZE_BYTES	The maximum dynamic shared memory per block for this function in bytes.
HIP_FUNC_ATTRIBUTE_PREFERRED_SHARED_MEMORY_CARVEOUT	The shared memory carveout preference in percent of the maximum shared memory.
HIP_FUNC_ATTRIBUTE_MAX

◆ hipMemcpy3DOperandType

enum hipMemcpy3DOperandType

Operand types for individual copies within a batch

Enumerator
hipMemcpyOperandTypePointer	Mempcy operand is a valid pointer.
hipMemcpyOperandTypeArray	Memcpy operand is a valid hipArray.
hipMemcpyOperandTypeMax

◆ hipMemcpyFlags

enum hipMemcpyFlags

Flags to specify for copies within a batch. Used with hipMemcpyBatchAsync

Enumerator
hipMemcpyFlagDefault	Default flag.
hipMemcpyFlagPreferOverlapWithCompute	Tries to overlap copy with compute work.

◆ hipMemcpyKind

enum hipMemcpyKind

Memory copy types

Enumerator
hipMemcpyHostToHost	Host-to-Host Copy.
hipMemcpyHostToDevice	Host-to-Device Copy.
hipMemcpyDeviceToHost	Device-to-Host Copy.
hipMemcpyDeviceToDevice	Device-to-Device Copy.
hipMemcpyDefault	Runtime will automatically determine copy-kind based on virtual addresses.
hipMemcpyDeviceToDeviceNoCU	Device-to-Device Copy without using compute units.

◆ hipMemcpySrcAccessOrder

enum hipMemcpySrcAccessOrder

Flags to specify order in which source pointer is accessed by Batch memcpy

Enumerator
hipMemcpySrcAccessOrderInvalid	Default Invalid.
hipMemcpySrcAccessOrderStream	Access to source pointer must be in stream order.
hipMemcpySrcAccessOrderDuringApiCall	Access to source pointer can be out of stream order and all accesses must be complete before API call returns.
hipMemcpySrcAccessOrderAny	Access to the source pointer can be out of stream order and the accesses can happen even after the API call return.
hipMemcpySrcAccessOrderMax

◆ hipMemLocationType

enum hipMemLocationType

Specifies the type of location

Enumerator
hipMemLocationTypeInvalid
hipMemLocationTypeNone
hipMemLocationTypeDevice	Device location, thus it's HIP device ID.
hipMemLocationTypeHost	Host location, id is ignored.
hipMemLocationTypeHostNuma	Host NUMA node location, id is host NUMA node id.
hipMemLocationTypeHostNumaCurrent	Host NUMA node closest to current thread’s CPU, id is ignored.

◆ hipPointer_attribute

enum hipPointer_attribute

Enumerator
HIP_POINTER_ATTRIBUTE_CONTEXT	The context on which a pointer was allocated Warning This attribute is not supported in HIP
HIP_POINTER_ATTRIBUTE_MEMORY_TYPE	memory type describing the location of a pointer
HIP_POINTER_ATTRIBUTE_DEVICE_POINTER	address at which the pointer is allocated on the device
HIP_POINTER_ATTRIBUTE_HOST_POINTER	address at which the pointer is allocated on the host
HIP_POINTER_ATTRIBUTE_P2P_TOKENS	A pair of tokens for use with Linux kernel interface Warning This attribute is not supported in HIP
HIP_POINTER_ATTRIBUTE_SYNC_MEMOPS	Synchronize every synchronous memory operation initiated on this region
HIP_POINTER_ATTRIBUTE_BUFFER_ID	Unique ID for an allocated memory region.
HIP_POINTER_ATTRIBUTE_IS_MANAGED	Indicates if the pointer points to managed memory.
HIP_POINTER_ATTRIBUTE_DEVICE_ORDINAL	device ordinal of a device on which a pointer was allocated or registered
HIP_POINTER_ATTRIBUTE_IS_LEGACY_HIP_IPC_CAPABLE	if this pointer maps to an allocation that is suitable for hipIpcGetMemHandle Warning This attribute is not supported in HIP
HIP_POINTER_ATTRIBUTE_RANGE_START_ADDR	Starting address for this requested pointer.
HIP_POINTER_ATTRIBUTE_RANGE_SIZE	Size of the address range for this requested pointer.
HIP_POINTER_ATTRIBUTE_MAPPED	tells if this pointer is in a valid address range that is mapped to a backing allocation
HIP_POINTER_ATTRIBUTE_ALLOWED_HANDLE_TYPES	Bitmask of allowed hipmemAllocationHandleType for this allocation Warning This attribute is not supported in HIP
HIP_POINTER_ATTRIBUTE_IS_GPU_DIRECT_RDMA_CAPABLE	returns if the memory referenced by this pointer can be used with the GPUDirect RDMA API Warning This attribute is not supported in HIP
HIP_POINTER_ATTRIBUTE_ACCESS_FLAGS	Returns the access flags the device associated with for the corresponding memory referenced by the ptr
HIP_POINTER_ATTRIBUTE_MEMPOOL_HANDLE	Returns the mempool handle for the allocation if it was allocated from a mempool Warning This attribute is not supported in HIP

◆ hipResourceType

enum hipResourceType

HIP resource types

Enumerator
hipResourceTypeArray	Array resource.
hipResourceTypeMipmappedArray	Mipmapped array resource.
hipResourceTypeLinear	Linear resource.
hipResourceTypePitch2D	Pitch 2D resource.

◆ hipResourcetype

enum hipResourcetype

Enumerator
HIP_RESOURCE_TYPE_ARRAY	Array resource.
HIP_RESOURCE_TYPE_MIPMAPPED_ARRAY	Mipmapped array resource.
HIP_RESOURCE_TYPE_LINEAR	Linear resource.
HIP_RESOURCE_TYPE_PITCH2D	Pitch 2D resource.

◆ hipResourceViewFormat

enum hipResourceViewFormat

HIP texture resource view formats

Enumerator
hipResViewFormatNone	No resource view format (use underlying resource format)
hipResViewFormatUnsignedChar1	1 channel, unsigned 8-bit integers
hipResViewFormatUnsignedChar2	2 channels, unsigned 8-bit integers
hipResViewFormatUnsignedChar4	4 channels, unsigned 8-bit integers
hipResViewFormatSignedChar1	1 channel, signed 8-bit integers
hipResViewFormatSignedChar2	2 channels, signed 8-bit integers
hipResViewFormatSignedChar4	4 channels, signed 8-bit integers
hipResViewFormatUnsignedShort1	1 channel, unsigned 16-bit integers
hipResViewFormatUnsignedShort2	2 channels, unsigned 16-bit integers
hipResViewFormatUnsignedShort4	4 channels, unsigned 16-bit integers
hipResViewFormatSignedShort1	1 channel, signed 16-bit integers
hipResViewFormatSignedShort2	2 channels, signed 16-bit integers
hipResViewFormatSignedShort4	4 channels, signed 16-bit integers
hipResViewFormatUnsignedInt1	1 channel, unsigned 32-bit integers
hipResViewFormatUnsignedInt2	2 channels, unsigned 32-bit integers
hipResViewFormatUnsignedInt4	4 channels, unsigned 32-bit integers
hipResViewFormatSignedInt1	1 channel, signed 32-bit integers
hipResViewFormatSignedInt2	2 channels, signed 32-bit integers
hipResViewFormatSignedInt4	4 channels, signed 32-bit integers
hipResViewFormatHalf1	1 channel, 16-bit floating point
hipResViewFormatHalf2	2 channels, 16-bit floating point
hipResViewFormatHalf4	4 channels, 16-bit floating point
hipResViewFormatFloat1	1 channel, 32-bit floating point
hipResViewFormatFloat2	2 channels, 32-bit floating point
hipResViewFormatFloat4	4 channels, 32-bit floating point
hipResViewFormatUnsignedBlockCompressed1	Block-compressed 1.
hipResViewFormatUnsignedBlockCompressed2	Block-compressed 2.
hipResViewFormatUnsignedBlockCompressed3	Block-compressed 3.
hipResViewFormatUnsignedBlockCompressed4	Block-compressed 4 unsigned.
hipResViewFormatSignedBlockCompressed4	Block-compressed 4 signed.
hipResViewFormatUnsignedBlockCompressed5	Block-compressed 5 unsigned.
hipResViewFormatSignedBlockCompressed5	Block-compressed 5 signed.
hipResViewFormatUnsignedBlockCompressed6H	Block-compressed 6 unsigned half-float.
hipResViewFormatSignedBlockCompressed6H	Block-compressed 6 signed half-float.
hipResViewFormatUnsignedBlockCompressed7	Block-compressed 7.

◆ HIPresourceViewFormat

enum HIPresourceViewFormat