LLVM  8.0.1
Public Types | Public Member Functions | Static Public Attributes | List of all members
llvm::VirtRegMap Class Reference

#include "llvm/CodeGen/VirtRegMap.h"

Inheritance diagram for llvm::VirtRegMap:
Inheritance graph
[legend]
Collaboration diagram for llvm::VirtRegMap:
Collaboration graph
[legend]

Public Types

enum  { NO_PHYS_REG = 0, NO_STACK_SLOT = (1L << 30)-1, MAX_STACK_SLOT = (1L << 18)-1 }
 

Public Member Functions

 VirtRegMap ()
 
 VirtRegMap (const VirtRegMap &)=delete
 
VirtRegMapoperator= (const VirtRegMap &)=delete
 
bool runOnMachineFunction (MachineFunction &MF) override
 runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis. More...
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - Subclasses that override getAnalysisUsage must call this. More...
 
MachineFunctiongetMachineFunction () const
 
MachineRegisterInfogetRegInfo () const
 
const TargetRegisterInfogetTargetRegInfo () const
 
void grow ()
 
bool hasPhys (unsigned virtReg) const
 returns true if the specified virtual register is mapped to a physical register More...
 
unsigned getPhys (unsigned virtReg) const
 returns the physical register mapped to the specified virtual register More...
 
void assignVirt2Phys (unsigned virtReg, MCPhysReg physReg)
 creates a mapping for the specified virtual register to the specified physical register More...
 
void clearVirt (unsigned virtReg)
 clears the specified virtual register's, physical register mapping More...
 
void clearAllVirt ()
 clears all virtual to physical register mappings More...
 
bool hasPreferredPhys (unsigned VirtReg)
 returns true if VirtReg is assigned to its preferred physreg. More...
 
bool hasKnownPreference (unsigned VirtReg)
 returns true if VirtReg has a known preferred register. More...
 
void setIsSplitFromReg (unsigned virtReg, unsigned SReg)
 records virtReg is a split live interval from SReg. More...
 
unsigned getPreSplitReg (unsigned virtReg) const
 returns the live interval virtReg is split from. More...
 
unsigned getOriginal (unsigned VirtReg) const
 getOriginal - Return the original virtual register that VirtReg descends from through splitting. More...
 
bool isAssignedReg (unsigned virtReg) const
 returns true if the specified virtual register is not mapped to a stack slot or rematerialized. More...
 
int getStackSlot (unsigned virtReg) const
 returns the stack slot mapped to the specified virtual register More...
 
int assignVirt2StackSlot (unsigned virtReg)
 create a mapping for the specifed virtual register to the next available stack slot More...
 
void assignVirt2StackSlot (unsigned virtReg, int SS)
 create a mapping for the specified virtual register to the specified stack slot More...
 
void print (raw_ostream &OS, const Module *M=nullptr) const override
 print - Print out the internal state of the pass. More...
 
void dump () const
 
- Public Member Functions inherited from llvm::MachineFunctionPass
bool doInitialization (Module &) override
 doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. More...
 
- Public Member Functions inherited from llvm::FunctionPass
 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const override
 createPrinterPass - Get a function printer pass. More...
 
void assignPassManager (PMStack &PMS, PassManagerType T) override
 Find appropriate Function Pass Manager or Call Graph Pass Manager in the PM Stack and add self into that manager. More...
 
PassManagerType getPotentialPassManagerType () const override
 Return what kind of Pass Manager can manage this pass. More...
 
- Public Member Functions inherited from llvm::Pass
 Pass (PassKind K, char &pid)
 
 Pass (const Pass &)=delete
 
Passoperator= (const Pass &)=delete
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual StringRef getPassName () const
 getPassName - Return a nice clean name for a pass. More...
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. More...
 
virtual bool doFinalization (Module &)
 doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. More...
 
void dump () const
 
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not. More...
 
void setResolver (AnalysisResolver *AR)
 
AnalysisResolvergetResolver () const
 
virtual void releaseMemory ()
 releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed. More...
 
virtual void * getAdjustedAnalysisPointer (AnalysisID ID)
 getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance. More...
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
virtual void verifyAnalysis () const
 verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. More...
 
virtual void dumpPassStructure (unsigned Offset=0)
 
template<typename AnalysisType >
AnalysisType * getAnalysisIfAvailable () const
 getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it. More...
 
bool mustPreserveAnalysisID (char &AID) const
 mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis () const
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F)
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F)
 

Static Public Attributes

static char ID = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from llvm::Pass
static const PassInfolookupPassInfo (const void *TI)
 
static const PassInfolookupPassInfo (StringRef Arg)
 
