# HIP Programming Guide¶

HIP provides a C++ syntax that is suitable for compiling most code that commonly appears in compute kernels, including classes, namespaces, operator overloading, templates and more. Additionally, it defines other language features designed specifically to target accelerators, such as the following:

A kernel-launch syntax that uses standard C++, resembles a function call and is portable to all HIP targets

Short-vector headers that can serve on a host or a device

Math functions resembling those in the “math.h” header included with standard C++ compilers

Built-in functions for accessing specific GPU hardware capabilities

This section describes the built-in variables and functions accessible from the HIP kernel. It’s intended for readers who are familiar with Cuda kernel syntax and want to understand how HIP is different.

Features are marked with one of the following keywords:

Supported—HIP supports the feature with a Cuda-equivalent function

Not supported—HIP does not support the feature

Under development—the feature is under development but not yet available

## Function-Type Qualifiers¶

**__device__**

Supported __device__ functions are

Executed on the device

Called from the device only

The __device__ keyword can combine with the host keyword.

**__global__**

Supported __global__ functions are

Executed on the device

Called (“launched”) from the host

HIP __global__ functions must have a void return type.

HIP lacks dynamic-parallelism support, so __global__ functions cannot be called from the device.

**__host__**

Supported __host__ functions are

Executed on the host

Called from the host

__host__ can combine with __device__, in which case the function compiles for both the host and device. These functions cannot use the HIP grid coordinate functions (for example, “hipThreadIdx_x”). A possible workaround is to pass the necessary coordinate info as an argument to the function.

__host__ cannot combine with __global__.

HIP parses the __noinline__ and __forceinline__ keywords and converts them to the appropriate Clang attributes. The hcc compiler, however, currently in-lines all device functions, so they are effectively ignored.

## Calling __global__ Functions¶

__global__ functions are often referred to as kernels, and calling one is termed launching the kernel. These functions require the caller to specify an “execution configuration” that includes the grid and block dimensions. The execution configuration can also include other information for the launch, such as the amount of additional shared memory to allocate and the stream where the kernel should execute. HIP introduces a standard C++ calling convention to pass the execution configuration to the kernel (this convention replaces the Cuda <<< >>> syntax). In HIP,

Kernels launch with the “hipLaunchKernelGGL” function

- The first five parameters to hipLaunchKernelGGL are the following:

symbol kernelName: the name of the kernel to launch. To support template kernels which contains “,” use the HIP_KERNEL_NAME macro. The hipify tools insert this automatically.

dim3 gridDim: 3D-grid dimensions specifying the number of blocks to launch.

dim3 blockDim: 3D-block dimensions specifying the number of threads in each block.

size_t dynamicShared: amount of additional shared memory to allocate when launching the kernel

hipStream_t: stream where the kernel should execute. A value of 0 corresponds to the NULL stream(see Synchronization Functions).

Kernel arguments follow these first five parameters

//Example pseudo code introducing hipLaunchKernelGGL __global__ MyKernel(float *A, float *B, float *C, size_t N) { ... } //Replace MyKernel<<<dim3(gridDim), dim3(gridDim), 0, 0>>> (a,b,c,n); hipLaunchKernelGGL(MyKernel, dim3(gridDim), dim3(groupDim), 0/*dynamicShared*/, 0/*stream), a, b, c, n)

The hipLaunchKernelGGL macro always starts with the five parameters specified above, followed by the kernel arguments. The Hipify script automatically converts Cuda launch syntax to hipLaunchKernelGGL, including conversion of optional arguments in <<< >>> to the five required hipLaunchKernelGGL parameters. The dim3 constructor accepts zero to three arguments and will by default initialize unspecified dimensions to 1. See dim3. The kernel uses the coordinate built-ins (hipThread*, hipBlock*, hipGrid*) to determine coordinate index and coordinate bounds of the work item that’s currently executing.

### Kernel-Launch Example¶

```
// Example showing use of host/device function
__host__ __device__
float PlusOne(float x)
{
return x + 1.0;
}
__global__
void
MyKernel (const float *a, const float *b, float *c, unsigned N)
{
unsigned gid = hipThreadIdx_x; // <- coordinate index function
if (gid < N) {
c[gid] = a[gid] + PlusOne(b[gid]);
}
}
void callMyKernel()
{
float *a, *b, *c; // initialization not shown...
unsigned N = 1000000;
const unsigned blockSize = 256;
hipLaunchKernelGGL(MyKernel,
(N/blockSize), dim3(blockSize), 0, 0, a,b,c,N);
}
```

## Variable-Type Qualifiers¶

**__constant__**

The __constant__ keyword is supported. The host writes constant memory before launching the kernel; from the GPU, this memory is read-only during kernel execution. The functions for accessing constant memory (hipGetSymbolAddress(), hipGetSymbolSize(), hipMemcpyToSymbol(), hipMemcpyToSymbolAsync, hipMemcpyFromSymbol, hipMemcpyFromSymbolAsync) are under development.

**__shared__**

The __shared__ keyword is supported. extern __shared__ allows the host to dynamically allocate shared memory and is specified as a launch parameter. HIP uses an alternate syntax based on the HIP_DYNAMIC_SHARED macro.

**__managed__**

Managed memory, including the __managed__ keyword, are not supported in HIP.

**__restrict__**

The __restrict__ keyword tells the compiler that the associated memory pointer will not alias with any other pointer in the kernel or function. This feature can help the compiler generate better code. In most cases, all pointer arguments must use this keyword to realize the benefit. hcc support for the __restrict__ qualifier on kernel arguments is under development.

## Built-In Variables¶

**Coordinate Built-Ins**

These built-ins determine the coordinate of the active work item in the execution grid. They are defined in hip_runtime.h (rather than being implicitly defined by the compiler).

