Context Management [Deprecated]

Context Management [Deprecated]#

HIP Runtime API Reference: Context Management [Deprecated]

Collaboration diagram for Context Management [Deprecated]:

Functions
hipError_t	hipCtxCreate (hipCtx_t *ctx, unsigned int flags, hipDevice_t device)
	Create a context and set it as current/default context.

hipError_t	hipCtxDestroy (hipCtx_t ctx)
	Destroy a HIP context.

hipError_t	hipCtxPopCurrent (hipCtx_t *ctx)
	Pop the current/default context and return the popped context.

hipError_t	hipCtxPushCurrent (hipCtx_t ctx)
	Push the context to be set as current/ default context.

hipError_t	hipCtxSetCurrent (hipCtx_t ctx)
	Set the passed context as current/default.

hipError_t	hipCtxGetCurrent (hipCtx_t *ctx)
	Get the handle of the current/ default context.

hipError_t	hipCtxGetDevice (hipDevice_t *device)
	Get the handle of the device associated with current/default context.

hipError_t	hipCtxGetApiVersion (hipCtx_t ctx, int *apiVersion)
	Returns the approximate HIP api version.

hipError_t	hipCtxGetCacheConfig (hipFuncCache_t *cacheConfig)
	Get Cache configuration for a specific function.

hipError_t	hipCtxSetCacheConfig (hipFuncCache_t cacheConfig)
	Set L1/Shared cache partition.

hipError_t	hipCtxSetSharedMemConfig (hipSharedMemConfig config)
	Set Shared memory bank configuration.

hipError_t	hipCtxGetSharedMemConfig (hipSharedMemConfig *pConfig)
	Get Shared memory bank configuration.

hipError_t	hipCtxSynchronize (void)
	Blocks until the default context has completed all preceding requested tasks.

hipError_t	hipCtxGetFlags (unsigned int *flags)
	Return flags used for creating default context.

hipError_t	hipCtxEnablePeerAccess (hipCtx_t peerCtx, unsigned int flags)
	Enables direct access to memory allocations in a peer context.

hipError_t	hipCtxDisablePeerAccess (hipCtx_t peerCtx)
	Disable direct access from current context's virtual address space to memory allocations physically located on a peer context.Disables direct access to memory allocations in a peer context and unregisters any registered allocations.

Detailed Description

This section describes the deprecated context management functions of HIP runtime API.

Function Documentation

◆ hipCtxCreate()

hipError_t hipCtxCreate	(	hipCtx_t *	ctx,
		unsigned int	flags,
		hipDevice_t	device
	)

Create a context and set it as current/default context.

Parameters

[out]	ctx	Context to create
[in]	flags	Context creation flags
[in]	device	device handle

Returns: hipSuccess

See also: hipCtxDestroy, hipCtxGetFlags, hipCtxPopCurrent, hipCtxGetCurrent, hipCtxPushCurrent, hipCtxSetCacheConfig, hipCtxSynchronize, hipCtxGetDevice

Warning: : This HIP API is deprecated.

◆ hipCtxDestroy()

hipError_t hipCtxDestroy ( hipCtx_t ctx )

Destroy a HIP context.

Parameters

[in] ctx Context to destroy

Returns: hipSuccess, hipErrorInvalidValue

See also: hipCtxCreate, hipCtxGetFlags, hipCtxPopCurrent, hipCtxGetCurrent,hipCtxSetCurrent, hipCtxPushCurrent, hipCtxSetCacheConfig, hipCtxSynchronize , hipCtxGetDevice

Warning: : This HIP API is deprecated.

◆ hipCtxDisablePeerAccess()

hipError_t hipCtxDisablePeerAccess ( hipCtx_t peerCtx )

Disable direct access from current context's virtual address space to memory allocations physically located on a peer context.Disables direct access to memory allocations in a peer context and unregisters any registered allocations.

Returns hipErrorPeerAccessNotEnabled if direct access to memory on peerDevice has not yet been enabled from the current device.

Parameters

[in] peerCtx Peer context to be disabled

Returns: hipSuccess, hipErrorPeerAccessNotEnabled

See also: hipCtxCreate, hipCtxDestroy, hipCtxGetFlags, hipCtxPopCurrent, hipCtxGetCurrent, hipCtxSetCurrent, hipCtxPushCurrent, hipCtxSetCacheConfig, hipCtxSynchronize, hipCtxGetDevice

Warning: PeerToPeer support is experimental.; : This HIP API is deprecated.

◆ hipCtxEnablePeerAccess()

hipError_t hipCtxEnablePeerAccess	(	hipCtx_t	peerCtx,
		unsigned int	flags
	)

Enables direct access to memory allocations in a peer context.

Memory which already allocated on peer device will be mapped into the address space of the current device. In addition, all future memory allocations on peerDeviceId will be mapped into the address space of the current device when the memory is allocated. The peer memory remains accessible from the current device until a call to hipDeviceDisablePeerAccess or hipDeviceReset.

Parameters

[in]	peerCtx	Peer context
[in]	flags	flags, need to set as 0

Returns: hipSuccess, hipErrorInvalidDevice, hipErrorInvalidValue, hipErrorPeerAccessAlreadyEnabled

See also: hipCtxCreate, hipCtxDestroy, hipCtxGetFlags, hipCtxPopCurrent, hipCtxGetCurrent, hipCtxSetCurrent, hipCtxPushCurrent, hipCtxSetCacheConfig, hipCtxSynchronize, hipCtxGetDevice

Warning: PeerToPeer support is experimental.; : This HIP API is deprecated.

◆ hipCtxGetApiVersion()

hipError_t hipCtxGetApiVersion	(	hipCtx_t	ctx,
		int *	apiVersion
	)

Returns the approximate HIP api version.

Parameters

[in]	ctx	Context to check
[out]	apiVersion

Returns: hipSuccess

Warning: The HIP feature set does not correspond to an exact CUDA SDK api revision. This function always set *apiVersion to 4 as an approximation though HIP supports some features which were introduced in later CUDA SDK revisions. HIP apps code should not rely on the api revision number here and should use arch feature flags to test device capabilities or conditional compilation.