Enum llvm_ir::constant::Constant

pub enum Constant {
    Int {
        bits: u32,
        value: u64,
    },
    Float(Float),
    Null(TypeRef),
    AggregateZero(TypeRef),
    Struct {
        name: Option<String>,
        values: Vec<ConstantRef>,
        is_packed: bool,
    },
    Array {
        element_type: TypeRef,
        elements: Vec<ConstantRef>,
    },
    Vector(Vec<ConstantRef>),
    Undef(TypeRef),
    BlockAddress,
    GlobalReference {
        name: Name,
        ty: TypeRef,
    },
    TokenNone,
    Add(Add),
    Sub(Sub),
    Mul(Mul),
    UDiv(UDiv),
    SDiv(SDiv),
    URem(URem),
    SRem(SRem),
    And(And),
    Or(Or),
    Xor(Xor),
    Shl(Shl),
    LShr(LShr),
    AShr(AShr),
    FAdd(FAdd),
    FSub(FSub),
    FMul(FMul),
    FDiv(FDiv),
    FRem(FRem),
    ExtractElement(ExtractElement),
    InsertElement(InsertElement),
    ShuffleVector(ShuffleVector),
    ExtractValue(ExtractValue),
    InsertValue(InsertValue),
    GetElementPtr(GetElementPtr),
    Trunc(Trunc),
    ZExt(ZExt),
    SExt(SExt),
    FPTrunc(FPTrunc),
    FPExt(FPExt),
    FPToUI(FPToUI),
    FPToSI(FPToSI),
    UIToFP(UIToFP),
    SIToFP(SIToFP),
    PtrToInt(PtrToInt),
    IntToPtr(IntToPtr),
    BitCast(BitCast),
    AddrSpaceCast(AddrSpaceCast),
    ICmp(ICmp),
    FCmp(FCmp),
    Select(Select),
}

See LLVM 12 docs on Constants. Constants can be either values, or expressions involving other constants (see LLVM 12 docs on Constant Expressions).

Variants

Int

Fields of Int

bits: u32

Number of bits in the constant integer

value: u64

The constant value itself.

If bits == 64, this is the value.

If bits < 64, the constant value is zero-extended to fit in this field.

If bits > 64, the constant value is truncated to fit in this field; but if this truncation would change the value (i.e., if the value is >= 2^64 when interpreted as unsigned) then Module::from_bc_path() will fail. See #5.

Float(Float)

Tuple Fields of Float

0: Float

Null(TypeRef)

The TypeRef here must be to a PointerType. See LLVM 12 docs on Simple Constants

Tuple Fields of Null

0: TypeRef

AggregateZero(TypeRef)

A zero-initialized array or struct (or scalar).

Tuple Fields of AggregateZero

0: TypeRef

Struct

Fields of Struct

name: Option<String>values: Vec<ConstantRef>is_packed: bool

Array

Fields of Array

element_type: TypeRefelements: Vec<ConstantRef>

Vector(Vec<ConstantRef>)

Tuple Fields of Vector

0: Vec<ConstantRef>

Undef(TypeRef)

Undef can be used anywhere a constant is expected. See LLVM 12 docs on Undefined Values

Tuple Fields of Undef

0: TypeRef

BlockAddress

The address of the given (non-entry) BasicBlock. See LLVM 12 docs on Addresses of Basic Blocks. BlockAddress needs more fields, but the necessary getter functions are apparently not exposed in the LLVM C API (only the C++ API)

GlobalReference

Fields of GlobalReference

name: Namety: TypeRef

TokenNone

Add(Add)

Tuple Fields of Add

0: Add

Sub(Sub)

Tuple Fields of Sub

0: Sub

Mul(Mul)

Tuple Fields of Mul

0: Mul

UDiv(UDiv)

Tuple Fields of UDiv

0: UDiv

SDiv(SDiv)

Tuple Fields of SDiv

0: SDiv

URem(URem)

Tuple Fields of URem

0: URem

SRem(SRem)

Tuple Fields of SRem

0: SRem

And(And)

Tuple Fields of And

0: And

Or(Or)

Tuple Fields of Or

0: Or

Xor(Xor)

Tuple Fields of Xor

0: Xor

Shl(Shl)

Tuple Fields of Shl

0: Shl

LShr(LShr)

Tuple Fields of LShr

0: LShr

AShr(AShr)

Tuple Fields of AShr

0: AShr

FAdd(FAdd)

Tuple Fields of FAdd

0: FAdd

FSub(FSub)

Tuple Fields of FSub

0: FSub

FMul(FMul)

Tuple Fields of FMul

0: FMul

FDiv(FDiv)

Tuple Fields of FDiv

0: FDiv

FRem(FRem)

Tuple Fields of FRem

0: FRem

ExtractElement(ExtractElement)

Tuple Fields of ExtractElement

0: ExtractElement

InsertElement(InsertElement)

Tuple Fields of InsertElement

0: InsertElement

ShuffleVector(ShuffleVector)

Tuple Fields of ShuffleVector

0: ShuffleVector

ExtractValue(ExtractValue)

Tuple Fields of ExtractValue

0: ExtractValue

InsertValue(InsertValue)

Tuple Fields of InsertValue

0: InsertValue

GetElementPtr(GetElementPtr)

Tuple Fields of GetElementPtr

0: GetElementPtr

Trunc(Trunc)

Tuple Fields of Trunc

0: Trunc

ZExt(ZExt)

Tuple Fields of ZExt

0: ZExt

SExt(SExt)

Tuple Fields of SExt

0: SExt

FPTrunc(FPTrunc)

Tuple Fields of FPTrunc

0: FPTrunc

FPExt(FPExt)

Tuple Fields of FPExt

0: FPExt

FPToUI(FPToUI)

Tuple Fields of FPToUI

0: FPToUI

FPToSI(FPToSI)

Tuple Fields of FPToSI

0: FPToSI

UIToFP(UIToFP)

Tuple Fields of UIToFP

0: UIToFP

SIToFP(SIToFP)

Tuple Fields of SIToFP

0: SIToFP

PtrToInt(PtrToInt)

Tuple Fields of PtrToInt

0: PtrToInt

IntToPtr(IntToPtr)

Tuple Fields of IntToPtr

0: IntToPtr

BitCast(BitCast)

Tuple Fields of BitCast

0: BitCast

AddrSpaceCast(AddrSpaceCast)

Tuple Fields of AddrSpaceCast

0: AddrSpaceCast

ICmp(ICmp)

Tuple Fields of ICmp

0: ICmp

FCmp(FCmp)

Tuple Fields of FCmp

0: FCmp

Select(Select)

Tuple Fields of Select

0: Select

Trait Implementations

impl AsRef<Constant> for ConstantRef

fn as_ref(&self) -> &Constant

Performs the conversion.

impl Clone for Constant

fn clone(&self) -> Constant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Constant

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

Formats the value using the given formatter.

impl Display for Constant

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

Formats the value using the given formatter.

impl From<AShr> for Constant

fn from(expr: AShr) -> Constant

Performs the conversion.

impl From<Add> for Constant

fn from(expr: Add) -> Constant

Performs the conversion.

impl From<AddrSpaceCast> for Constant

fn from(expr: AddrSpaceCast) -> Constant

Performs the conversion.

impl From<And> for Constant

fn from(expr: And) -> Constant

Performs the conversion.

impl From<BitCast> for Constant

fn from(expr: BitCast) -> Constant

Performs the conversion.

impl From<ExtractElement> for Constant

fn from(expr: ExtractElement) -> Constant

Performs the conversion.

impl From<ExtractValue> for Constant

fn from(expr: ExtractValue) -> Constant

Performs the conversion.

impl From<FAdd> for Constant

fn from(expr: FAdd) -> Constant

Performs the conversion.

impl From<FCmp> for Constant

fn from(expr: FCmp) -> Constant

Performs the conversion.

impl From<FDiv> for Constant

fn from(expr: FDiv) -> Constant