HIP Syntax |
Cuda Syntax |
---|---|

hipThreadIdx_x |
threadIdx.x |

hipThreadIdx_y |
threadIdx.y |

hipThreadIdx_z |
threadIdx.z |

hipBlockIdx_x |
blockIdx.x |

hipBlockIdx_y |
blockIdx.y |

hipBlockIdx_z |
blockIdx.z |

hipBlockDim_x |
blockDim.x |

hipBlockDim_y |
blockDim.y |

hipBlockDim_z |
blockDim.z |

hipGridDim_x |
gridDim.x |

hipGridDim_y |
gridDim.y |

hipGridDim_z |
gridDim.z |

**warpSize**

The warpSize variable is of type int and contains the warp size (in threads) for the target device. Note that all current Nvidia devices return 32 for this variable, and all current AMD devices return 64. Device code should use the warpSize built-in to develop portable wave-aware code.

## Vector Types¶

Note that these types are defined in hip_runtime.h and are not automatically provided by the compiler.

**Short Vector Types**

Short vector types derive from the basic integer and floating-point types. They are structures defined in hip_vector_types.h. The first, second, third and fourth components of the vector are accessible through the x, y, z and w fields, respectively. All the short vector types support a constructor function of the form make_<type_name>(). For example, float4 make_float4(float x, float y, float z, float w) creates a vector of type float4 and value (x,y,z,w).

HIP supports the following short vector formats:

- Signed Integers:

char1, char2, char3, char4

short1, short2, short3, short4

int1, int2, int3, int4

long1, long2, long3, long4

longlong1, longlong2, longlong3, longlong4

- Unsigned Integers:

uchar1, uchar2, uchar3, uchar4

ushort1, ushort2, ushort3, ushort4

uint1, uint2, uint3, uint4

ulong1, ulong2, ulong3, ulong4

ulonglong1, ulonglong2, ulonglong3, ulonglong4

- Floating Points

float1, float2, float3, float4

double1, double2, double3, double4

### dim3¶

dim3 is a three-dimensional integer vector type commonly used to specify grid and group dimensions. Unspecified dimensions are initialized to 1.

```
typedef struct dim3 {
uint32_t x;
uint32_t y;
uint32_t z;
dim3(uint32_t _x=1, uint32_t _y=1, uint32_t _z=1) : x(_x), y(_y), z(_z) {};
};
```

## Memory-Fence Instructions¶

HIP supports __threadfence() and __threadfence_block().

HIP provides workaround for threadfence_system() under HCC path. To enable the workaround, HIP should be built with environment variable HIP_COHERENT_HOST_ALLOC enabled. In addition,the kernels that use __threadfence_system() should be modified as follows:

The kernel should only operate on finegrained system memory; which should be allocated with hipHostMalloc().

Remove all memcpy for those allocated finegrained system memory regions.

## Synchronization Functions¶

The __syncthreads() built-in function is supported in HIP. The __syncthreads_count(int), __syncthreads_and(int) and __syncthreads_or(int) functions are under development.

## Math Functions¶

hcc supports a set of math operations callable from the device.

**Single Precision Mathematical Functions**

Following is the list of supported single precision mathematical functions.

Function |
Supported on Host |
Supported on Device |
---|---|---|

float acosf ( float x ) Calculate the arc cosine of the input argument. |
✓ |
✓ |

float acoshf ( float x ) Calculate the nonnegative arc hyperbolic cosine of the input argument. |
✓ |
✓ |

float asinf ( float x ) Calculate the arc sine of the input argument. |
✓ |
✓ |

float asinhf ( float x ) Calculate the arc hyperbolic sine of the input argument. |
✓ |
✓ |

float atan2f ( float y, float x ) Calculate the arc tangent of the ratio of first and second input arguments. |
✓ |
✓ |

float atanf ( float x ) Calculate the arc tangent of the input argument. |
✓ |
✓ |

float atanhf ( float x ) Calculate the arc hyperbolic tangent of the input argument. |
✓ |
✓ |

float cbrtf ( float x ) Calculate the cube root of the input argument. |
✓ |
✓ |

float ceilf ( float x ) Calculate ceiling of the input argument. |
✓ |
✓ |

float copysignf ( float x, float y ) Create value with given magnitude, copying sign of second value. |
✓ |
✓ |

float cosf ( float x ) Calculate the cosine of the input argument. |
✓ |
✓ |

float coshf ( float x ) Calculate the hyperbolic cosine of the input argument. |
✓ |
✓ |

float erfcf ( float x ) Calculate the complementary error function of the input argument. |
✓ |
✓ |

float erff ( float x ) Calculate the error function of the input argument. |
✓ |
✓ |

float exp10f ( float x ) Calculate the base 10 exponential of the input argument. |
✓ |
✓ |

float exp2f ( float x ) Calculate the base 2 exponential of the input argument. |
✓ |
✓ |

float expf ( float x ) Calculate the base e exponential of the input argument. |
✓ |
✓ |

float expm1f ( float x ) Calculate the base e exponential of the input argument, minus 1. |
✓ |
✓ |

float fabsf ( float x ) Calculate the absolute value of its argument. |
✓ |
✓ |

float fdimf ( float x, float y ) Compute the positive difference between x and y. |
✓ |
✓ |

float floorf ( float x ) Calculate the largest integer less than or equal to x. |
✓ |
✓ |

float fmaf ( float x, float y, float z ) Compute x × y + z as a single operation. |
✓ |
✓ |

float fmaxf ( float x, float y ) Determine the maximum numeric value of the arguments. |
✓ |
✓ |

float fminf ( float x, float y ) Determine the minimum numeric value of the arguments. |
✓ |
✓ |

