Struct inkwell::values::InstructionValue

pub struct InstructionValue<'ctx> { /* private fields */ }

Implementations

impl<'ctx> InstructionValue<'ctx>

pub unsafe fn new(instruction_value: LLVMValueRef) -> Self

Get a value from an LLVMValueRef.

Safety

The ref must be valid and of type instruction.

pub fn explicit_clone(&self) -> Self

Creates a clone of this InstructionValue, and returns it. The clone will have no parent, and no name.

pub fn get_name(&self) -> Option<&CStr>

Get name of the InstructionValue.

pub fn get_instruction_with_name( &self, name: &str, ) -> Option<InstructionValue<'ctx>>

Get a instruction with it’s name Compares against all instructions after self, and self.

pub fn set_name(&self, name: &str) -> Result<(), &'static str>

Set name of the InstructionValue.

pub fn get_type(self) -> AnyTypeEnum<'ctx>

Get type of the current InstructionValue

pub fn get_opcode(self) -> InstructionOpcode

pub fn get_previous_instruction(self) -> Option<Self>

pub fn get_next_instruction(self) -> Option<Self>

pub fn erase_from_basic_block(self)

pub fn remove_from_basic_block(self)

pub fn get_parent(self) -> Option<BasicBlock<'ctx>>

pub fn is_terminator(self) -> bool

Returns if the instruction is a terminator

pub fn is_conditional(self) -> bool

Returns if a terminator is conditional or not

pub fn is_tail_call(self) -> bool

pub fn get_tail_call_kind(self) -> Option<LLVMTailCallKind>

Returns the tail call kind on call instructions.

Other instructions return None.

pub fn can_use_fast_math_flags(self) -> bool

Check whether this instructions supports fast math flags.

pub fn get_fast_math_flags(self) -> Option<u32>

Get fast math flags of supported instructions.

Calling this on unsupported instructions is safe and returns None.

pub fn set_fast_math_flags(self, flags: u32)

Set fast math flags on supported instructions.

Calling this on unsupported instructions is safe and results in a no-op.

pub fn get_non_negative_flag(self) -> Option<bool>

Check if a zext instruction has the non-negative flag set.

Calling this function on other instructions is safe and returns None.

pub fn set_non_negative_flag(self, flag: bool)

Set the non-negative flag on zext instructions.

Calling this function on other instructions is safe and results in a no-op.

pub fn get_disjoint_flag(self) -> Option<bool>

Checks if an or instruction has the disjoint flag set.

Calling this function on other instructions is safe and returns None.

pub fn set_disjoint_flag(self, flag: bool)

Set the disjoint flag on or instructions.

Calling this function on other instructions is safe and results in a no-op.

