LLVM  6.0.0svn
Public Types | Public Member Functions | Static Public Attributes | List of all members
llvm::SlotIndexes Class Reference

SlotIndexes pass. More...

#include "llvm/CodeGen/SlotIndexes.h"

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

Public Types

using MBBIndexIterator = SmallVectorImpl< IdxMBBPair >::const_iterator
 Iterator over the idx2MBBMap (sorted pairs of slot index of basic block begin and basic block) More...
 

Public Member Functions

 SlotIndexes ()
 
 ~SlotIndexes () override
 
void getAnalysisUsage (AnalysisUsage &au) const override
 getAnalysisUsage - Subclasses that override getAnalysisUsage must call this. More...
 
void releaseMemory () override
 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...
 
bool runOnMachineFunction (MachineFunction &fn) override
 runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis. More...
 
void dump () const
 Dump the indexes. More...
 
void renumberIndexes ()
 Renumber the index list, providing space for new instructions. More...
 
void repairIndexesInRange (MachineBasicBlock *MBB, MachineBasicBlock::iterator Begin, MachineBasicBlock::iterator End)
 Repair indexes after adding and removing instructions. More...
 
SlotIndex getZeroIndex ()
 Returns the zero index for this analysis. More...
 
SlotIndex getLastIndex ()
 Returns the base index of the last slot in this analysis. More...
 
bool hasIndex (const MachineInstr &instr) const
 Returns true if the given machine instr is mapped to an index, otherwise returns false. More...
 
SlotIndex getInstructionIndex (const MachineInstr &MI) const
 Returns the base index for the given instruction. More...
 
MachineInstrgetInstructionFromIndex (SlotIndex index) const
 Returns the instruction for the given index, or null if the given index has no instruction associated with it. More...
 
SlotIndex getNextNonNullIndex (SlotIndex Index)
 Returns the next non-null index, if one exists. More...
 
SlotIndex getIndexBefore (const MachineInstr &MI) const
 getIndexBefore - Returns the index of the last indexed instruction before MI, or the start index of its basic block. More...
 
SlotIndex getIndexAfter (const MachineInstr &MI) const
 getIndexAfter - Returns the index of the first indexed instruction after MI, or the end index of its basic block. More...
 
const std::pair< SlotIndex, SlotIndex > & getMBBRange (unsigned Num) const
 Return the (start,end) range of the given basic block number. More...
 
const std::pair< SlotIndex, SlotIndex > & getMBBRange (const MachineBasicBlock *MBB) const
 Return the (start,end) range of the given basic block. More...
 
SlotIndex getMBBStartIdx (unsigned Num) const
 Returns the first index in the given basic block number. More...
 
SlotIndex getMBBStartIdx (const MachineBasicBlock *mbb) const
 Returns the first index in the given basic block. More...
 
SlotIndex getMBBEndIdx (unsigned Num) const
 Returns the last index in the given basic block number. More...
 
SlotIndex getMBBEndIdx (const MachineBasicBlock *mbb) const
 Returns the last index in the given basic block. More...
 
MBBIndexIterator advanceMBBIndex (MBBIndexIterator I, SlotIndex To) const
 Move iterator to the next IdxMBBPair where the SlotIndex is greater or equal to To. More...
 
MBBIndexIterator findMBBIndex (SlotIndex Idx) const
 Get an iterator pointing to the IdxMBBPair with the biggest SlotIndex that is greater or equal to Idx. More...
 
MBBIndexIterator MBBIndexBegin () const
 Returns an iterator for the begin of the idx2MBBMap. More...
 
MBBIndexIterator MBBIndexEnd () const
 Return an iterator for the end of the idx2MBBMap. More...
 
MachineBasicBlockgetMBBFromIndex (SlotIndex index) const
 Returns the basic block which the given index falls in. More...
 
MachineBasicBlockgetMBBCoveringRange (SlotIndex start, SlotIndex end) const
 Returns the MBB covering the given range, or null if the range covers more than one basic block. More...
 
