LLVM 19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::SlotIndex Class Reference

SlotIndex - An opaque wrapper around machine indexes. More...

#include "llvm/CodeGen/SlotIndexes.h"

Public Types

enum  { InstrDist = 4 * Slot_Count }
 

Public Member Functions

 SlotIndex ()=default
 Construct an invalid index.
 
 SlotIndex (IndexListEntry *entry, unsigned slot)
 
 SlotIndex (const SlotIndex &li, Slot s)
 
bool isValid () const
 Returns true if this is a valid index.
 
 operator bool () const
 Return true for a valid index.
 
void print (raw_ostream &os) const
 Print this index to the given raw_ostream.
 
void dump () const
 Dump this index to stderr.
 
bool operator== (SlotIndex other) const
 Compare two SlotIndex objects for equality.
 
bool operator!= (SlotIndex other) const
 Compare two SlotIndex objects for inequality.
 
bool operator< (SlotIndex other) const
 Compare two SlotIndex objects.
 
bool operator<= (SlotIndex other) const
 Compare two SlotIndex objects.
 
bool operator> (SlotIndex other) const
 Compare two SlotIndex objects.
 
bool operator>= (SlotIndex other) const
 Compare two SlotIndex objects.
 
int distance (SlotIndex other) const
 Return the distance from this index to the given one.
 
int getApproxInstrDistance (SlotIndex other) const
 Return the scaled distance from this index to the given one, where all slots on the same instruction have zero distance, assuming that the slot indices are packed as densely as possible.
 
bool isBlock () const
 isBlock - Returns true if this is a block boundary slot.
 
bool isEarlyClobber () const
 isEarlyClobber - Returns true if this is an early-clobber slot.
 
bool isRegister () const
 isRegister - Returns true if this is a normal register use/def slot.
 
bool isDead () const
 isDead - Returns true if this is a dead def kill slot.
 
SlotIndex getBaseIndex () const
 Returns the base index for associated with this index.
 
SlotIndex getBoundaryIndex () const
 Returns the boundary index for associated with this index.
 
SlotIndex getRegSlot (bool EC=false) const
 Returns the register use/def slot in the current instruction for a normal or early-clobber def.
 
SlotIndex getDeadSlot () const
 Returns the dead def kill slot for the current instruction.
 
SlotIndex getNextSlot () const
 Returns the next slot in the index list.
 
SlotIndex getNextIndex () const
 Returns the next index.
 
SlotIndex getPrevSlot () const
 Returns the previous slot in the index list.
 
SlotIndex getPrevIndex () const
 Returns the previous index.
 

Static Public Member Functions

static bool isSameInstr (SlotIndex A, SlotIndex B)
 isSameInstr - Return true if A and B refer to the same instruction.
 
static bool isEarlierInstr (SlotIndex A, SlotIndex B)
 isEarlierInstr - Return true if A refers to an instruction earlier than B.
 
static bool isEarlierEqualInstr (SlotIndex A, SlotIndex B)
 Return true if A refers to the same instruction as B or an earlier one.
 

Friends

class SlotIndexes
 

Detailed Description

SlotIndex - An opaque wrapper around machine indexes.

Definition at line 68 of file SlotIndexes.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
InstrDist 

The default distance between instructions as returned by distance().

This may vary as instructions are inserted and removed.

Definition at line 112 of file SlotIndexes.h.

Constructor & Destructor Documentation

◆ SlotIndex() [1/3]

llvm::SlotIndex::SlotIndex ( )
default

◆ SlotIndex() [2/3]

llvm::SlotIndex::SlotIndex ( IndexListEntry entry,
unsigned  slot 
)
inline

Definition at line 124 of file SlotIndexes.h.

◆ SlotIndex() [3/3]

llvm::SlotIndex::SlotIndex ( const SlotIndex li,
Slot  s 
)
inline

Definition at line 127 of file SlotIndexes.h.

References assert(), and isValid().

Member Function Documentation

◆ distance()

int llvm::SlotIndex::distance ( SlotIndex  other) const
inline

Return the distance from this index to the given one.

