Struct CudaFlags

pub struct CudaFlags { /* private fields */ }

Bit flags for initializing the CUDA driver. Currently, no flags are defined, so CudaFlags::empty() is the only valid value.

Implementations

impl CudaFlags

pub const fn empty() -> CudaFlags

Returns an empty set of flags

Examples found in repository

examples/launch.rs (line 10)

fn main() -> Result<(), Box<dyn Error>> {
    // Set up the context, load the module, and create a stream to run kernels in.
    rustacuda::init(CudaFlags::empty())?;
    let device = Device::get_device(0)?;
    let _ctx = Context::create_and_push(ContextFlags::MAP_HOST | ContextFlags::SCHED_AUTO, device)?;

    let ptx = CString::new(include_str!("../resources/add.ptx"))?;
    let module = Module::load_from_string(&ptx)?;
    let stream = Stream::new(StreamFlags::NON_BLOCKING, None)?;

    // Create buffers for data
    let mut in_x = DeviceBuffer::from_slice(&[1.0f32; 10])?;
    let mut in_y = DeviceBuffer::from_slice(&[2.0f32; 10])?;
    let mut out_1 = DeviceBuffer::from_slice(&[0.0f32; 10])?;
    let mut out_2 = DeviceBuffer::from_slice(&[0.0f32; 10])?;

    // This kernel adds each element in `in_x` and `in_y` and writes the result into `out`.
    unsafe {
        // Launch the kernel with one block of one thread, no dynamic shared memory on `stream`.
        let result = launch!(module.sum<<<1, 1, 0, stream>>>(
            in_x.as_device_ptr(),
            in_y.as_device_ptr(),
            out_1.as_device_ptr(),
            out_1.len()
        ));
        result?;

        // Launch the kernel again using the `function` form:
        let function_name = CString::new("sum")?;
        let sum = module.get_function(&function_name)?;
        // Launch with 1x1x1 (1) blocks of 10x1x1 (10) threads, to show that you can use tuples to
        // configure grid and block size.
        let result = launch!(sum<<<(1, 1, 1), (10, 1, 1), 0, stream>>>(
            in_x.as_device_ptr(),
            in_y.as_device_ptr(),
            out_2.as_device_ptr(),
            out_2.len()
        ));
        result?;
    }

    // Kernel launches are asynchronous, so we wait for the kernels to finish executing.
    stream.synchronize()?;

    // Copy the results back to host memory
    let mut out_host = [0.0f32; 20];
    out_1.copy_to(&mut out_host[0..10])?;
    out_2.copy_to(&mut out_host[10..20])?;

    for x in out_host.iter() {
        assert_eq!(3.0 as u32, *x as u32);
    }

    println!("Launched kernel successfully.");
    Ok(())
}

pub const fn all() -> CudaFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<CudaFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> CudaFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> CudaFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: CudaFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: CudaFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: CudaFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: CudaFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: CudaFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: CudaFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for CudaFlags

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

Formats the value using the given formatter.

impl BitAnd for CudaFlags

fn bitand(self, other: CudaFlags) -> CudaFlags

Returns the intersection between the two sets of flags.

type Output = CudaFlags

The resulting type after applying the & operator.

impl BitAndAssign for CudaFlags

fn bitand_assign(&mut self, other: CudaFlags)

Disables all flags disabled in the set.

impl BitOr for CudaFlags

fn bitor(self, other: CudaFlags) -> CudaFlags

Returns the union of the two sets of flags.

type Output = CudaFlags

The resulting type after applying the | operator.

impl BitOrAssign for CudaFlags

fn bitor_assign(&mut self, other: CudaFlags)

Adds the set of flags.

impl BitXor for CudaFlags

fn bitxor(self, other: CudaFlags) -> CudaFlags

Returns the left flags, but with all the right flags toggled.

type Output = CudaFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for CudaFlags

fn bitxor_assign(&mut self, other: CudaFlags)

Toggles the set of flags.

impl Clone for CudaFlags

fn clone(&self) -> CudaFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CudaFlags

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

Formats the value using the given formatter.

impl Extend<CudaFlags> for CudaFlags

fn extend<T: IntoIterator<Item = CudaFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<CudaFlags> for CudaFlags

fn from_iter<T: IntoIterator<Item = CudaFlags>>(iterator: T) -> CudaFlags

Creates a value from an iterator.

impl Hash for CudaFlags

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 LowerHex for CudaFlags

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

Formats the value using the given formatter.

impl Not for CudaFlags

fn not(self) -> CudaFlags

Returns the complement of this set of flags.

type Output = CudaFlags

The resulting type after applying the ! operator.

impl Octal for CudaFlags

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

Formats the value using the given formatter.

impl Ord for CudaFlags

fn cmp(&self, other: &CudaFlags) -> 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 CudaFlags

fn eq(&self, other: &CudaFlags) -> 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 CudaFlags

fn partial_cmp(&self, other: &CudaFlags) -> 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 Sub for CudaFlags

fn sub(self, other: CudaFlags) -> CudaFlags

Returns the set difference of the two sets of flags.

type Output = CudaFlags

The resulting type after applying the - operator.

impl SubAssign for CudaFlags

fn sub_assign(&mut self, other: CudaFlags)

Disables all flags enabled in the set.

impl UpperHex for CudaFlags

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

Formats the value using the given formatter.

impl Copy for CudaFlags

impl Eq for CudaFlags

impl StructuralPartialEq for CudaFlags