Skip to main content

Stream

Struct Stream 

Source
pub struct Stream { /* private fields */ }
Expand description

A CUDA stream (GPU command queue).

Streams provide ordered, asynchronous execution of GPU commands. Commands enqueued on the same stream execute sequentially, while commands on different streams may execute concurrently.

The stream holds an Arc<Context> to ensure the parent context outlives the stream.

§A Stream is a shared handle, not a unique owner

Cloning yields a second handle to the same queue — Stream::raw returns the same CUstream — and the queue is destroyed once the last handle drops. That is what lets two subsystems which each want to hold “their” stream be collapsed onto one queue: oxicuda-dnn’s DnnHandle and the BlasHandle nested inside it now share one, so a convolution’s output is ordered before a GEMM that reads it by stream semantics alone — no event choreography, no host rendezvous, and a capture of the pair is a linear chain rather than a fork/join.

Clone is written out rather than derived so the doc comment can say what it means: this is another reference to one queue, not a copy of it.

Implementations§

Source§

impl Stream

Source

pub fn new(ctx: &Arc<Context>) -> CudaResult<Self>

Creates a new stream with CU_STREAM_NON_BLOCKING flag.

Non-blocking streams do not implicitly synchronise with the default (NULL) stream, allowing maximum concurrency.

§Errors

Returns a CudaError if the driver call fails (e.g. invalid context, out of resources).

Source

pub fn with_priority(ctx: &Arc<Context>, priority: i32) -> CudaResult<Self>

Creates a new stream with the specified priority and CU_STREAM_NON_BLOCKING flag.

Lower numerical values indicate higher priority. The valid range can be queried via cuCtxGetStreamPriorityRange.

§Errors

Returns a CudaError if the priority is out of range or the driver call otherwise fails.

Source

pub fn synchronize(&self) -> CudaResult<()>

Blocks the calling thread until all previously enqueued commands in this stream have completed.

§Errors

Returns a CudaError if any enqueued operation failed or the driver reports an error.

Source

pub fn wait_event(&self, event: &Event) -> CudaResult<()>

Makes all future work submitted to this stream wait until the given event has been recorded and completed.

This is the primary mechanism for inter-stream synchronisation: record an Event on one stream, then call wait_event on another stream to establish an ordering dependency.

§Errors

Returns a CudaError if the driver call fails (e.g. invalid event handle).

Source

pub fn raw(&self) -> CUstream

Returns the raw CUstream handle.

§Safety (caller)

The caller must not destroy or otherwise invalidate the handle while this Stream is still alive.

Source

pub fn is_same_queue(&self, other: &Self) -> bool

Whether self and other are handles to the same driver queue.

The question a caller asks before deciding that stream order alone sequences two pieces of work: on one queue it does, on two it does not and an event is required. Compares the driver handle rather than the Arc, so a queue reached through two independently-built handles (were that ever possible) still answers truthfully.

Source

pub fn context(&self) -> &Arc<Context>

Returns a reference to the parent Context.

Trait Implementations§

Source§

impl Clone for Stream

Source§

fn clone(&self) -> Self

Another handle to the same queue. See the type docs.

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more