Struct HsaKernelDispatchPacket

#[repr(C)]
pub struct HsaKernelDispatchPacket {

    pub header: u16,
    pub setup: u16,
    pub workgroup_size_x: u16,
    pub workgroup_size_y: u16,
    pub workgroup_size_z: u16,
    pub reserved0: u16,
    pub grid_size_x: u32,
    pub grid_size_y: u32,
    pub grid_size_z: u32,
    pub private_segment_size: u32,
    pub group_segment_size: u32,
    pub kernel_object: u64,
    pub kernarg_address: *mut c_void,
    pub reserved2: u64,
    pub completion_signal: HsaSignal,
}

HSA packet to dispatch a kernel.

A pointer to the packet that was used to dispatch the currently running kernel can be obtained with dispatch_ptr.

Fields

header: u16

Packet header. Used to configure multiple packet parameters such as the packet type. The parameters are described by hsa_packet_header_t.

setup: u16

Dispatch setup parameters. Used to configure kernel dispatch parameters such as the number of dimensions in the grid. The parameters are described by hsa_kernel_dispatch_packet_setup_t.

workgroup_size_x: u16

X dimension of work-group, in work-items. Must be greater than 0.

workgroup_size_y: u16

Y dimension of work-group, in work-items. Must be greater than 0. If the grid has 1 dimension, the only valid value is 1.

workgroup_size_z: u16

Z dimension of work-group, in work-items. Must be greater than 0. If the grid has 1 or 2 dimensions, the only valid value is 1.

reserved0: u16

Reserved. Must be 0.

grid_size_x: u32

X dimension of grid, in work-items. Must be greater than 0. Must not be smaller than @a workgroup_size_x.

grid_size_y: u32

Y dimension of grid, in work-items. Must be greater than 0. If the grid has 1 dimension, the only valid value is 1. Must not be smaller than @a workgroup_size_y.

grid_size_z: u32

Z dimension of grid, in work-items. Must be greater than 0. If the grid has 1 or 2 dimensions, the only valid value is 1. Must not be smaller than @a workgroup_size_z.

private_segment_size: u32

Size in bytes of private memory allocation request (per work-item).

group_segment_size: u32

Size in bytes of group memory allocation request (per work-group). Must not be less than the sum of the group memory used by the kernel (and the functions it calls directly or indirectly) and the dynamically allocated group segment variables.

kernel_object: u64

Opaque handle to a code object that includes an implementation-defined executable code for the kernel.

kernarg_address: *mut c_void

Pointer to the kernel arguments.

reserved2: u64

Reserved. Must be 0.

completion_signal: HsaSignal

Signal used to indicate completion of the job. The application can use the special signal handle 0 to indicate that no signal is used.

Trait Implementations

impl Clone for HsaKernelDispatchPacket

fn clone(&self) -> HsaKernelDispatchPacket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HsaKernelDispatchPacket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for HsaKernelDispatchPacket

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HsaKernelDispatchPacket

fn cmp(&self, other: &HsaKernelDispatchPacket) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HsaKernelDispatchPacket

fn eq(&self, other: &HsaKernelDispatchPacket) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for HsaKernelDispatchPacket

fn partial_cmp(&self, other: &HsaKernelDispatchPacket) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for HsaKernelDispatchPacket

impl StructuralPartialEq for HsaKernelDispatchPacket