Performs the conversion.

impl From<FMul> for Constant

fn from(expr: FMul) -> Constant

Performs the conversion.

impl From<FPExt> for Constant

fn from(expr: FPExt) -> Constant

Performs the conversion.

impl From<FPToSI> for Constant

fn from(expr: FPToSI) -> Constant

Performs the conversion.

impl From<FPToUI> for Constant

fn from(expr: FPToUI) -> Constant

Performs the conversion.

impl From<FPTrunc> for Constant

fn from(expr: FPTrunc) -> Constant

Performs the conversion.

impl From<FRem> for Constant

fn from(expr: FRem) -> Constant

Performs the conversion.

impl From<FSub> for Constant

fn from(expr: FSub) -> Constant

Performs the conversion.

impl From<GetElementPtr> for Constant

fn from(expr: GetElementPtr) -> Constant

Performs the conversion.

impl From<ICmp> for Constant

fn from(expr: ICmp) -> Constant

Performs the conversion.

impl From<InsertElement> for Constant

fn from(expr: InsertElement) -> Constant

Performs the conversion.

impl From<InsertValue> for Constant

fn from(expr: InsertValue) -> Constant

Performs the conversion.

impl From<IntToPtr> for Constant

fn from(expr: IntToPtr) -> Constant

Performs the conversion.

impl From<LShr> for Constant

fn from(expr: LShr) -> Constant

Performs the conversion.

impl From<Mul> for Constant

fn from(expr: Mul) -> Constant

Performs the conversion.

impl From<Or> for Constant

fn from(expr: Or) -> Constant

Performs the conversion.

impl From<PtrToInt> for Constant

fn from(expr: PtrToInt) -> Constant

Performs the conversion.

impl From<SDiv> for Constant

fn from(expr: SDiv) -> Constant

Performs the conversion.

impl From<SExt> for Constant

fn from(expr: SExt) -> Constant

Performs the conversion.

impl From<SIToFP> for Constant

fn from(expr: SIToFP) -> Constant

Performs the conversion.

impl From<SRem> for Constant

fn from(expr: SRem) -> Constant

Performs the conversion.

impl From<Select> for Constant

fn from(expr: Select) -> Constant

Performs the conversion.

impl From<Shl> for Constant

fn from(expr: Shl) -> Constant

Performs the conversion.

impl From<ShuffleVector> for Constant

fn from(expr: ShuffleVector) -> Constant

Performs the conversion.

impl From<Sub> for Constant

fn from(expr: Sub) -> Constant

Performs the conversion.

impl From<Trunc> for Constant

fn from(expr: Trunc) -> Constant

Performs the conversion.

impl From<UDiv> for Constant

fn from(expr: UDiv) -> Constant

Performs the conversion.

impl From<UIToFP> for Constant

fn from(expr: UIToFP) -> Constant

Performs the conversion.

impl From<URem> for Constant

fn from(expr: URem) -> Constant

Performs the conversion.

impl From<Xor> for Constant

fn from(expr: Xor) -> Constant

Performs the conversion.

impl From<ZExt> for Constant

fn from(expr: ZExt) -> Constant

Performs the conversion.

impl PartialEq<Constant> for Constant

fn eq(&self, other: &Constant) -> bool

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

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

This method tests for !=.

impl TryFrom<Constant> for Add

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Sub

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Shl

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for LShr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for AShr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FAdd

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FSub

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FMul

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FDiv

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FRem

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ExtractElement

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for InsertElement

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Mul

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ShuffleVector

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ExtractValue

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for InsertValue

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for GetElementPtr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Trunc

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ZExt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SExt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPTrunc

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPExt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPToUI

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for UDiv

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPToSI

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for UIToFP

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SIToFP

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for PtrToInt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for IntToPtr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for BitCast

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for AddrSpaceCast

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ICmp

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FCmp

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Select

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SDiv

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for URem

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SRem

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for And

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Or

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Xor

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl Typed for Constant

fn get_type(&self, types: &Types) -> TypeRef

impl StructuralPartialEq for Constant