float fmodf ( float x, float y ) Calculate the floating-point remainder of x / y. |
✓ |
✓ |

float frexpf ( float x, int* nptr ) Extract mantissa and exponent of a floating-point value. |
✓ |
✗ |

float hypotf ( float x, float y ) Calculate the square root of the sum of squares of two arguments. |
✓ |
✓ |

int ilogbf ( float x ) Compute the unbiased integer exponent of the argument. |
✓ |
✓ |

__RETURN_TYPE1 isfinite ( float a ) Determine whether argument is finite. |
✓ |
✓ |

__RETURN_TYPE1 isinf ( float a ) Determine whether argument is infinite. |
✓ |
✓ |

__RETURN_TYPE1 isnan ( float a ) Determine whether argument is a NaN. |
✓ |
✓ |

float ldexpf ( float x, int exp ) Calculate the value of x ⋅ 2exp. |
✓ |
✓ |

float log10f ( float x ) Calculate the base 10 logarithm of the input argument. |
✓ |
✓ |

float log1pf ( float x ) Calculate the value of loge( 1 + x ). |
✓ |
✓ |

float logbf ( float x ) Calculate the floating point representation of the exponent of the input argument. |
✓ |
✓ |

float log2f ( float x ) Calculate the base 2 logarithm of the input argument. |
✓ |
✓ |

float logf ( float x ) Calculate the natural logarithm of the input argument. |
✓ |
✓ |

float modff ( float x, float* iptr ) Break down the input argument into fractional and integral parts. |
✓ |
✗ |

float nanf ( const char* tagp ) Returns “Not a Number”” value.” |
✗ |
✓ |

float nearbyintf ( float x ) Round the input argument to the nearest integer. |
✓ |
✓ |

float powf ( float x, float y ) Calculate the value of first argument to the power of second argument. |
✓ |
✓ |

float remainderf ( float x, float y ) Compute single-precision floating-point remainder. |
✓ |
✓ |

float remquof ( float x, float y, int* quo ) Compute single-precision floating-point remainder and part of quotient. |
✓ |
✗ |

float roundf ( float x ) Round to nearest integer value in floating-point. |
✓ |
✓ |

float scalbnf ( float x, int n ) Scale floating-point input by integer power of two. |
✓ |
✓ |

__RETURN_TYPE1 signbit ( float a ) Return the sign bit of the input. |
✓ |
✓ |

void sincosf ( float x, float* sptr, float* cptr ) Calculate the sine and cosine of the first input argument. |
✓ |
✗ |

float sinf ( float x ) Calculate the sine of the input argument. |
✓ |
✓ |

float sinhf ( float x ) Calculate the hyperbolic sine of the input argument. |
✓ |
✓ |

float sqrtf ( float x ) Calculate the square root of the input argument. |
✓ |
✓ |

float tanf ( float x ) Calculate the tangent of the input argument. |
✓ |
✓ |

float tanhf ( float x ) Calculate the hyperbolic tangent of the input argument. |
✓ |
✓ |

float truncf ( float x ) Truncate input argument to the integral part. |
✓ |
✓ |

float tgammaf ( float x ) Calculate the gamma function of the input argument. |
✓ |
✓ |

float erfcinvf ( float y ) Calculate the inverse complementary function of the input argument. |
✓ |
✓ |

float erfcxf ( float x ) Calculate the scaled complementary error function of the input argument. |
✓ |
✓ |

float erfinvf ( float y ) Calculate the inverse error function of the input argument. |
✓ |
✓ |

float fdividef ( float x, float y ) Divide two floating point values. |
✓ |
✓ |

float frexpf ( float x, int *nptr ) Extract mantissa and exponent of a floating-point value. |
✓ |
✓ |

float j0f ( float x ) Calculate the value of the Bessel function of the first kind of order 0 for the input argument. |
✓ |
✓ |

float j1f ( float x ) Calculate the value of the Bessel function of the first kind of order 1 for the input argument. |
✓ |
✓ |

float jnf ( int n, float x ) Calculate the value of the Bessel function of the first kind of order n for the input argument. |
✓ |
✓ |

float lgammaf ( float x ) Calculate the natural logarithm of the absolute value of the gamma function of the input argument. |
✓ |
✓ |

long long int llrintf ( float x ) Round input to nearest integer value. |
✓ |
✓ |

long long int llroundf ( float x ) Round to nearest integer value. |
✓ |
✓ |

long int lrintf ( float x ) Round input to nearest integer value. |
✓ |
✓ |

long int lroundf ( float x ) Round to nearest integer value. |
✓ |
✓ |

float modff ( float x, float *iptr ) Break down the input argument into fractional and integral parts. |
✓ |
✓ |

float nextafterf ( float x, float y ) Returns next representable single-precision floating-point value after argument. |
✓ |
✓ |

float norm3df ( float a, float b, float c ) Calculate the square root of the sum of squares of three coordinates of the argument. |
✓ |
✓ |

float norm4df ( float a, float b, float c, float d ) Calculate the square root of the sum of squares of four coordinates of the argument. |
✓ |
✓ |

float normcdff ( float y ) Calculate the standard normal cumulative distribution function. |
✓ |
✓ |

float normcdfinvf ( float y ) Calculate the inverse of the standard normal cumulative distribution function. |
✓ |
✓ |

float normf ( int dim, const float *a ) Calculate the square root of the sum of squares of any number of coordinates. |
✓ |
✓ |

float rcbrtf ( float x ) Calculate the reciprocal cube root function. |
✓ |
✓ |

float remquof ( float x, float y, int *quo ) Compute single-precision floating-point remainder and part of quotient. |
✓ |
✓ |

float rhypotf ( float x, float y ) Calculate one over the square root of the sum of squares of two arguments. |
✓ |
✓ |