Definition at line 196 of file SlotIndexes.h.

◆ dump()

LLVM_DUMP_METHOD void SlotIndex::dump ( ) const

Dump this index to stderr.

Definition at line 273 of file SlotIndexes.cpp.

References llvm::dbgs(), and print().

◆ getApproxInstrDistance()

int llvm::SlotIndex::getApproxInstrDistance ( SlotIndex  other) const
inline

Return the scaled distance from this index to the given one, where all slots on the same instruction have zero distance, assuming that the slot indices are packed as densely as possible.

There are normally gaps between instructions, so this assumption often doesn't hold. This results in this function often returning a value greater than the actual instruction distance.

Definition at line 206 of file SlotIndexes.h.

References llvm::IndexListEntry::getIndex().

◆ getBaseIndex()

SlotIndex llvm::SlotIndex::getBaseIndex ( ) const
inline

◆ getBoundaryIndex()

SlotIndex llvm::SlotIndex::getBoundaryIndex ( ) const
inline

Returns the boundary index for associated with this index.

The boundary index is the one associated with the Slot_Block slot for the instruction pointed to by this index.

Definition at line 234 of file SlotIndexes.h.

References SlotIndex().

Referenced by llvm::SplitEditor::splitLiveThroughBlock(), and llvm::SplitEditor::splitRegInBlock().

◆ getDeadSlot()

SlotIndex llvm::SlotIndex::getDeadSlot ( ) const
inline

◆ getNextIndex()

SlotIndex llvm::SlotIndex::getNextIndex ( ) const
inline

Returns the next index.

This is the index corresponding to the this index's slot, but for the next instruction.

Definition at line 265 of file SlotIndexes.h.

References SlotIndex().

Referenced by extractInstructionFeatures().

◆ getNextSlot()

SlotIndex llvm::SlotIndex::getNextSlot ( ) const
inline

Returns the next slot in the index list.

This could be either the next slot for the instruction pointed to by this index or, if this index is a STORE, the first slot for the next instruction. WARNING: This method is considerably more expensive than the methods that return specific slots (getUseIndex(), etc). If you can - please use one of those methods.

Definition at line 255 of file SlotIndexes.h.

References SlotIndex().

Referenced by llvm::SplitEditor::leaveIntvAfter().

◆ getPrevIndex()

SlotIndex llvm::SlotIndex::getPrevIndex ( ) const
inline

Returns the previous index.

This is the index corresponding to this index's slot, but for the previous instruction.

Definition at line 285 of file SlotIndexes.h.

References SlotIndex().

◆ getPrevSlot()

SlotIndex llvm::SlotIndex::getPrevSlot ( ) const
inline

Returns the previous slot in the index list.

This could be either the previous slot for the instruction pointed to by this index or, if this index is a Slot_Block, the last slot for the previous instruction. WARNING: This method is considerably more expensive than the methods that return specific slots (getUseIndex(), etc). If you can - please use one of those methods.

Definition at line 275 of file SlotIndexes.h.

References SlotIndex().

Referenced by llvm::LiveIntervals::repairIntervalsInRange(), and llvm::MachineBasicBlock::SplitCriticalEdge().

◆ getRegSlot()

SlotIndex llvm::SlotIndex::getRegSlot ( bool  EC = false) const
inline

◆ isBlock()

bool llvm::SlotIndex::isBlock ( ) const
inline

isBlock - Returns true if this is a block boundary slot.

Definition at line 212 of file SlotIndexes.h.

Referenced by llvm::LiveIntervals::intervalIsInOneMBB(), and llvm::VNInfo::isPHIDef().

◆ isDead()

bool llvm::SlotIndex::isDead ( ) const
inline

isDead - Returns true if this is a dead def kill slot.

Definition at line 222 of file SlotIndexes.h.

Referenced by addSegmentsWithValNo(), and llvm::LiveQueryResult::isDeadDef().

◆ isEarlierEqualInstr()

static bool llvm::SlotIndex::isEarlierEqualInstr ( SlotIndex  A,
SlotIndex  B 
)
inlinestatic