SlotIndex insertMachineInstrInMaps (MachineInstr &MI, bool Late=false)
 Insert the given machine instruction into the mapping. More...
 
void removeMachineInstrFromMaps (MachineInstr &MI)
 Removes machine instruction (bundle) MI from the mapping. More...
 
void removeSingleMachineInstrFromMaps (MachineInstr &MI)
 Removes a single machine instruction MI from the mapping. More...
 
SlotIndex replaceMachineInstrInMaps (MachineInstr &MI, MachineInstr &NewMI)
 ReplaceMachineInstrInMaps - Replacing a machine instr with a new one in maps used by register allocator. More...
 
void insertMBBInMaps (MachineBasicBlock *mbb)
 Add the given MachineBasicBlock into the maps. More...
 
void eraseIndex (SlotIndex index)
 Free the resources that were required to maintain a SlotIndex. More...
 
- 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...
 
virtual void print (raw_ostream &OS, const Module *M) const
 print - Print out the internal state of the pass. 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 * 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

SlotIndexes pass.

This pass assigns indexes to each instruction.

Definition at line 331 of file SlotIndexes.h.

Member Typedef Documentation

◆ MBBIndexIterator

Iterator over the idx2MBBMap (sorted pairs of slot index of basic block begin and basic block)

Definition at line 508 of file SlotIndexes.h.

Constructor & Destructor Documentation

◆ SlotIndexes()

llvm::SlotIndexes::SlotIndexes ( )
inline

◆ ~SlotIndexes()

llvm::SlotIndexes::~SlotIndexes ( )
inlineoverride

Member Function Documentation

◆ advanceMBBIndex()

MBBIndexIterator llvm::SlotIndexes::advanceMBBIndex ( MBBIndexIterator  I,
SlotIndex  To 
) const
inline

Move iterator to the next IdxMBBPair where the SlotIndex is greater or equal to To.

Definition at line 512 of file SlotIndexes.h.

References llvm::SmallVectorTemplateCommon< T, typename >::end(), and llvm::lower_bound().

◆ dump()

LLVM_DUMP_METHOD void SlotIndexes::dump ( ) const

Dump the indexes.

Definition at line 254 of file SlotIndexes.cpp.

References llvm::dbgs().

◆ eraseIndex()

void llvm::SlotIndexes::eraseIndex ( SlotIndex  index)
inline

Free the resources that were required to maintain a SlotIndex.

Once an index is no longer needed (for instance because the instruction at that index has been moved), the resources required to maintain the index can be relinquished to reduce memory use and improve renumbering performance. Any remaining SlotIndex objects that point to the same index are left 'dangling' (much the same as a dangling pointer to a freed object) and should not be accessed, except to destruct them.

Like dangling pointers, access to dangling SlotIndexes can cause painful-to-track-down bugs, especially if the memory for the index previously pointed to has been re-used. To detect dangling SlotIndex bugs, build with EXPENSIVE_CHECKS=1. This will cause "erased" indexes to be retained in a graveyard instead of being freed. Operations on indexes in the graveyard will trigger an assertion.

Definition at line 695 of file SlotIndexes.h.

References llvm::iplist_impl< IntrusiveListT, TraitsT >::erase(), llvm::iplist_impl< IntrusiveListT, TraitsT >::push_back(), and llvm::iplist_impl< IntrusiveListT, TraitsT >::remove().

◆ findMBBIndex()

MBBIndexIterator llvm::SlotIndexes::findMBBIndex ( SlotIndex  Idx) const
inline

Get an iterator pointing to the IdxMBBPair with the biggest SlotIndex that is greater or equal to Idx.

Definition at line 518 of file SlotIndexes.h.

References llvm::SmallVectorTemplateCommon< T, typename >::begin().

◆ getAnalysisUsage()

void SlotIndexes::getAnalysisUsage ( AnalysisUsage AU) const
overridevirtual

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 28 of file SlotIndexes.cpp.

References llvm::MachineFunctionPass::getAnalysisUsage().

