Struct Queue 

pub struct Queue(/* private fields */);

The Queue connects a host program to a single device. Programs submit tasks to a device via the Queue and may monitor the Queue for completion. A program initiates the task by submitting a kernel.

Implementations

impl Queue

pub fn new() -> Self

Construct a Queue based on the device returned from the default selector.

pub fn new_immediate() -> Self

Construct an immediate Queue based on the device returned from the default selector.

pub fn get_context(&self) -> Context

Returns the SYCL queue’s context.

pub fn get_device(&self) -> Device

Returns the device the queue is associated with.

pub fn alloc_host<T: Pod>( &mut self, len: usize, ) -> Result<EnqueuedHostUsmBox<T>>

Allocates zeroed memory and creates a host-side UsmBox that can store an array of T.

pub fn alloc_shared<T: Pod>( &mut self, len: usize, ) -> Result<EnqueuedSharedUsmBox<T>>

Allocates zeroed memory and creates a shared UsmBox that can store an array of T.

pub fn alloc_device<T: Pod>( &mut self, len: usize, ) -> Result<EnqueuedDeviceUsmBox<T>>

Allocates zeroed memory and creates a device UsmBox that can store an array of T.

pub unsafe fn alloc_uninit_host<T>(&self, len: usize) -> HostUsmBox<T>

Allocates memory and creates a host-side UsmBox that can store an array of T. Safety: the array contents are uninitialized.

pub unsafe fn alloc_uninit_shared<T>(&self, len: usize) -> SharedUsmBox<T>

Allocates memory and creates a shared UsmBox that can store an array of T. Safety: the array contents are uninitialized.

pub unsafe fn alloc_uninit_device<T>(&self, len: usize) -> DeviceUsmBox<T>

Allocates memory and creates a device-side UsmBox that can store an array of T. Safety: the array contents are uninitialized.

pub unsafe fn memset<T, A: UsmAlloc>( &mut self, array: &mut UsmBox<T, A>, value: i32, ) -> Result<Event>

Sets memory allocated with USM allocations. Safety: the caller must make sure the underlying memory isn’t being aliased somewhere else.

pub unsafe fn memset_with_deps<T, A: UsmAlloc>( &mut self, array: &mut UsmBox<T, A>, value: i32, dep_events: &[&Event], ) -> Result<Event>

Sets memory allocated with USM allocations after all specified events finish. Safety: the caller must make sure the underlying memory isn’t being aliased somewhere else.

pub fn barrier(&mut self) -> Result<Event>

Submits a barrier to the queue.

pub fn barrier_with_deps(&mut self, dep_events: &[&Event]) -> Result<Event>

Submits a barrier to the queue after all specified events finish.

pub fn wait(&mut self) -> Result<()>

Performs a blocking wait for the completion of all enqueued tasks in the queue. Returns an error if a synchronous SYCL exception occurs.

Dropping the queue does not wait for its completion.

pub unsafe fn launch<const ARGC: usize, const DIMENSIONS: usize>( &mut self, nd_range: NdRange<DIMENSIONS>, kernel: &Kernel, args: impl KernelArgumentList<ARGC>, ) -> Result<Event>

where NdRange<DIMENSIONS>: ValidDimension,

Enqueues a kernel object to the queue as an ND-range kernel, using the number of work-items specified by the NdRange nd_range.

Safety: The caller must make sure each argument matches the launched SYCL kernel’s signature, including their respective size, layout and alignment.

pub fn copy<T, A1, A2>( &mut self, src: &UsmBox<T, A1>, dst: &mut UsmBox<T, A2>, ) -> Result<Event>

where T: Pod, A1: UsmAlloc, A2: UsmAlloc,

Copies the contents of the source array to the destination array.

Panics if the source and destination array lengths differ.

pub fn copy_with_deps<T, A1, A2>( &mut self, src: &UsmBox<T, A1>, dst: &mut UsmBox<T, A2>, dep_events: &[&Event], ) -> Result<Event>

where T: Pod, A1: UsmAlloc, A2: UsmAlloc,

Copies the contents of the source array to the destination array after all specified events finish.

Panics if the source and destination array lengths differ.

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<&Device> for Queue

fn from(value: &Device) -> Self

Converts to this type from the input type.

impl<T: UsmAllocatorKind> From<&Queue> for UsmAllocator<T>

fn from(queue: &Queue) -> Self

Converts to this type from the input type.

impl From<(&Context, &Device)> for Queue

fn from(value: (&Context, &Device)) -> Self

Converts to this type from the input type.

impl From<UniquePtr<Queue>> for Queue

fn from(value: UniquePtr<Queue>) -> Self

Converts to this type from the input type.