Struct melior::dialect::ods::memref::AllocaOperation

pub struct AllocaOperation<'c> { /* private fields */ }

An alloca operation. Stack memory allocation operation.

The alloca operation allocates memory on the stack, to be automatically released when control transfers back from the region of its closest surrounding operation with an AutomaticAllocationScope trait. The amount of memory allocated is specified by its memref and additional operands. For example:

%0 = memref.alloca() : memref<8x64xf32>

The optional list of dimension operands are bound to the dynamic dimensions specified in its memref type. In the example below, the SSA value ‘%d’ is bound to the second dimension of the memref (which is dynamic).

%0 = memref.alloca(%d) : memref<8x?xf32>

The optional list of symbol operands are bound to the symbols of the memref’s affine map. In the example below, the SSA value ‘%s’ is bound to the symbol ‘s0’ in the affine map specified in the allocs memref type.

%0 = memref.alloca()[%s] : memref<8x64xf32,
                           affine_map<(d0, d1)[s0] -> ((d0 + s0), d1)>>

This operation returns a single SSA value of memref type, which can be used by subsequent load and store operations. An optional alignment attribute, if specified, guarantees alignment at least to that boundary. If not specified, an alignment on any convenient boundary compatible with the type will be chosen.

Implementations

impl<'c> AllocaOperation<'c>

pub fn name() -> &'static str

Returns a name.

pub fn as_operation(&self) -> &Operation<'c>

Returns a generic operation.

pub fn builder( context: &'c Context, location: Location<'c> ) -> AllocaOperationBuilder<'c, Unset, Unset, Unset>

Creates a builder.

pub fn memref(&self) -> Result<OperationResult<'c, '_>, Error>

pub fn dynamic_sizes( &self ) -> Result<impl Iterator<Item = Value<'c, '_>>, Error>

pub fn symbol_operands( &self ) -> Result<impl Iterator<Item = Value<'c, '_>>, Error>

pub fn alignment(&self) -> Result<IntegerAttribute<'c>, Error>

pub fn set_alignment(&mut self, value: IntegerAttribute<'c>)

pub fn remove_alignment(&mut self) -> Result<(), Error>

Trait Implementations

impl<'c> From<AllocaOperation<'c>> for Operation<'c>

fn from(operation: AllocaOperation<'c>) -> Self

Converts to this type from the input type.

impl<'c> TryFrom<Operation<'c>> for AllocaOperation<'c>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(operation: Operation<'c>) -> Result<Self, Self::Error>

Performs the conversion.