float rintf ( float x ) Round input to nearest integer value in floating-point. |
✓ |
✓ |

float rnorm3df ( float a, float b, float c ) Calculate one over the square root of the sum of squares of three coordinates of the argument. |
✓ |
✓ |

float rnorm4df ( float a, float b, float c, float d ) Calculate one over the square root of the sum of squares of four coordinates of the argument. |
✓ |
✓ |

float rnormf ( int dim, const float *a ) Calculate the reciprocal of square root of the sum of squares of any number of coordinates. |
✓ |
✓ |

float scalblnf ( float x, long int n ) Scale floating-point input by integer power of two. |
✓ |
✓ |

void sincosf ( float x, float *sptr, float *cptr ) Calculate the sine and cosine of the first input argument. |
✓ |
✓ |

void sincospif ( float x, float *sptr, float *cptr ) Calculate the sine and cosine of the first input argument multiplied by PI. |
✓ |
✓ |

float y0f ( float x ) Calculate the value of the Bessel function of the second kind of order 0 for the input argument. |
✓ |
✓ |

float y1f ( float x ) Calculate the value of the Bessel function of the second kind of order 1 for the input argument. |
✓ |
✓ |

float ynf ( int n, float x ) Calculate the value of the Bessel function of the second kind of order n for the input argument. |
✓ |
✓ |

[1] __RETURN_TYPE is dependent on compiler. It is usually ‘int’ for C compilers and ‘bool’ for C++ compilers.

**Double Precision Mathematical Functions**

Following is the list of supported double precision mathematical functions.

Function |
Supported on Host |
Supported on Device |
---|---|---|

double acos ( double x ) Calculate the arc cosine of the input argument. |
✓ |
✓ |

double acosh ( double x ) Calculate the nonnegative arc hyperbolic cosine of the input argument. |
✓ |
✓ |

double asin ( double x ) Calculate the arc sine of the input argument. |
✓ |
✓ |

double asinh ( double x ) Calculate the arc hyperbolic sine of the input argument. |
✓ |
✓ |

double atan ( double x ) Calculate the arc tangent of the input argument. |
✓ |
✓ |

double atan2 ( double y, double x ) Calculate the arc tangent of the ratio of first and second input arguments. |
✓ |
✓ |

double atanh ( double x ) Calculate the arc hyperbolic tangent of the input argument. |
✓ |
✓ |

double cbrt ( double x ) Calculate the cube root of the input argument. |
✓ |
✓ |

double ceil ( double x ) Calculate ceiling of the input argument. |
✓ |
✓ |

double copysign ( double x, double y ) Create value with given magnitude, copying sign of second value. |
✓ |
✓ |

double cos ( double x ) Calculate the cosine of the input argument. |
✓ |
✓ |

double cosh ( double x ) Calculate the hyperbolic cosine of the input argument. |
✓ |
✓ |

double erf ( double x ) Calculate the error function of the input argument. |
✓ |
✓ |

double erfc ( double x ) Calculate the complementary error function of the input argument. |
✓ |
✓ |

double exp ( double x ) Calculate the base e exponential of the input argument. |
✓ |
✓ |

double exp10 ( double x ) Calculate the base 10 exponential of the input argument. |
✓ |
✓ |

double exp2 ( double x ) Calculate the base 2 exponential of the input argument. |
✓ |
✓ |

double expm1 ( double x ) Calculate the base e exponential of the input argument, minus 1. |
✓ |
✓ |

double fabs ( double x ) Calculate the absolute value of the input argument. |
✓ |
✓ |

double fdim ( double x, double y ) Compute the positive difference between x and y. |
✓ |
✓ |

double floor ( double x ) Calculate the largest integer less than or equal to x. |
✓ |
✓ |

double fma ( double x, double y, double z ) Compute x × y + z as a single operation. |
✓ |
✓ |

double fmax ( double , double ) Determine the maximum numeric value of the arguments. |
✓ |
✓ |

double fmin ( double x, double y ) Determine the minimum numeric value of the arguments. |
✓ |
✓ |

double fmod ( double x, double y ) Calculate the floating-point remainder of x / y. |
✓ |
✓ |

double frexp ( double x, int* nptr ) Extract mantissa and exponent of a floating-point value. |
✓ |
✗ |

double hypot ( double x, double y ) Calculate the square root of the sum of squares of two arguments. |
✓ |
✓ |

int ilogb ( double x ) Compute the unbiased integer exponent of the argument. |
✓ |
✓ |

__RETURN_TYPE1 isfinite ( double a ) Determine whether argument is finite. |
✓ |
✓ |

__RETURN_TYPE1 isinf ( double a ) Determine whether argument is infinite. |
✓ |
✓ |

__RETURN_TYPE1 isnan ( double a ) Determine whether argument is a NaN. |
✓ |
✓ |

double ldexp ( double x, int exp ) Calculate the value of x ⋅ 2exp. |
✓ |
✓ |

double log ( double x ) Calculate the base e logarithm of the input argument. |
✓ |
✓ |

double log10 ( double x ) Calculate the base 10 logarithm of the input argument. |
✓ |
✓ |

double log1p ( double x ) Calculate the value of loge( 1 + x ). |
✓ |
✓ |

double log2 ( double x ) Calculate the base 2 logarithm of the input argument. |
✓ |
✓ |

double logb ( double x ) Calculate the floating point representation of the exponent of the input argument. |
✓ |
✓ |

double modf ( double x, double* iptr ) Break down the input argument into fractional and integral parts. |
✓ |
✗ |

double nan ( const char* tagp ) Returns “Not a Number”” value.” |
✗ |
✓ |

