Skip to main content

LaunchParams

Struct LaunchParams 

Source
pub struct LaunchParams {
    pub grid: Dim3,
    pub block: Dim3,
    pub shared_mem_bytes: u32,
}
Expand description

Parameters for a GPU kernel launch.

Specifies the execution configuration: grid size (number of blocks), block size (threads per block), and dynamic shared memory allocation.

§Examples

use oxicuda_launch::{LaunchParams, Dim3};

let params = LaunchParams::new(Dim3::x(256), Dim3::x(256));
assert_eq!(params.grid, Dim3::x(256));
assert_eq!(params.block, Dim3::x(256));
assert_eq!(params.shared_mem_bytes, 0);

Fields§

§grid: Dim3

Grid dimensions (number of thread blocks in each dimension).

§block: Dim3

Block dimensions (number of threads per block in each dimension).

§shared_mem_bytes: u32

Dynamic shared memory allocation in bytes (default 0).

Implementations§

Source§

impl LaunchParams

Source

pub fn new(grid: impl Into<Dim3>, block: impl Into<Dim3>) -> Self

Creates new launch parameters with the given grid and block dimensions.

Shared memory defaults to 0 bytes. Use with_shared_mem to specify dynamic shared memory.

Both grid and block accept anything that converts to Dim3, including u32, (u32, u32), and (u32, u32, u32).

Source

pub fn with_shared_mem(self, bytes: u32) -> Self

Sets the dynamic shared memory allocation in bytes.

Returns self for method chaining.

Source

pub fn builder() -> LaunchParamsBuilder

Returns a LaunchParamsBuilder for incremental configuration.

Source

pub fn total_threads(&self) -> u64

Total number of threads in the launch (grid total * block total).

Returns a u64 to avoid overflow when grid and block totals are both large u32 values.

Source

pub fn validate(&self, device: &Device) -> Result<(), Box<dyn Error>>

Validates launch parameters against device hardware limits.

Checks that:

  • All block and grid dimensions are non-zero.
  • The total threads per block does not exceed the device maximum.
  • Each block dimension does not exceed its per-axis device maximum.
  • Each grid dimension does not exceed its per-axis device maximum.
  • The dynamic shared memory does not exceed the device maximum per block.
§Errors

Returns a LaunchError describing the first constraint violation found, or a CudaError if device attribute queries fail.

§Examples
use oxicuda_launch::{LaunchParams, Dim3};
use oxicuda_driver::device::Device;

oxicuda_driver::init()?;
let dev = Device::get(0)?;
let params = LaunchParams::new(256u32, 256u32);
params.validate(&dev)?;

Trait Implementations§

Source§

impl Clone for LaunchParams

Source§

fn clone(&self) -> LaunchParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LaunchParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for LaunchParams

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