◆ getIndexAfter()

SlotIndex llvm::SlotIndexes::getIndexAfter ( const MachineInstr MI) const
inline

getIndexAfter - Returns the index of the first indexed instruction after MI, or the end index of its basic block.

MI is not required to have an index.

Definition at line 460 of file SlotIndexes.h.

References assert(), E, llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::MachineBasicBlock::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), llvm::MachineInstr::getParent(), I, and MI.

◆ getIndexBefore()

SlotIndex llvm::SlotIndexes::getIndexBefore ( const MachineInstr MI) const
inline

getIndexBefore - Returns the index of the last indexed instruction before MI, or the start index of its basic block.

MI is not required to have an index.

Definition at line 443 of file SlotIndexes.h.

References assert(), B, llvm::MachineBasicBlock::begin(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), llvm::MachineInstr::getParent(), I, and MI.

◆ getInstructionFromIndex()

MachineInstr* llvm::SlotIndexes::getInstructionFromIndex ( SlotIndex  index) const
inline

Returns the instruction for the given index, or null if the given index has no instruction associated with it.

Definition at line 424 of file SlotIndexes.h.

References llvm::IndexListEntry::getInstr(), and llvm::SlotIndex::isValid().

Referenced by llvm::LiveRangeCalc::calculateValues(), llvm::LiveIntervals::getInstructionFromIndex(), getNumAllocatableRegsForConstraints(), llvm::LiveRange::overlaps(), and llvm::LiveIntervals::HMEditor::updateAllRanges().

◆ getInstructionIndex()

SlotIndex llvm::SlotIndexes::getInstructionIndex ( const MachineInstr MI) const
inline

◆ getLastIndex()

SlotIndex llvm::SlotIndexes::getLastIndex ( )
inline

Returns the base index of the last slot in this analysis.

Definition at line 403 of file SlotIndexes.h.

Referenced by llvm::createGreedyRegisterAllocator().

◆ getMBBCoveringRange()

MachineBasicBlock* llvm::SlotIndexes::getMBBCoveringRange ( SlotIndex  start,
SlotIndex  end 
) const
inline

Returns the MBB covering the given range, or null if the range covers more than one basic block.

Definition at line 551 of file SlotIndexes.h.

References assert().

◆ getMBBEndIdx() [1/2]

SlotIndex llvm::SlotIndexes::getMBBEndIdx ( unsigned  Num) const
inline

◆ getMBBEndIdx() [2/2]

SlotIndex llvm::SlotIndexes::getMBBEndIdx ( const MachineBasicBlock mbb) const
inline

Returns the last index in the given basic block.

Definition at line 502 of file SlotIndexes.h.

◆ getMBBFromIndex()

MachineBasicBlock* llvm::SlotIndexes::getMBBFromIndex ( SlotIndex  index) const
inline

◆ getMBBRange() [1/2]

const std::pair<SlotIndex, SlotIndex>& llvm::SlotIndexes::getMBBRange ( unsigned  Num) const
inline

◆ getMBBRange() [2/2]

const std::pair<SlotIndex, SlotIndex>& llvm::SlotIndexes::getMBBRange ( const MachineBasicBlock MBB) const
inline

Return the (start,end) range of the given basic block.

Definition at line 482 of file SlotIndexes.h.

References llvm::MachineBasicBlock::getNumber().

◆ getMBBStartIdx() [1/2]

SlotIndex llvm::SlotIndexes::getMBBStartIdx ( unsigned  Num) const
inline

◆ getMBBStartIdx() [2/2]

SlotIndex llvm::SlotIndexes::getMBBStartIdx ( const MachineBasicBlock mbb) const
inline

Returns the first index in the given basic block.

Definition at line 492 of file SlotIndexes.h.

◆ getNextNonNullIndex()

SlotIndex llvm::SlotIndexes::getNextNonNullIndex ( SlotIndex  Index)
inline

Returns the next non-null index, if one exists.

Otherwise returns getLastIndex().