double nearbyint ( double x ) Round the input argument to the nearest integer. |
✓ |
✓ |

double pow ( double x, double y ) Calculate the value of first argument to the power of second argument. |
✓ |
✓ |

double remainder ( double x, double y ) Compute double-precision floating-point remainder. |
✓ |
✓ |

double remquo ( double x, double y, int* quo ) Compute double-precision floating-point remainder and part of quotient. |
✓ |
✗ |

double round ( double x ) Round to nearest integer value in floating-point. |
✓ |
✓ |

double scalbn ( double x, int n ) Scale floating-point input by integer power of two. |
✓ |
✓ |

__RETURN_TYPE1 signbit ( double a ) Return the sign bit of the input. |
✓ |
✓ |

double sin ( double x ) Calculate the sine of the input argument. |
✓ |
✓ |

void sincos ( double x, double* sptr, double* cptr ) Calculate the sine and cosine of the first input argument. |
✓ |
✗ |

double sinh ( double x ) Calculate the hyperbolic sine of the input argument. |
✓ |
✓ |

double sqrt ( double x ) Calculate the square root of the input argument. |
✓ |
✓ |

double tan ( double x ) Calculate the tangent of the input argument. |
✓ |
✓ |

double tanh ( double x ) Calculate the hyperbolic tangent of the input argument. |
✓ |
✓ |

double tgamma ( double x ) Calculate the gamma function of the input argument. |
✓ |
✓ |

double trunc ( double x ) Truncate input argument to the integral part. |
✓ |
✓ |

double erfcinv ( double y ) Calculate the inverse complementary function of the input argument. |
✓ |
✓ |

double erfcx ( double x ) Calculate the scaled complementary error function of the input argument. |
✓ |
✓ |

double erfinv ( double y ) Calculate the inverse error function of the input argument. |
✓ |
✓ |

double frexp ( float x, int *nptr ) Extract mantissa and exponent of a floating-point value. |
✓ |
✓ |

double j0 ( double x ) Calculate the value of the Bessel function of the first kind of order 0 for the input argument. |
✓ |
✓ |

double j1 ( double x ) Calculate the value of the Bessel function of the first kind of order 1 for the input argument. |
✓ |
✓ |

double jn ( int n, double x ) Calculate the value of the Bessel function of the first kind of order n for the input argument. |
✓ |
✓ |

double lgamma ( double x ) Calculate the natural logarithm of the absolute value of the gamma function of the input argument. |
✓ |
✓ |

long long int llrint ( double x ) Round input to nearest integer value. |
✓ |
✓ |

long long int llround ( double x ) Round to nearest integer value. |
✓ |
✓ |

long int lrint ( double x ) Round input to nearest integer value. |
✓ |
✓ |

long int lround ( double x ) Round to nearest integer value. |
✓ |
✓ |

double modf ( double x, double *iptr ) Break down the input argument into fractional and integral parts. |
✓ |
✓ |

double nextafter ( double x, double y ) Returns next representable single-precision floating-point value after argument. |
✓ |
✓ |

double norm3d ( double a, double b, double c ) Calculate the square root of the sum of squares of three coordinates of the argument. |
✓ |
✓ |

float norm4d ( double a, double b, double c, double d ) Calculate the square root of the sum of squares of four coordinates of the argument. |
✓ |
✓ |

double normcdf ( double y ) Calculate the standard normal cumulative distribution function. |
✓ |
✓ |

double normcdfinv ( double y ) Calculate the inverse of the standard normal cumulative distribution function. |
✓ |
✓ |

double rcbrt ( double x ) Calculate the reciprocal cube root function. |
✓ |
✓ |

double remquo ( double x, double y, int *quo ) Compute single-precision floating-point remainder and part of quotient. |
✓ |
✓ |

double rhypot ( double x, double y ) Calculate one over the square root of the sum of squares of two arguments. |
✓ |
✓ |

double rint ( double x ) Round input to nearest integer value in floating-point. |
✓ |
✓ |

double rnorm3d ( double a, double b, double c ) Calculate one over the square root of the sum of squares of three coordinates of the argument. |
✓ |
✓ |

double rnorm4d ( double a, double b, double c, double d ) Calculate one over the square root of the sum of squares of four coordinates of the argument. |
✓ |
✓ |

double rnorm ( int dim, const double *a ) Calculate the reciprocal of square root of the sum of squares of any number of coordinates. |
✓ |
✓ |

double scalbln ( double x, long int n ) Scale floating-point input by integer power of two. |
✓ |
✓ |

void sincos ( double x, double *sptr, double *cptr ) Calculate the sine and cosine of the first input argument. |
✓ |
✓ |

void sincospi ( double x, double *sptr, double *cptr ) Calculate the sine and cosine of the first input argument multiplied by PI. |
✓ |
✓ |

double y0f ( double x ) Calculate the value of the Bessel function of the second kind of order 0 for the input argument. |
✓ |
✓ |

double y1 ( double x ) Calculate the value of the Bessel function of the second kind of order 1 for the input argument. |
✓ |
✓ |

double yn ( int n, double x ) Calculate the value of the Bessel function of the second kind of order n for the input argument. |
✓ |
✓ |

[1] __RETURN_TYPE is dependent on compiler. It is usually ‘int’ for C compilers and ‘bool’ for C++ compilers.

**Integer Intrinsics**

Following is the list of supported integer intrinsics. Note that intrinsics are supported on device only.

Function |
---|

unsigned int __brev ( unsigned int x ) Reverse the bit order of a 32 bit unsigned integer. |

unsigned long long int __brevll ( unsigned long long int x ) Reverse the bit order of a 64 bit unsigned integer. |

int __clz ( int x ) Return the number of consecutive high-order zero bits in a 32 bit integer. |

