LLVM 17.0.0git
Public Types | Public Member Functions | Protected Member Functions | List of all members
llvm::MCExpr Class Reference

Base class for the full range of assembler expressions which are needed for parsing. More...

#include "llvm/MC/MCExpr.h"

Inheritance diagram for llvm::MCExpr:
Inheritance graph
[legend]

Public Types

enum  ExprKind : uint8_t {
  Binary , Constant , SymbolRef , Unary ,
  Target
}
 

Public Member Functions

 MCExpr (const MCExpr &)=delete
 
MCExpr & operator= (const MCExpr &)=delete
 
Accessors
ExprKind getKind () const
 
SMLoc getLoc () const
 
Utility Methods
void print (raw_ostream &OS, const MCAsmInfo *MAI, bool InParens=false) const
 
void dump () const
 
Expression Evaluation
bool evaluateAsAbsolute (int64_t &Res, const MCAsmLayout &Layout, const SectionAddrMap &Addrs) const
 Try to evaluate the expression to an absolute value.
 
bool evaluateAsAbsolute (int64_t &Res) const
 
bool evaluateAsAbsolute (int64_t &Res, const MCAssembler &Asm) const
 
bool evaluateAsAbsolute (int64_t &Res, const MCAssembler *Asm) const
 
bool evaluateAsAbsolute (int64_t &Res, const MCAsmLayout &Layout) const
 
bool evaluateKnownAbsolute (int64_t &Res, const MCAsmLayout &Layout) const
 
bool evaluateAsRelocatable (MCValue &Res, const MCAsmLayout *Layout, const MCFixup *Fixup) const
 Try to evaluate the expression to a relocatable value, i.e.
 
bool evaluateAsValue (MCValue &Res, const MCAsmLayout &Layout) const
 Try to evaluate the expression to the form (a - b + constant) where neither a nor b are variables.
 
MCFragment * findAssociatedFragment () const
 Find the "associated section" for this expression, which is currently defined as the absolute section for constants, or otherwise the section associated with the first defined symbol in the expression.
 

Protected Member Functions

 MCExpr (ExprKind Kind, SMLoc Loc, unsigned SubclassData=0)
 
bool evaluateAsRelocatableImpl (MCValue &Res, const MCAssembler *Asm, const MCAsmLayout *Layout, const MCFixup *Fixup, const SectionAddrMap *Addrs, bool InSet) const
 
unsigned getSubclassData () const
 

Detailed Description

Base class for the full range of assembler expressions which are needed for parsing.

Definition at line 35 of file MCExpr.h.

Member Enumeration Documentation

◆ ExprKind

enum llvm::MCExpr::ExprKind : uint8_t
Enumerator
Binary 

Binary expressions.

Constant 

Constant expressions.

SymbolRef 

References to labels and assigned expressions.

Unary 

Unary expressions.

Target 

Target specific expression.

Definition at line 37 of file MCExpr.h.

Constructor & Destructor Documentation

◆ MCExpr() [1/2]

llvm::MCExpr::MCExpr ( ExprKind  Kind,
SMLoc  Loc,
unsigned  SubclassData = 0 
)
inlineexplicitprotected

Definition at line 61 of file MCExpr.h.

References assert().

◆ MCExpr() [2/2]

llvm::MCExpr::MCExpr ( const MCExpr &  )
delete

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void MCExpr::dump ( ) const

Definition at line 175 of file MCExpr.cpp.

References llvm::dbgs().

◆ evaluateAsAbsolute() [1/5]

bool MCExpr::evaluateAsAbsolute ( int64_t &  Res) const

Definition at line 536 of file MCExpr.cpp.

◆ evaluateAsAbsolute() [2/5]

bool MCExpr::evaluateAsAbsolute ( int64_t &  Res,
const MCAsmLayout &  Layout 
) const

Definition at line 540 of file MCExpr.cpp.

References llvm::MCAsmLayout::getAssembler().

◆ evaluateAsAbsolute() [3/5]

bool MCExpr::evaluateAsAbsolute ( int64_t &  Res,
const MCAsmLayout &  Layout,
const SectionAddrMap &  Addrs 
) const

Try to evaluate the expression to an absolute value.

Parameters
Res- The absolute value, if evaluation succeeds.
Layout- The assembler layout object to use for evaluating symbol values. If not given, then only non-symbolic expressions will be evaluated.
Returns
- True on success.

Definition at line 545 of file MCExpr.cpp.

References llvm::MCAsmLayout::getAssembler().

◆ evaluateAsAbsolute() [4/5]

bool MCExpr::evaluateAsAbsolute ( int64_t &  Res,
const MCAssembler &  Asm 
) const

