Struct melior::dialect::ods::llvm::GEPOperation

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

A getelementptr operation.

This operation mirrors LLVM IRs ‘getelementptr’ operation that is used to perform pointer arithmetic.

Like in LLVM IR, it is possible to use both constants as well as SSA values as indices. In the case of indexing within a structure, it is required to either use constant indices directly, or supply a constant SSA value.

An optional ‘inbounds’ attribute specifies the low-level pointer arithmetic overflow behavior that LLVM uses after lowering the operation to LLVM IR.

Examples:

// GEP with an SSA value offset
%0 = llvm.getelementptr %1[%2] : (!llvm.ptr<f32>, i64) -> !llvm.ptr<f32>

// GEP with a constant offset and the inbounds attribute set
%0 = llvm.getelementptr inbounds %1[3] : (!llvm.ptr<f32>) -> !llvm.ptr<f32>

// GEP with constant offsets into a structure
%0 = llvm.getelementptr %1[0, 1]
   : (!llvm.ptr<struct(i32, f32)>) -> !llvm.ptr<f32>

Implementations

impl<'c> GEPOperation<'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> ) -> GEPOperationBuilder<'c, Unset, Unset, Unset, Unset>

Creates a builder.

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

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

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

pub fn raw_constant_indices(&self) -> Result<DenseI32ArrayAttribute<'c>, Error>

pub fn set_raw_constant_indices(&mut self, value: DenseI32ArrayAttribute<'c>)

pub fn elem_type(&self) -> Result<TypeAttribute<'c>, Error>

pub fn set_elem_type(&mut self, value: TypeAttribute<'c>)

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

pub fn inbounds(&self) -> Result<Attribute<'c>, Error>

pub fn set_inbounds(&mut self, value: Attribute<'c>)

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

Trait Implementations

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

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

Converts to this type from the input type.

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