unsigned int __clz(unsigned int x) Return the number of consecutive high-order zero bits in 32 bit unsigned integer. |

int __clzll ( long long int x ) Count the number of consecutive high-order zero bits in a 64 bit integer. |

unsigned int __clzll(long long int x) Return the number of consecutive high-order zero bits in 64 bit signed integer. |

unsigned int __ffs(unsigned int x) Find the position of least signigicant bit set to 1 in a 32 bit unsigned integer.1 |

unsigned int __ffs(int x) Find the position of least signigicant bit set to 1 in a 32 bit signed integer. |

unsigned int __ffsll(unsigned long long int x) Find the position of least signigicant bit set to 1 in a 64 bit unsigned integer.1 |

unsigned int __ffsll(long long int x) Find the position of least signigicant bit set to 1 in a 64 bit signed integer. |

unsigned int __popc ( unsigned int x ) Count the number of bits that are set to 1 in a 32 bit integer. |

int __popcll ( unsigned long long int x ) Count the number of bits that are set to 1 in a 64 bit integer. |

int __mul24 ( int x int y ) Multiply two 24bit integers. |

unsigned int __umul24 ( unsigned int x unsigned int y ) Multiply two 24bit unsigned integers. |

[1] |

The hcc implementation of __ffs() and __ffsll() contains code to add a constant +1 to produce the ffs result format. |

For the cases where this overhead is not acceptable and programmer is willing to specialize for the platform |

hcc provides hc::__lastbit_u32_u32(unsigned int input) and hc::__lastbit_u32_u64(unsigned long long int input). |

The index returned by _lastbit instructions starts at -1 while for ffs the index starts at 0. |

**Floating-point Intrinsics**

Following is the list of supported floating-point intrinsics. Note that intrinsics are supported on device only.

Function |
---|

float __cosf ( float x ) Calculate the fast approximate cosine of the input argument. |

float __expf ( float x ) Calculate the fast approximate base e exponential of the input argument. |

float __frsqrt_rn ( float x ) Compute 1/√x in round-to-nearest-even mode. |

float __fsqrt_rd ( float x ) Compute √x in round-down mode. |

float __fsqrt_rn ( float x ) Compute √x in round-to-nearest-even mode. |

float __fsqrt_ru ( float x ) Compute √x in round-up mode. |

float __fsqrt_rz ( float x ) Compute √x in round-towards-zero mode. |

float __log10f ( float x ) Calculate the fast approximate base 10 logarithm of the input argument. |

float __log2f ( float x ) Calculate the fast approximate base 2 logarithm of the input argument. |

float __logf ( float x ) Calculate the fast approximate base e logarithm of the input argument. |

float __powf ( float x float y ) Calculate the fast approximate of xy. |

float __sinf ( float x ) Calculate the fast approximate sine of the input argument. |

float __tanf ( float x ) Calculate the fast approximate tangent of the input argument. |

double __dsqrt_rd ( double x ) Compute √x in round-down mode. |

double __dsqrt_rn ( double x ) Compute √x in round-to-nearest-even mode. |

double __dsqrt_ru ( double x ) Compute √x in round-up mode. |

double __dsqrt_rz ( double x ) Compute √x in round-towards-zero mode. |

## Texture Functions¶

Texture functions are not supported.

## Surface Functions¶

Surface functions are not supported.

## Timer Functions¶

HIP provides the following built-in functions for reading a high-resolution timer from the device.

```
clock_t clock()
long long int clock64()
```

Returns the value of counter that is incremented every clock cycle on device. Difference in values returned provides the cycles used.

## Atomic Functions¶

Atomic functions execute as read-modify-write operations residing in global or shared memory. No other device or thread can observe or modify the memory location during an atomic operation. If multiple instructions from different devices or threads target the same memory location, the instructions are serialized in an undefined order.

HIP supports the following atomic operations.

Function |
Supported in HIP |
Supported in CUDA |
---|---|---|

int atomicAdd(int* address, int val) |
✓ |
✓ |

unsigned int atomicAdd(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicAdd(unsigned long long int* address,unsigned long long int val) |
✓ |
✓ |

float atomicAdd(float* address, float val) |
✓ |
✓ |

int atomicSub(int* address, int val) |
✓ |
✓ |

unsigned int atomicSub(unsigned int* address,unsigned int val) |
✓ |
✓ |

int atomicExch(int* address, int val) |
✓ |
✓ |

unsigned int atomicExch(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicExch(unsigned long long int* address,unsigned long long int val) |
✓ |
✓ |

float atomicExch(float* address, float val) |
✓ |
✓ |

int atomicMin(int* address, int val) |
✓ |
✓ |

unsigned int atomicMin(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicMin(unsigned long long int* address,unsigned long long int val) |
✓ |
✓ |

int atomicMax(int* address, int val) |
✓ |
✓ |

unsigned int atomicMax(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicMax(unsigned long long int* address,unsigned long long int val) |
✓ |
✓ |

unsigned int atomicInc(unsigned int* address) |
✗ |
✓ |

unsigned int atomicDec(unsigned int* address) |
✗ |
✓ |

int atomicCAS(int* address, int compare, int val) |
✓ |
✓ |

unsigned int atomicCAS(unsigned int* address,unsigned int compare,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicCAS(unsigned long long int* address,unsigned long long int compare,unsigned long long int val) |
✓ |
✓ |

int atomicAnd(int* address, int val) |
✓ |
✓ |

unsigned int atomicAnd(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicAnd(unsigned long long int* address,unsigned long long int val) |
✓ |
✓ |

int atomicOr(int* address, int val) |
✓ |
✓ |

unsigned int atomicOr(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicOr(unsigned long long int* address,unsigned long long int val) |
✓ |
✓ |

int atomicXor(int* address, int val) |
✓ |
✓ |

unsigned int atomicXor(unsigned int* address,unsigned int val) |
✓ |
✓ |

unsigned long long int atomicXor(unsigned long long int* address,unsigned long long int val)) |
✓ |
✓ |

**Caveats and Features Under-Development:**

HIP enables atomic operations on 32-bit integers. Additionally, it supports an atomic float add. AMD hardware, however, implements the float add using a CAS loop, so this function may not perform efficiently.

## Warp Cross Lane Functions¶

Warp cross-lane functions operate across all lanes in a warp. The hardware guarantees that all warp lanes will execute in lockstep, so additional synchronization is unnecessary, and the instructions use no shared memory.

Note that Nvidia and AMD devices have different warp sizes, so portable code should use the warpSize built-ins to query the warp size. Hipified code from the Cuda path requires careful review to ensure it doesn’t assume a waveSize of 32. “Wave-aware” code that assumes a waveSize of 32 will run on a wave-64 machine, but it will utilize only half of the machine resources. In addition to the warpSize device function, host code can obtain the warpSize from the device properties:

```
cudaDeviceProp props;
cudaGetDeviceProperties(&props, deviceID);
int w = props.warpSize;
// implement portable algorithm based on w (rather than assume 32 or 64)
```

**Warp Vote and Ballot Functions**

int __all(int predicate) int __any(int predicate) uint64_t __ballot(int predicate)

Threads in a warp are referred to as lanes and are numbered from 0 to warpSize – 1. For these functions, each warp lane contributes 1 – the bit value (the predicate), which is efficiently broadcast to all lanes in the warp. The 32-bit int predicate from each lane reduces to a 1-bit value: 0 (predicate = 0) or 1 (predicate != 0). __any and __all provide a summary view of the predicates that the other warp lanes contribute:

__any() returns 1 if any warp lane contributes a nonzero predicate, or 0 otherwise

__all() returns 1 if all other warp lanes contribute nonzero predicates, or 0 otherwise

Applications can test whether the target platform supports the any/all instruction using the hasWarpVote device property or the HIP_ARCH_HAS_WARP_VOTE compiler define.

__ballot provides a bit mask containing the 1-bit predicate value from each lane. The nth bit of the result contains the 1 bit contributed by the nth warp lane. Note that HIP’s __ballot function supports a 64-bit return value (compared with Cuda’s 32 bits). Code ported from Cuda should support the larger warp sizes that the HIP version of this instruction supports. Applications can test whether the target platform supports the ballot instruction using the hasWarpBallot device property or the HIP_ARCH_HAS_WARP_BALLOT compiler define.

## Warp Shuffle Functions¶

Half-float shuffles are not supported. The default width is warpSize—see Warp Cross Lane Functions . Applications should not assume the warpSize is 32 or 64.

int __shfl (int var, int srcLane, int width=warpSize); float __shfl (float var, int srcLane, int width=warpSize); int __shfl_up (int var, unsigned int delta, int width=warpSize); float __shfl_up (float var, unsigned int delta, int width=warpSize); int __shfl_down (int var, unsigned int delta, int width=warpSize); float __shfl_down (float var, unsigned int delta, int width=warpSize) ; int __shfl_xor (int var, int laneMask, int width=warpSize) float __shfl_xor (float var, int laneMask, int width=warpSize);

## Profiler Counter Function¶

The Cuda __prof_trigger() instruction is not supported.

## Assert¶

The assert() and abort() functions are implemented for HIP device code.

**NOTE**: There may be a performance impact in the use of device assertions in its current form.

You may choose to disable the assertion in the production code. For example, to disable an assertion of:

*assert(foo != 0);*

you may comment it out as:

*//assert(foo != 0);*

**NOTE**: Assertions are currently enabled by default.

## Printf¶

HIP supports the use of *printf* in the device code. The parameters and return value for the device-side *printf* follow the POSIX.1 standard, with the exception that the “%n” specifier is not supported. No host side runtime calls by the application are needed to cause the output to appear. There is no limit on the number of device-side calls to *printf* or the amount of data that is printed.

## Device-Side Dynamic Global Memory Allocation¶

Device-side dynamic global memory allocation is under development. HIP now includes a preliminary implementation of malloc and free that can be called from device functions.

**__launch_bounds__**

GPU multiprocessors have a fixed pool of resources (primarily registers and shared memory) which are shared by the actively running warps. Using more resources can increase IPC of the kernel but reduces the resources available for other warps and limits the number of warps that can be simultaneously running. Thus GPUs have a complex relationship between resource usage and performance.

hip_launch_bounds allows the application to provide usage hints that influence the resources (primarily registers) used by the generated code. hip_launch_bounds is a function attribute that must be attached to a global function:

```
__global__ void `__launch_bounds__`(MAX_THREADS_PER_BLOCK, MIN_WARPS_PER_EU) MyKernel(...) ...
MyKernel(hipGridLaunch lp, ...)
...
```

launch_bounds supports two parameters:

MAX_THREADS_PER_BLOCK - The programmers guarantees that kernel will be launched with threads less than MAX_THREADS_PER_BLOCK. (On NVCC this maps to the .maxntid PTX directive). If no launch_bounds is specified, MAX_THREADS_PER_BLOCK is the maximum block size supported by the device (typically 1024 or larger). Specifying MAX_THREADS_PER_BLOCK less than the maximum effectively allows the compiler to use more resources than a default unconstrained compilation that supports all possible block sizes at launch time. The threads-per-block is the product of (hipBlockDim_x * hipBlockDim_y * hipBlockDim_z).

MIN_WARPS_PER_EU - directs the compiler to minimize resource usage so that the requested number of warps can be simultaneously active on a multi-processor. Since active warps compete for the same fixed pool of resources, the compiler must reduce resources required by each warp(primarily registers). MIN_WARPS_PER_EU is optional and defaults to 1 if not specified. Specifying a MIN_WARPS_PER_EU greater than the default 1 effectively constrains the compiler’s resource usage.

**Compiler Impact**

The compiler uses these parameters as follows:

The compiler uses the hints only to manage register usage, and does not automatically reduce shared memory or other resources.

Compilation fails if compiler cannot generate a kernel which meets the requirements of the specified launch bounds.

From MAX_THREADS_PER_BLOCK, the compiler derives the maximum number of warps/block that can be used at launch time. Values of MAX_THREADS_PER_BLOCK less than the default allows the compiler to use a larger pool of registers : each warp uses registers, and this hint contains the launch to a warps/block size which is less than maximum.

From MIN_WARPS_PER_EU, the compiler derives a maximum number of registers that can be used by the kernel (to meet the required simultaneous active blocks). If MIN_WARPS_PER_EU is 1, then the kernel can use all registers supported by the multiprocessor.

The compiler ensures that the registers used in the kernel is less than both allowed maximums, typically by spilling registers (to shared or global memory), or by using more instructions.

The compiler may use heuristics to increase register usage, or may simply be able to avoid spilling. The MAX_THREADS_PER_BLOCK is particularly useful in this cases, since it allows the compiler to use more registers and avoid situations where the compiler constrains the register usage (potentially spilling) to meet the requirements of a large block size that is never used at launch time.

**CU and EU Definitions**

A compute unit (CU) is responsible for executing the waves of a work-group. It is composed of one or more execution units (EU) which are responsible for executing waves. An EU can have enough resources to maintain the state of more than one executing wave. This allows an EU to hide latency by switching between waves in a similar way to symmetric multithreading on a CPU. In order to allow the state for multiple waves to fit on an EU, the resources used by a single wave have to be limited. Limiting such resources can allow greater latency hiding, but can result in having to spill some register state to memory. This attribute allows an advanced developer to tune the number of waves that are capable of fitting within the resources of an EU. It can be used to ensure at least a certain number will fit to help hide latency, and can also be used to ensure no more than a certain number will fit to limit cache thrashing.

**Porting from CUDA __launch_bounds**

CUDA defines a __launch_bounds which is also designed to control occupancy:

```
__launch_bounds(MAX_THREADS_PER_BLOCK, MIN_BLOCKS_PER_MULTIPROCESSOR)
* The second parameter __launch_bounds parameters must be converted to the format used __hip_launch_bounds, which uses warps and execution-units rather than blocks and multi-processors ( This conversion is performed automatically by the clang hipify tools.)
::
MIN_WARPS_PER_EXECUTION_UNIT = (MIN_BLOCKS_PER_MULTIPROCESSOR * MAX_THREADS_PER_BLOCK)/32
```

The key differences in the interface are:

Warps (rather than blocks): The developer is trying to tell the compiler to control resource utilization to guarantee some amount of active Warps/EU for latency hiding. Specifying active warps in terms of blocks appears to hide the micro-architectural details of the warp size, but makes the interface more confusing since the developer ultimately needs to compute the number of warps to obtain the desired level of control.

Execution Units (rather than multiProcessor): The use of execution units rather than multiprocessors provides support for architectures with multiple execution units/multi-processor. For example, the AMD GCN architecture has 4 execution units per multiProcessor. The hipDeviceProps has a field executionUnitsPerMultiprocessor. Platform-specific coding techniques such as #ifdef can be used to specify different launch_bounds for NVCC and HCC platforms, if desired.

**maxregcount**

Unlike nvcc, hcc does not support the “–maxregcount” option. Instead, users are encouraged to use the hip_launch_bounds directive since the parameters are more intuitive and portable than micro-architecture details like registers, and also the directive allows per-kernel control rather than an entire file. hip_launch_bounds works on both hcc and nvcc targets.

## Register Keyword¶

The register keyword is deprecated in C++, and is silently ignored by both nvcc and hcc. To see warnings, you can pass the option -Wdeprecated-register to hcc.

## Pragma Unroll¶

Unroll with a bounds that is known at compile-time is supported. For example:

```
#pragma unroll 16 /* hint to compiler to unroll next loop by 16 */
for (int i=0; i<16; i++) ...
```

```
#pragma unroll 1 /* tell compiler to never unroll the loop */
for (int i=0; i<16; i++) ...
```

Unbounded loop unroll is under development on HCC compiler.

```
#pragma unroll /* hint to compiler to completely unroll next loop. */
for (int i=0; i<16; i++) ...
```

## In-Line Assembly¶

In-line assembly, including in-line PTX, in-line HSAIL and in-line GCN ISA, is not supported. Users who need these features should employ conditional compilation to provide different functionally equivalent implementations on each target platform.

## C++ Support¶

The following C++ features are not supported:

Run-time-type information (RTTI)

Virtual functions

Try / catch

## Kernel Compilation¶

hipcc now supports compiling C++/HIP kernels to binary code objects. The user can specify the target for which the binary can be generated. HIP/HCC does not yet support fat binaries so only a single target may be specified. The file format for binary is .co which means Code Object. The following command builds the code object using hipcc.

```
hipcc --genco --target-isa=[TARGET GPU] [INPUT FILE] -o [OUTPUT FILE]
```

```
[INPUT FILE] = Name of the file containing kernels
[OUTPUT FILE] = Name of the generated code object file
```

Note that one important fact to remember when using binary code objects is that the number of arguments to the kernel are different on HCC and NVCC path. Refer to the sample in samples/0_Intro/module_api for differences in the arguments to be passed to the kernel.