Return true if A refers to the same instruction as B or an earlier one.

This is equivalent to !isEarlierInstr(B, A).

Definition at line 191 of file SlotIndexes.h.

References A, B, and isEarlierInstr().

Referenced by findNextInsertLocation().

◆ isEarlierInstr()

static bool llvm::SlotIndex::isEarlierInstr ( SlotIndex  A,
SlotIndex  B 
)
inlinestatic

isEarlierInstr - Return true if A refers to an instruction earlier than B.

This is equivalent to A < B && !isSameInstr(A, B).

Definition at line 185 of file SlotIndexes.h.

References A, and B.

Referenced by isEarlierEqualInstr(), and llvm::LiveRange::Query().

◆ isEarlyClobber()

bool llvm::SlotIndex::isEarlyClobber ( ) const
inline

isEarlyClobber - Returns true if this is an early-clobber slot.

Definition at line 215 of file SlotIndexes.h.

◆ isRegister()

bool llvm::SlotIndex::isRegister ( ) const
inline

isRegister - Returns true if this is a normal register use/def slot.

Note that early-clobber slots may also be used for uses and defs.

Definition at line 219 of file SlotIndexes.h.

◆ isSameInstr()

static bool llvm::SlotIndex::isSameInstr ( SlotIndex  A,
SlotIndex  B 
)
inlinestatic

isSameInstr - Return true if A and B refer to the same instruction.

Definition at line 179 of file SlotIndexes.h.

References A, and B.

Referenced by llvm::LiveRangeEdit::allUsesAvailableAt(), llvm::SplitEditor::leaveIntvAfter(), and llvm::LiveRange::Query().

◆ isValid()

bool llvm::SlotIndex::isValid ( ) const
inline

Returns true if this is a valid index.

Invalid indices do not point into an index table, and cannot be compared.

Definition at line 133 of file SlotIndexes.h.

References llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info >::getPointer().

Referenced by llvm::SIRegisterInfo::findReachingDef(), llvm::LiveRangeUpdater::isDirty(), llvm::VNInfo::isUnused(), operator bool(), print(), and SlotIndex().

◆ operator bool()

llvm::SlotIndex::operator bool ( ) const
inlineexplicit

Return true for a valid index.

Definition at line 138 of file SlotIndexes.h.

References isValid().

◆ operator!=()

bool llvm::SlotIndex::operator!= ( SlotIndex  other) const
inline

Compare two SlotIndex objects for inequality.

Definition at line 151 of file SlotIndexes.h.

◆ operator<()

bool llvm::SlotIndex::operator< ( SlotIndex  other) const
inline

Compare two SlotIndex objects.

Return true if the first index is strictly lower than the second.

Definition at line 157 of file SlotIndexes.h.

◆ operator<=()

bool llvm::SlotIndex::operator<= ( SlotIndex  other) const
inline

Compare two SlotIndex objects.

Return true if the first index is lower than, or equal to, the second.

Definition at line 162 of file SlotIndexes.h.

◆ operator==()

bool llvm::SlotIndex::operator== ( SlotIndex  other) const
inline

Compare two SlotIndex objects for equality.

Definition at line 147 of file SlotIndexes.h.

◆ operator>()

bool llvm::SlotIndex::operator> ( SlotIndex  other) const
inline

Compare two SlotIndex objects.

Return true if the first index is greater than the second.

Definition at line 168 of file SlotIndexes.h.

◆ operator>=()

bool llvm::SlotIndex::operator>= ( SlotIndex  other) const
inline

Compare two SlotIndex objects.

Return true if the first index is greater than, or equal to, the second.

Definition at line 174 of file SlotIndexes.h.

◆ print()

void SlotIndex::print ( raw_ostream os) const

Print this index to the given raw_ostream.

Definition at line 264 of file SlotIndexes.cpp.

References llvm::IndexListEntry::getIndex(), and isValid().

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

Friends And Related Function Documentation

◆ SlotIndexes

friend class SlotIndexes
friend

Definition at line 69 of file SlotIndexes.h.


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