hipStreamBatchMemOpParams Union Reference

hipStreamBatchMemOpParams Union Reference#

HIP Runtime API Reference: hipStreamBatchMemOpParams Union Reference

Union representing batch memory operation parameters for HIP streams. More...

#include <hip_runtime_api.h>

Collaboration diagram for hipStreamBatchMemOpParams:

Data Structures
struct	hipStreamMemOpFlushRemoteWritesParams_t

struct	hipStreamMemOpMemoryBarrierParams_t

struct	hipStreamMemOpWaitValueParams_t

struct	hipStreamMemOpWriteValueParams_t

Data Fields
hipStreamBatchMemOpType	operation

struct hipStreamBatchMemOpParams::hipStreamMemOpWaitValueParams_t	waitValue

struct hipStreamBatchMemOpParams::hipStreamMemOpWriteValueParams_t	writeValue

struct hipStreamBatchMemOpParams::hipStreamMemOpFlushRemoteWritesParams_t	flushRemoteWrites
	Currently not supported on AMD.

struct hipStreamBatchMemOpParams::hipStreamMemOpMemoryBarrierParams_t	memoryBarrier
	Currently not supported on AMD.

uint64_t	pad [6]

Detailed Description

Union representing batch memory operation parameters for HIP streams.

hipStreamBatchMemOpParams is used to specify the parameters for batch memory operations in a HIP stream. This union supports various operations including waiting for a specific value, writing a value, and different flags for wait conditions.

The union includes fields for different types of operations defined in the enum hipStreamBatchMemOpType:

hipStreamMemOpWaitValue32: Wait for a 32-bit value.
hipStreamMemOpWriteValue32: Write a 32-bit value.
hipStreamMemOpWaitValue64: Wait for a 64-bit value.
hipStreamMemOpWriteValue64: Write a 64-bit value.

Each operation type includes an address, the value to wait for or write, flags, and an optional alias that is not relevant on AMD GPUs. Flags can be used to specify different wait conditions such as equality, bitwise AND, greater than or equal, and bitwise NOR.

Example usage:

hipStreamBatchMemOpParams myArray[2];
myArray[0].operation = hipStreamMemOpWaitValue32;
myArray[0].waitValue.address = waitAddr1;
myArray[0].waitValue.value = 0x1;
myArray[0].waitValue.flags = CU_STREAM_WAIT_VALUE_EQ;
 
myArray[1].operation = hipStreamMemOpWriteValue32;
myArray[1].writeValue.address = writeAddr1;
myArray[1].writeValue.value = 0x1;
myArray[1].writeValue.flags = 0x0;
 
result = hipStreamBatchMemOp(stream, 2, myArray, 0);