Definition at line 553 of file MCExpr.cpp.

◆ evaluateAsAbsolute() [5/5]

bool MCExpr::evaluateAsAbsolute ( int64_t &  Res,
const MCAssembler *  Asm 
) const

Definition at line 557 of file MCExpr.cpp.

◆ evaluateAsRelocatable()

bool MCExpr::evaluateAsRelocatable ( MCValue &  Res,
const MCAsmLayout *  Layout,
const MCFixup *  Fixup 
) const

Try to evaluate the expression to a relocatable value, i.e.

an expression of the fixed form (a - b + constant).

Parameters
Res- The relocatable value, if evaluation succeeds.
Layout- The assembler layout object to use for evaluating values.
Fixup- The Fixup object if available.
Returns
- True on success.

Definition at line 749 of file MCExpr.cpp.

References evaluateAsRelocatableImpl(), Fixup, and llvm::MCAsmLayout::getAssembler().

Referenced by llvm::PPCMCExpr::evaluateAsConstant(), llvm::RISCVMCExpr::evaluateAsConstant(), llvm::AVRMCExpr::evaluateAsConstant(), llvm::AArch64MCExpr::evaluateAsRelocatableImpl(), llvm::AVRMCExpr::evaluateAsRelocatableImpl(), llvm::CSKYMCExpr::evaluateAsRelocatableImpl(), llvm::HexagonMCExpr::evaluateAsRelocatableImpl(), llvm::LanaiMCExpr::evaluateAsRelocatableImpl(), llvm::LoongArchMCExpr::evaluateAsRelocatableImpl(), llvm::MipsMCExpr::evaluateAsRelocatableImpl(), llvm::PPCMCExpr::evaluateAsRelocatableImpl(), llvm::RISCVMCExpr::evaluateAsRelocatableImpl(), llvm::SparcMCExpr::evaluateAsRelocatableImpl(), llvm::VEMCExpr::evaluateAsRelocatableImpl(), llvm::XtensaMCExpr::evaluateAsRelocatableImpl(), llvm::RISCVAsmBackend::evaluateTargetFixup(), getOffsetAndDataFragment(), llvm::RISCVMCExpr::getPCRelHiFixup(), llvm::MachObjectWriter::getSymbolAddress(), and llvm::MCAssembler::isThumbFunc().

◆ evaluateAsRelocatableImpl()

bool MCExpr::evaluateAsRelocatableImpl ( MCValue &  Res,
const MCAssembler *  Asm,
const MCAsmLayout *  Layout,
const MCFixup *  Fixup,
const SectionAddrMap *  Addrs,
bool  InSet 
) const
protected

-(a - b + const) ==> (b - a - const)

Definition at line 776 of file MCExpr.cpp.

References A, llvm::MCBinaryExpr::Add, llvm::MCBinaryExpr::And, llvm::MCBinaryExpr::AShr, B, Binary, canExpand(), Constant, llvm::MCSymbolRefExpr::create(), llvm::MCBinaryExpr::Div, llvm::MCBinaryExpr::EQ, evaluateAsRelocatableImpl(), EvaluateSymbolicAdd(), Fixup, llvm::MCValue::get(), llvm::MCValue::getConstant(), getKind(), llvm::MCSymbolRefExpr::getKind(), llvm::MCBinaryExpr::getLHS(), llvm::MCUnaryExpr::getOpcode(), llvm::MCBinaryExpr::getOpcode(), llvm::MCValue::getRefKind(), llvm::MCBinaryExpr::getRHS(), llvm::MCUnaryExpr::getSubExpr(), llvm::MCValue::getSymA(), llvm::MCValue::getSymB(), llvm::MCSymbolRefExpr::getSymbol(), llvm::MCBinaryExpr::GT, llvm::MCBinaryExpr::GTE, llvm::MCSymbolRefExpr::hasSubsectionsViaSymbols(), llvm::MCValue::isAbsolute(), llvm::MCBinaryExpr::LAnd, LHS, llvm_unreachable, llvm::MCUnaryExpr::LNot, llvm::MCBinaryExpr::LOr, llvm::MCBinaryExpr::LShr, llvm::MCBinaryExpr::LT, llvm::MCBinaryExpr::LTE, llvm::MCUnaryExpr::Minus, llvm::MCBinaryExpr::Mod, llvm::MCBinaryExpr::Mul, llvm::MCBinaryExpr::NE, llvm::MCUnaryExpr::Not, llvm::MCBinaryExpr::Or, llvm::MCBinaryExpr::OrNot, llvm::MCUnaryExpr::Plus, RHS, llvm::MCBinaryExpr::Shl, llvm::MCBinaryExpr::Sub, Sym, SymbolRef, Target, Unary, llvm::MCSymbolRefExpr::VK_None, and llvm::MCBinaryExpr::Xor.

Referenced by evaluateAsRelocatable(), evaluateAsRelocatableImpl(), and evaluateAsValue().

◆ evaluateAsValue()

bool MCExpr::evaluateAsValue ( MCValue &  Res,
const MCAsmLayout &  Layout 
) const

Try to evaluate the expression to the form (a - b + constant) where neither a nor b are variables.

This is a more aggressive variant of evaluateAsRelocatable. The intended use is for when relocations are not available, like the .size directive.

Definition at line 757 of file MCExpr.cpp.

References evaluateAsRelocatableImpl(), and llvm::MCAsmLayout::getAssembler().

Referenced by llvm::MCAssembler::computeFragmentSize(), llvm::MCAsmLayout::getBaseSymbol(), and getSymbolOffsetImpl().

◆ evaluateKnownAbsolute()

bool MCExpr::evaluateKnownAbsolute ( int64_t &  Res,
const MCAsmLayout &  Layout 
) const

Definition at line 561 of file MCExpr.cpp.

References llvm::MCAsmLayout::getAssembler().

Referenced by computeLabelDiff(), llvm::RISCVAsmBackend::relaxDwarfCFA(), and llvm::RISCVAsmBackend::relaxDwarfLineAddr().

◆ findAssociatedFragment()

MCFragment * MCExpr::findAssociatedFragment ( ) const

Find the "associated section" for this expression, which is currently defined as the absolute section for constants, or otherwise the section associated with the first defined symbol in the expression.

Definition at line 988 of file MCExpr.cpp.

References llvm::MCSymbol::AbsolutePseudoFragment, Binary, Constant, findAssociatedFragment(), getKind(), llvm::MCBinaryExpr::getLHS(), llvm::MCBinaryExpr::getOpcode(), llvm::MCBinaryExpr::getRHS(), llvm::MCSymbolRefExpr::getSymbol(), llvm_unreachable, llvm::MCBinaryExpr::Sub, Sym, SymbolRef, Target, and Unary.

Referenced by findAssociatedFragment(), llvm::ARMMCExpr::findAssociatedFragment(), llvm::AVRMCExpr::findAssociatedFragment(), llvm::CSKYMCExpr::findAssociatedFragment(), llvm::HexagonMCExpr::findAssociatedFragment(), llvm::LanaiMCExpr::findAssociatedFragment(), llvm::LoongArchMCExpr::findAssociatedFragment(), llvm::MipsMCExpr::findAssociatedFragment(), llvm::PPCMCExpr::findAssociatedFragment(), llvm::RISCVMCExpr::findAssociatedFragment(), llvm::SparcMCExpr::findAssociatedFragment(), llvm::VEMCExpr::findAssociatedFragment(), llvm::XtensaMCExpr::findAssociatedFragment(), and llvm::MCSymbol::getFragment().

◆ getKind()

ExprKind llvm::MCExpr::getKind ( ) const
inline

Definition at line 81 of file MCExpr.h.

Referenced by evaluateAsRelocatableImpl(), findAssociatedFragment(), fixELFSymbolsInTLSFixupsImpl(), getAccessVariant(), llvm::CSKYMCCodeEmitter::getBareSymbolOpValue(), llvm::CSKYMCCodeEmitter::getBranchSymbolOpValue(), llvm::CSKYMCCodeEmitter::getCallSymbolOpValue(), llvm::CSKYMCCodeEmitter::getConstpoolSymbolOpValue(), llvm::CSKYMCCodeEmitter::getDataSymbolOpValue(), llvm::PPCMCCodeEmitter::getDispRI34PCRelEncoding(), llvm::MipsMCCodeEmitter::getExprOpValue(), hasGOTReference(), hasSecRelSymbolRef(), hasVariantSymbol(), llvm::MCOperand::isBareSymbolRef(), isEvaluated(), needsExpandMemInst(), needsPCRel(), llvm::X86Operand::print(), print(), llvm::ARMMCExpr::printImpl(), llvm::ARMInstPrinter::printOperand(), startsWithGlobalOffsetTable(), and llvm::MCStreamer::visitUsedExpr().

◆ getLoc()

SMLoc llvm::MCExpr::getLoc ( ) const
inline

Definition at line 82 of file MCExpr.h.

Referenced by llvm::MCAsmLayout::getBaseSymbol(), and llvm::MipsMCCodeEmitter::getExprOpValue().

◆ getSubclassData()

unsigned llvm::MCExpr::getSubclassData ( ) const
inlineprotected

Definition at line 72 of file MCExpr.h.

Referenced by llvm::MCSymbolRefExpr::getKind(), llvm::MCUnaryExpr::getOpcode(), llvm::MCBinaryExpr::getOpcode(), llvm::MCConstantExpr::getSizeInBytes(), llvm::MCSymbolRefExpr::hasSubsectionsViaSymbols(), and llvm::MCConstantExpr::useHexFormat().

◆ operator=()

MCExpr & llvm::MCExpr::operator= ( const MCExpr &  )
delete

◆ print()

void MCExpr::print ( raw_ostream &  OS,
const MCAsmInfo *  MAI,
bool  InParens = false 
) const

Definition at line 41 of file MCExpr.cpp.

References llvm::MCBinaryExpr::Add, llvm::MCBinaryExpr::And, llvm::MCBinaryExpr::AShr, Binary, Constant, llvm::MCBinaryExpr::Div, llvm::MCBinaryExpr::EQ, llvm::format(), getKind(), llvm::MCSymbolRefExpr::getKind(), llvm::MCBinaryExpr::getLHS(), llvm::MCUnaryExpr::getOpcode(), llvm::MCBinaryExpr::getOpcode(), llvm::MCBinaryExpr::getRHS(), llvm::MCUnaryExpr::getSubExpr(), llvm::MCSymbolRefExpr::getSymbol(), llvm::MCSymbolRefExpr::getVariantKindName(), llvm::MCBinaryExpr::GT, llvm::MCBinaryExpr::GTE, llvm::MCBinaryExpr::LAnd, llvm_unreachable, llvm::MCUnaryExpr::LNot, llvm::MCBinaryExpr::LOr, llvm::MCBinaryExpr::LShr, llvm::MCBinaryExpr::LT, llvm::MCBinaryExpr::LTE, llvm::MCUnaryExpr::Minus, llvm::MCBinaryExpr::Mod, llvm::MCBinaryExpr::Mul, llvm::MCBinaryExpr::NE, llvm::MCUnaryExpr::Not, llvm::MCBinaryExpr::Or, llvm::MCBinaryExpr::OrNot, OS, llvm::MCUnaryExpr::Plus, print(), llvm::MCBinaryExpr::Shl, llvm::MCBinaryExpr::Sub, Sym, SymbolRef, Target, Unary, llvm::MCAsmInfo::useParensForDollarSignNames(), llvm::MCAsmInfo::useParensForSymbolVariant(), llvm::Twine::utohexstr(), llvm::MCSymbolRefExpr::VK_None, and llvm::MCBinaryExpr::Xor.

Referenced by print(), llvm::AArch64InstPrinter::printAddSubImm(), llvm::ARMInstPrinter::printAdrLabelOperand(), llvm::AArch64InstPrinter::printAMIndexedWB(), llvm::CSKYInstPrinter::printConstpool(), llvm::CSKYInstPrinter::printDataSymbol(), llvm::AArch64MCExpr::printImpl(), llvm::ARMMCExpr::printImpl(), llvm::AVRMCExpr::printImpl(), llvm::CSKYMCExpr::printImpl(), llvm::HexagonMCExpr::printImpl(), llvm::LanaiMCExpr::printImpl(), llvm::LoongArchMCExpr::printImpl(), llvm::MipsMCExpr::printImpl(), llvm::NVPTXGenericMCSymbolRefExpr::printImpl(), llvm::PPCMCExpr::printImpl(), llvm::RISCVMCExpr::printImpl(), llvm::SparcMCExpr::printImpl(), llvm::VEMCExpr::printImpl(), llvm::XtensaMCExpr::printImpl(), llvm::X86IntelInstPrinter::printMemOffset(), llvm::X86ATTInstPrinter::printMemOffset(), printMemoryImmediateOffset(), llvm::X86IntelInstPrinter::printMemReference(), llvm::X86ATTInstPrinter::printMemReference(), llvm::SparcInstPrinter::printOperand(), llvm::VEInstPrinter::printOperand(), llvm::ARMInstPrinter::printOperand(), llvm::CSKYInstPrinter::printOperand(), llvm::RISCVInstPrinter::printOperand(), printOperand(), llvm::SystemZInstPrinter::printOperand(), llvm::MCSectionELF::printSwitchToSection(), llvm::MCSectionWasm::printSwitchToSection(), llvm::ARMInstPrinter::printThumbLdrLabelOperand(), and llvm::AArch64InstPrinter::printUImm12Offset().

The documentation for this class was generated from the following files:
Generated on Tue Jun 6 2023 20:09:42 for LLVM by doxygen 1.9.6