Struct melior::dialect::ods::memref::ExtractStridedMetadataOperation

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

An extract_strided_metadata operation. Extracts a buffer base with offset and strides.

Extracts a base buffer, offset and strides. This op allows additional layers of transformations and foldings to be added as lowering progresses from higher-level dialect to lower-level dialects such as the LLVM dialect.

The op requires a strided memref source operand. If the source operand is not a strided memref, then verification fails.

This operation is also useful for completeness to the existing memref.dim op. While accessing strides, offsets and the base pointer independently is not available, this is useful for composing with its natural complement op: memref.reinterpret_cast.

Intended Use Cases:

The main use case is to expose the logic for manipulate memref metadata at a higher level than the LLVM dialect. This makes lowering more progressive and brings the following benefits:

• not all users of MLIR want to lower to LLVM and the information to e.g. lower to library calls—like libxsmm—or to SPIR-V was not available.
• foldings and canonicalizations can happen at a higher level in MLIR: before this op existed, lowering to LLVM would create large amounts of LLVMIR. Even when LLVM does a good job at folding the low-level IR from a performance perspective, it is unnecessarily opaque and inefficient to send unkempt IR to LLVM.

Example:

  %base, %offset, %sizes:2, %strides:2 =
    memref.extract_strided_metadata %memref :
      memref<10x?xf32>, index, index, index, index, index

  // After folding, the type of %m2 can be memref<10x?xf32> and further
  // folded to %memref.
  %m2 = memref.reinterpret_cast %base to
      offset: [%offset],
      sizes: [%sizes#0, %sizes#1],
      strides: [%strides#0, %strides#1]
    : memref<f32> to memref<?x?xf32, offset: ?, strides: [?, ?]>

Implementations

impl<'c> ExtractStridedMetadataOperation<'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> ) -> ExtractStridedMetadataOperationBuilder<'c, Unset>

Creates a builder.

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

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

pub fn sizes(&self) -> impl Iterator<Item = OperationResult<'c, '_>>

pub fn strides(&self) -> impl Iterator<Item = OperationResult<'c, '_>>

pub fn source(&self) -> Result<Value<'c, '_>, Error>

Trait Implementations

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

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

Converts to this type from the input type.

impl<'c> TryFrom<Operation<'c>> for ExtractStridedMetadataOperation<'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.