Launch API to support the triple-chevron syntax

Functions
hipError_t	hipConfigureCall (dim3 gridDim, dim3 blockDim, size_t sharedMem __dparm(0), hipStream_t stream __dparm(0))
	Configure a kernel launch. More...
hipError_t	hipSetupArgument (const void *arg, size_t size, size_t offset)
	Set a kernel argument. More...
hipError_t	hipLaunchByPtr (const void *func)
	Launch a kernel. More...
hipError_t	__hipPushCallConfiguration (dim3 gridDim, dim3 blockDim, size_t sharedMem __dparm(0), hipStream_t stream __dparm(0))
	Push configuration of a kernel launch. More...
hipError_t	__hipPopCallConfiguration (dim3 *gridDim, dim3 *blockDim, size_t *sharedMem, hipStream_t *stream)
	Pop configuration of a kernel launch. More...
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. More...

Detailed Description

----------------------------------------------------------------------------------------------—

Function Documentation

hipError_t __hipPopCallConfiguration	(	dim3 *	gridDim,
		dim3 *	blockDim,
		size_t *	sharedMem,
		hipStream_t *	stream
	)

Pop configuration of a kernel launch.

Parameters

[out]	gridDim	grid dimension specified as multiple of blockDim.
[out]	blockDim	block dimensions specified in work-items
[out]	sharedMem	Amount of dynamic shared memory to allocate for this kernel. The kernel can access this with HIP_DYNAMIC_SHARED.
[out]	stream	Stream where the kernel should be dispatched. May be 0, in which case the default stream is used with associated synchronization rules.

Returns

hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue

hipError_t __hipPushCallConfiguration	(	dim3	gridDim,
		dim3	blockDim,
		size_t sharedMem	__dparm0,
		hipStream_t stream	__dparm0
	)

Push configuration of a kernel launch.

Parameters

[in]	gridDim	grid dimension specified as multiple of blockDim.
[in]	blockDim	block dimensions specified in work-items
[in]	sharedMem	Amount of dynamic shared memory to allocate for this kernel. The kernel can access this with HIP_DYNAMIC_SHARED.
[in]	stream	Stream where the kernel should be dispatched. May be 0, in which case the default stream is used with associated synchronization rules.

Returns

hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue

hipError_t hipConfigureCall	(	dim3	gridDim,
		dim3	blockDim,
		size_t sharedMem	__dparm0,
		hipStream_t stream	__dparm0
	)

Configure a kernel launch.

Parameters

[in]	gridDim	grid dimension specified as multiple of blockDim.
[in]	blockDim	block dimensions specified in work-items
[in]	sharedMem	Amount of dynamic shared memory to allocate for this kernel. The kernel can access this with HIP_DYNAMIC_SHARED.
[in]	stream	Stream where the kernel should be dispatched. May be 0, in which case the default stream is used with associated synchronization rules.

Returns

hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue

hipError_t hipLaunchByPtr

(

const void *

func

)

Launch a kernel.

Parameters

[in]

func

Kernel to launch.

Returns

hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue

hipError_t hipLaunchKernel	(	const void *	function_address,
		dim3	numBlocks,
		dim3	dimBlocks,
		void **	args,
		size_t sharedMemBytes	__dparm0,
		hipStream_t stream	__dparm0
	)

C compliant kernel launch API.

Parameters

[in]	function_address	- kernel stub function pointer.
[in]	numBlocks	- number of blocks
[in]	dimBlocks	- dimension of a block
[in]	args	- kernel arguments
[in]	sharedMemBytes	- Amount of dynamic shared memory to allocate for this kernel. The Kernel can access this with HIP_DYNAMIC_SHARED.
[in]	stream	- Stream where the kernel should be dispatched. May be 0, in which case th default stream is used with associated synchronization rules.

Returns

#hipSuccess, #hipErrorInvalidValue, hipInvalidDevice

hipError_t hipSetupArgument	(	const void *	arg,
		size_t	size,
		size_t	offset
	)

Set a kernel argument.

Returns

hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue

Parameters

[in]	arg	Pointer the argument in host memory.
[in]	size	Size of the argument.
[in]	offset	Offset of the argument on the argument stack.