Definition at line 430 of file SlotIndexes.h.

References E, llvm::ilist_node_impl< OptionsT >::getIterator(), and I.

Referenced by llvm::LiveRange::isZeroLength(), and llvm::LiveIntervals::HMEditor::updateAllRanges().

◆ getZeroIndex()

SlotIndex llvm::SlotIndexes::getZeroIndex ( )
inline

Returns the zero index for this analysis.

Definition at line 397 of file SlotIndexes.h.

References assert().

Referenced by llvm::createGreedyRegisterAllocator(), and getStartOrEndSlot().

◆ hasIndex()

bool llvm::SlotIndexes::hasIndex ( const MachineInstr instr) const
inline

Returns true if the given machine instr is mapped to an index, otherwise returns false.

Definition at line 409 of file SlotIndexes.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::count().

Referenced by llvm::LiveIntervals::isNotInMIMap(), matchPair(), llvm::MachineBasicBlock::print(), repairIndexesInRange(), and llvm::MachineFunction::verify().

◆ insertMachineInstrInMaps()

SlotIndex llvm::SlotIndexes::insertMachineInstrInMaps ( MachineInstr MI,
bool  Late = false 
)
inline

◆ insertMBBInMaps()

void llvm::SlotIndexes::insertMBBInMaps ( MachineBasicBlock mbb)
inline

◆ MBBIndexBegin()

MBBIndexIterator llvm::SlotIndexes::MBBIndexBegin ( ) const
inline

Returns an iterator for the begin of the idx2MBBMap.

Definition at line 523 of file SlotIndexes.h.

References llvm::SmallVectorTemplateCommon< T, typename >::begin().

Referenced by llvm::MachineFunction::verify().

◆ MBBIndexEnd()

MBBIndexIterator llvm::SlotIndexes::MBBIndexEnd ( ) const
inline

Return an iterator for the end of the idx2MBBMap.

Definition at line 528 of file SlotIndexes.h.

References llvm::SmallVectorTemplateCommon< T, typename >::end().

Referenced by llvm::MachineFunction::verify().

◆ releaseMemory()

void SlotIndexes::releaseMemory ( )
overridevirtual

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.

The default behavior of passes is to hold onto memory for the entire duration of their lifetime (which is the entire compile time). For pipelined passes, this is not a big deal because that memory gets recycled every time the pass is invoked on another program unit. For IP passes, it is more important to free memory when it is unused.

Optionally implement this function to release pass memory when it is no longer used.

Reimplemented from llvm::Pass.

Definition at line 33 of file SlotIndexes.cpp.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::clear(), llvm::iplist_impl< IntrusiveListT, TraitsT >::clear(), llvm::SmallVectorImpl< T >::clear(), and llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold >::Reset().

◆ removeMachineInstrFromMaps()

void SlotIndexes::removeMachineInstrFromMaps ( MachineInstr MI)

◆ removeSingleMachineInstrFromMaps()

void SlotIndexes::removeSingleMachineInstrFromMaps ( MachineInstr MI)

◆ renumberIndexes()

void SlotIndexes::renumberIndexes ( )

Renumber the index list, providing space for new instructions.

Definition at line 148 of file SlotIndexes.cpp.

References llvm::dbgs(), DEBUG, E, I, and llvm::SlotIndex::InstrDist.

◆ repairIndexesInRange()

void SlotIndexes::repairIndexesInRange ( MachineBasicBlock MBB,
MachineBasicBlock::iterator  Begin,
MachineBasicBlock::iterator  End 
)

◆ replaceMachineInstrInMaps()

SlotIndex llvm::SlotIndexes::replaceMachineInstrInMaps ( MachineInstr MI,
MachineInstr NewMI 
)
inline

◆ runOnMachineFunction()

bool SlotIndexes::runOnMachineFunction ( MachineFunction MF)
overridevirtual

Member Data Documentation

◆ ID

char SlotIndexes::ID = 0
static

Definition at line 369 of file SlotIndexes.h.


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