pub fn replace_all_uses_with(self, other: &InstructionValue<'ctx>)

pub fn get_volatile(self) -> Result<bool, &'static str>

Returns whether or not a memory access instruction is volatile.

pub fn set_volatile(self, volatile: bool) -> Result<(), &'static str>

Sets whether or not a memory access instruction is volatile.

pub fn get_allocated_type(self) -> Result<BasicTypeEnum<'ctx>, &'static str>

Returns the type that is allocated by the alloca instruction.

pub fn get_alignment(self) -> Result<u32, &'static str>

Returns alignment on a memory access instruction or alloca.

pub fn set_alignment(self, alignment: u32) -> Result<(), &'static str>

Sets alignment on a memory access instruction or alloca.

pub fn get_atomic_ordering(self) -> Result<AtomicOrdering, &'static str>

Returns atomic ordering on a memory access instruction.

pub fn set_atomic_ordering( self, ordering: AtomicOrdering, ) -> Result<(), &'static str>

Sets atomic ordering on a memory access instruction.

pub fn get_num_operands(self) -> u32

Obtains the number of operands an InstructionValue has. An operand is a BasicValue used in an IR instruction.

The following example,

use inkwell::AddressSpace;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("ivs");
let builder = context.create_builder();
let void_type = context.void_type();
let f32_type = context.f32_type();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let fn_type = void_type.fn_type(&[f32_ptr_type.into()], false);

let function = module.add_function("take_f32_ptr", fn_type, None);
let basic_block = context.append_basic_block(function, "entry");

builder.position_at_end(basic_block);

let arg1 = function.get_first_param().unwrap().into_pointer_value();
let f32_val = f32_type.const_float(std::f64::consts::PI);
let store_instruction = builder.build_store(arg1, f32_val).unwrap();
let free_instruction = builder.build_free(arg1).unwrap();
let return_instruction = builder.build_return(None).unwrap();

assert_eq!(store_instruction.get_num_operands(), 2);
assert_eq!(free_instruction.get_num_operands(), 2);
assert_eq!(return_instruction.get_num_operands(), 0);

will generate LLVM IR roughly like (varying slightly across LLVM versions):

; ModuleID = 'ivs'
source_filename = "ivs"

define void @take_f32_ptr(float* %0) {
entry:
  store float 0x400921FB60000000, float* %0
  %1 = bitcast float* %0 to i8*
  tail call void @free(i8* %1)
  ret void
}

declare void @free(i8*)

which makes the number of instruction operands clear:

1. Store has two: a const float and a variable float pointer %0
2. Bitcast has one: a variable float pointer %0
3. Function call has two: i8 pointer %1 argument, and the free function itself
4. Void return has zero: void is not a value and does not count as an operand even though the return instruction can take values.

pub fn get_operand( self, index: u32, ) -> Option<Either<BasicValueEnum<'ctx>, BasicBlock<'ctx>>>

Obtains the operand an InstructionValue has at a given index if any. An operand is a BasicValue used in an IR instruction.

The following example,

use inkwell::AddressSpace;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("ivs");
let builder = context.create_builder();
let void_type = context.void_type();
let f32_type = context.f32_type();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let fn_type = void_type.fn_type(&[f32_ptr_type.into()], false);

let function = module.add_function("take_f32_ptr", fn_type, None);
let basic_block = context.append_basic_block(function, "entry");

builder.position_at_end(basic_block);

let arg1 = function.get_first_param().unwrap().into_pointer_value();
let f32_val = f32_type.const_float(std::f64::consts::PI);
let store_instruction = builder.build_store(arg1, f32_val).unwrap();
let free_instruction = builder.build_free(arg1).unwrap();
let return_instruction = builder.build_return(None).unwrap();

assert!(store_instruction.get_operand(0).is_some());
assert!(store_instruction.get_operand(1).is_some());
assert!(store_instruction.get_operand(2).is_none());
assert!(free_instruction.get_operand(0).is_some());
assert!(free_instruction.get_operand(1).is_some());
assert!(free_instruction.get_operand(2).is_none());
assert!(return_instruction.get_operand(0).is_none());
assert!(return_instruction.get_operand(1).is_none());

will generate LLVM IR roughly like (varying slightly across LLVM versions):

; ModuleID = 'ivs'
source_filename = "ivs"

define void @take_f32_ptr(float* %0) {
entry:
  store float 0x400921FB60000000, float* %0
  %1 = bitcast float* %0 to i8*
  tail call void @free(i8* %1)
  ret void
}

declare void @free(i8*)

which makes the instruction operands clear:

1. Store has two: a const float and a variable float pointer %0
2. Bitcast has one: a variable float pointer %0
3. Function call has two: i8 pointer %1 argument, and the free function itself
4. Void return has zero: void is not a value and does not count as an operand even though the return instruction can take values.

pub unsafe fn get_operand_unchecked( self, index: u32, ) -> Option<Either<BasicValueEnum<'ctx>, BasicBlock<'ctx>>>

Get the operand of an InstructionValue.

Safety

The index must be less than InstructionValue::get_num_operands.

pub fn get_operands(self) -> OperandIter<'ctx>

Get an instruction value operand iterator.

pub fn set_operand<BV: BasicValue<'ctx>>(self, index: u32, val: BV) -> bool

Sets the operand an InstructionValue has at a given index if possible. An operand is a BasicValue used in an IR instruction.

use inkwell::AddressSpace;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("ivs");
let builder = context.create_builder();
let void_type = context.void_type();
let f32_type = context.f32_type();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let fn_type = void_type.fn_type(&[f32_ptr_type.into()], false);

let function = module.add_function("take_f32_ptr", fn_type, None);
let basic_block = context.append_basic_block(function, "entry");

builder.position_at_end(basic_block);

let arg1 = function.get_first_param().unwrap().into_pointer_value();
let f32_val = f32_type.const_float(std::f64::consts::PI);
let store_instruction = builder.build_store(arg1, f32_val).unwrap();
let free_instruction = builder.build_free(arg1).unwrap();
let return_instruction = builder.build_return(None).unwrap();

// This will produce invalid IR:
free_instruction.set_operand(0, f32_val);

assert_eq!(free_instruction.get_operand(0).unwrap().left().unwrap(), f32_val);

pub fn get_operand_use(self, index: u32) -> Option<BasicValueUse<'ctx>>

Gets the use of an operand(BasicValue), if any.

use inkwell::AddressSpace;
use inkwell::context::Context;
use inkwell::values::BasicValue;

let context = Context::create();
let module = context.create_module("ivs");
let builder = context.create_builder();
let void_type = context.void_type();
let f32_type = context.f32_type();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let fn_type = void_type.fn_type(&[f32_ptr_type.into()], false);

let function = module.add_function("take_f32_ptr", fn_type, None);
let basic_block = context.append_basic_block(function, "entry");

builder.position_at_end(basic_block);

let arg1 = function.get_first_param().unwrap().into_pointer_value();
let f32_val = f32_type.const_float(std::f64::consts::PI);
let store_instruction = builder.build_store(arg1, f32_val).unwrap();
let free_instruction = builder.build_free(arg1).unwrap();
let return_instruction = builder.build_return(None).unwrap();

assert_eq!(store_instruction.get_operand_use(1), arg1.get_first_use());

pub unsafe fn get_operand_use_unchecked( self, index: u32, ) -> Option<BasicValueUse<'ctx>>

Gets the use of an operand(BasicValue), if any.

Safety

The index must be smaller than InstructionValue::get_num_operands.

pub fn get_operand_uses(self) -> OperandUseIter<'ctx>

Get an instruction value operand use iterator.

pub fn get_first_use(self) -> Option<BasicValueUse<'ctx>>

Gets the first use of an InstructionValue if any.

The following example,

use inkwell::AddressSpace;
use inkwell::context::Context;
use inkwell::values::BasicValue;

let context = Context::create();
let module = context.create_module("ivs");
let builder = context.create_builder();
let void_type = context.void_type();
let f32_type = context.f32_type();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let fn_type = void_type.fn_type(&[f32_ptr_type.into()], false);

let function = module.add_function("take_f32_ptr", fn_type, None);
let basic_block = context.append_basic_block(function, "entry");

builder.position_at_end(basic_block);

let arg1 = function.get_first_param().unwrap().into_pointer_value();
let f32_val = f32_type.const_float(std::f64::consts::PI);
let store_instruction = builder.build_store(arg1, f32_val).unwrap();
let free_instruction = builder.build_free(arg1).unwrap();
let return_instruction = builder.build_return(None).unwrap();

assert!(arg1.get_first_use().is_some());

pub fn get_icmp_predicate(self) -> Option<IntPredicate>

Gets the predicate of an ICmp InstructionValue. For instance, in the LLVM instruction %3 = icmp slt i32 %0, %1 this gives the slt.

If the instruction is not an ICmp, this returns None.

pub fn get_fcmp_predicate(self) -> Option<FloatPredicate>

Gets the predicate of an FCmp InstructionValue. For instance, in the LLVM instruction %3 = fcmp olt float %0, %1 this gives the olt.

If the instruction is not an FCmp, this returns None.

pub fn has_metadata(self) -> bool

Determines whether or not this Instruction has any associated metadata.

pub fn get_metadata(self, kind_id: u32) -> Option<MetadataValue<'ctx>>

Gets the MetadataValue associated with this Instruction at a specific kind_id.

pub fn set_metadata( self, metadata: MetadataValue<'ctx>, kind_id: u32, ) -> Result<(), &'static str>

Determines whether or not this Instruction has any associated metadata kind_id.

Trait Implementations

impl<'ctx> AnyValue<'ctx> for InstructionValue<'ctx>

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString

fn is_poison(&self) -> bool

Returns whether the value is poison

impl AsValueRef for InstructionValue<'_>

fn as_value_ref(&self) -> LLVMValueRef

impl<'ctx> Clone for InstructionValue<'ctx>

fn clone(&self) -> InstructionValue<'ctx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for InstructionValue<'ctx>

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

Formats the value using the given formatter.

impl Display for InstructionValue<'_>

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

Formats the value using the given formatter.

impl<'ctx> From<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

fn from(value: InstructionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.

impl<'ctx> Hash for InstructionValue<'ctx>

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<'ctx> PartialEq<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> PartialEq<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> PartialEq for InstructionValue<'ctx>

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<InstructionValue<'ctx>> for FloatValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<InstructionValue<'ctx>> for IntValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PhiValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PointerValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> Copy for InstructionValue<'ctx>

impl<'ctx> Eq for InstructionValue<'ctx>

impl<'ctx> StructuralPartialEq for InstructionValue<'ctx>