static PasscreatePass (AnalysisID ID)
 
- Protected Member Functions inherited from llvm::MachineFunctionPass
 MachineFunctionPass (char &ID)
 
virtual MachineFunctionProperties getRequiredProperties () const
 
virtual MachineFunctionProperties getSetProperties () const
 
virtual MachineFunctionProperties getClearedProperties () const
 
- Protected Member Functions inherited from llvm::FunctionPass
bool skipFunction (const Function &F) const
 Optional passes call this function to check whether the pass should be skipped. More...
 

Detailed Description

Definition at line 34 of file VirtRegMap.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
NO_PHYS_REG 
NO_STACK_SLOT 
MAX_STACK_SLOT 

Definition at line 36 of file VirtRegMap.h.

Constructor & Destructor Documentation

◆ VirtRegMap() [1/2]

llvm::VirtRegMap::VirtRegMap ( )
inline

Definition at line 71 of file VirtRegMap.h.

References operator=(), and runOnMachineFunction().

◆ VirtRegMap() [2/2]

llvm::VirtRegMap::VirtRegMap ( const VirtRegMap )
delete

Member Function Documentation

◆ assignVirt2Phys()

void VirtRegMap::assignVirt2Phys ( unsigned  virtReg,
MCPhysReg  physReg 
)

◆ assignVirt2StackSlot() [1/2]

int VirtRegMap::assignVirt2StackSlot ( unsigned  virtReg)

create a mapping for the specifed virtual register to the next available stack slot

Definition at line 121 of file VirtRegMap.cpp.

References assert(), llvm::MachineRegisterInfo::getRegClass(), llvm::MachineFunction::getRegInfo(), llvm::TargetRegisterInfo::isVirtualRegister(), and NO_STACK_SLOT.

Referenced by getStackSlot().

◆ assignVirt2StackSlot() [2/2]

void VirtRegMap::assignVirt2StackSlot ( unsigned  virtReg,
int  SS 
)

create a mapping for the specified virtual register to the specified stack slot

Definition at line 129 of file VirtRegMap.cpp.

References assert(), llvm::MachineFunction::getFrameInfo(), llvm::MachineFrameInfo::getObjectIndexBegin(), llvm::TargetRegisterInfo::isVirtualRegister(), and NO_STACK_SLOT.

◆ clearAllVirt()

void llvm::VirtRegMap::clearAllVirt ( )
inline

clears all virtual to physical register mappings

Definition at line 120 of file VirtRegMap.h.

References llvm::IndexedMap< T, ToIndexT >::clear(), grow(), hasKnownPreference(), and hasPreferredPhys().

Referenced by isACalleeSavedRegister().

◆ clearVirt()

void llvm::VirtRegMap::clearVirt ( unsigned  virtReg)
inline

clears the specified virtual register's, physical register mapping

Definition at line 112 of file VirtRegMap.h.

References assert(), llvm::TargetRegisterInfo::isVirtualRegister(), and NO_PHYS_REG.

Referenced by llvm::LiveRegMatrix::unassign().

◆ dump()

LLVM_DUMP_METHOD void VirtRegMap::dump ( ) const

◆ getAnalysisUsage()

void llvm::VirtRegMap::getAnalysisUsage ( AnalysisUsage AU) const
inlineoverridevirtual

getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.

For MachineFunctionPasses, calling AU.preservesCFG() indicates that the pass does not modify the MachineBasicBlock CFG.

Reimplemented from llvm::MachineFunctionPass.

Definition at line 78 of file VirtRegMap.h.

References llvm::MachineFunctionPass::getAnalysisUsage(), and llvm::AnalysisUsage::setPreservesAll().

Referenced by dump().

◆ getMachineFunction()

MachineFunction& llvm::VirtRegMap::getMachineFunction ( ) const
inline

◆ getOriginal()

unsigned llvm::VirtRegMap::getOriginal ( unsigned  VirtReg) const
inline

getOriginal - Return the original virtual register that VirtReg descends from through splitting.

A register that was not created by splitting is its own original. This operation is idempotent.

Definition at line 147 of file VirtRegMap.h.

References getPreSplitReg().

Referenced by llvm::SplitEditor::dump(), llvm::SplitAnalysis::isOriginalEndpoint(), and isRematerializable().

◆ getPhys()

unsigned llvm::VirtRegMap::getPhys ( unsigned  virtReg) const
inline

◆ getPreSplitReg()

unsigned llvm::VirtRegMap::getPreSplitReg ( unsigned  virtReg) const
inline

returns the live interval virtReg is split from.

Definition at line 139 of file VirtRegMap.h.

Referenced by getOriginal().

◆ getRegInfo()

MachineRegisterInfo& llvm::VirtRegMap::getRegInfo ( ) const
inline

Definition at line 88 of file VirtRegMap.h.

Referenced by assignVirt2Phys(), llvm::RegAllocBase::init(), and isACalleeSavedRegister().

◆ getStackSlot()

int llvm::VirtRegMap::getStackSlot ( unsigned  virtReg) const
inline

returns the stack slot mapped to the specified virtual register

Definition at line 164 of file VirtRegMap.h.

References assert(), assignVirt2StackSlot(), dump(), llvm::TargetRegisterInfo::isVirtualRegister(), and print().

Referenced by isAssignedReg(), and llvm::LiveDebugVariables::splitRegister().

◆ getTargetRegInfo()

const TargetRegisterInfo& llvm::VirtRegMap::getTargetRegInfo ( ) const
inline

Definition at line 89 of file VirtRegMap.h.

References grow().

Referenced by llvm::AllocationOrder::AllocationOrder(), and llvm::RegAllocBase::init().

◆ grow()

void VirtRegMap::grow ( )

◆ hasKnownPreference()

bool VirtRegMap::hasKnownPreference ( unsigned  VirtReg)

returns true if VirtReg has a known preferred register.

This returns false if VirtReg has a preference that is a virtual register that hasn't been assigned yet.

Definition at line 112 of file VirtRegMap.cpp.

References llvm::MachineRegisterInfo::getRegAllocationHint(), hasPhys(), llvm::TargetRegisterInfo::isPhysicalRegister(), and llvm::TargetRegisterInfo::isVirtualRegister().

Referenced by clearAllVirt().

◆ hasPhys()

bool llvm::VirtRegMap::hasPhys ( unsigned  virtReg) const
inline

returns true if the specified virtual register is mapped to a physical register

Definition at line 95 of file VirtRegMap.h.

References getPhys(), and NO_PHYS_REG.

Referenced by llvm::RegAllocBase::allocatePhysRegs(), llvm::LiveRegMatrix::assign(), getRC32(), llvm::ARMBaseRegisterInfo::getRegAllocationHints(), and hasKnownPreference().

◆ hasPreferredPhys()

bool VirtRegMap::hasPreferredPhys ( unsigned  VirtReg)

returns true if VirtReg is assigned to its preferred physreg.

Definition at line 103 of file VirtRegMap.cpp.

References getPhys(), llvm::MachineRegisterInfo::getSimpleHint(), and llvm::TargetRegisterInfo::isVirtualRegister().

Referenced by clearAllVirt().

◆ isAssignedReg()

bool llvm::VirtRegMap::isAssignedReg ( unsigned  virtReg) const
inline

returns true if the specified virtual register is not mapped to a stack slot or rematerialized.

Definition at line 154 of file VirtRegMap.h.

References getStackSlot(), NO_PHYS_REG, and NO_STACK_SLOT.

Referenced by llvm::LiveDebugVariables::splitRegister().

◆ operator=()

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

Referenced by VirtRegMap().

◆ print()

void VirtRegMap::print ( raw_ostream OS,
const Module M = nullptr 
) const
overridevirtual

print - Print out the internal state of the pass.

This is called by Analyze to print out the contents of an analysis. Otherwise it is not necessary to implement this method. Beware that the module pointer MAY be null. This automatically forwards to a virtual function that does not provide the Module* in case the analysis doesn't need it it can just be ignored.

Reimplemented from llvm::Pass.

Definition at line 139 of file VirtRegMap.cpp.

References llvm::MachineRegisterInfo::getNumVirtRegs(), llvm::MachineRegisterInfo::getRegClass(), llvm::TargetRegisterInfo::getRegClassName(), llvm::TargetRegisterInfo::index2VirtReg(), NO_PHYS_REG, NO_STACK_SLOT, llvm::printReg(), and Reg.

Referenced by dump(), getStackSlot(), and llvm::operator<<().

◆ runOnMachineFunction()

bool VirtRegMap::runOnMachineFunction ( MachineFunction MF)
overridevirtual

runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.

Implements llvm::MachineFunctionPass.

Definition at line 63 of file VirtRegMap.cpp.

References MRI, TII, and TRI.

Referenced by dump(), and VirtRegMap().

◆ setIsSplitFromReg()

void llvm::VirtRegMap::setIsSplitFromReg ( unsigned  virtReg,
unsigned  SReg 
)
inline

records virtReg is a split live interval from SReg.

Definition at line 134 of file VirtRegMap.h.

Member Data Documentation

◆ ID

char VirtRegMap::ID = 0
static

Definition at line 69 of file VirtRegMap.h.

Referenced by dump().


The documentation for this class was generated from the following files: