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

This class provides computation of slot numbers for LLVM Assembly writing. More...

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

Public Types

using ValueMap = DenseMap< const Value *, unsigned >
 ValueMap - A mapping of Values to slot numbers.
 
using mdn_iterator = DenseMap< const MDNode *, unsigned >::iterator
 MDNode map iterators.
 
using as_iterator = DenseMap< AttributeSet, unsigned >::iterator
 AttributeSet map iterators.
 
using guid_iterator = DenseMap< GlobalValue::GUID, unsigned >::iterator
 GUID map iterators.
 

Public Member Functions

 SlotTracker (const Module *M, bool ShouldInitializeAllMetadata=false)
 Construct from a module.
 
 SlotTracker (const Function *F, bool ShouldInitializeAllMetadata=false)
 Construct from a function, starting out in incorp state.
 
 SlotTracker (const ModuleSummaryIndex *Index)
 Construct from a module summary index.
 
 SlotTracker (const SlotTracker &)=delete
 
SlotTrackeroperator= (const SlotTracker &)=delete
 
 ~SlotTracker ()=default
 
void setProcessHook (std::function< void(AbstractSlotTrackerStorage *, const Module *, bool)>)
 
void setProcessHook (std::function< void(AbstractSlotTrackerStorage *, const Function *, bool)>)
 
unsigned getNextMetadataSlot () override
 
void createMetadataSlot (const MDNode *N) override
 getMetadataSlot - Get the slot number of a MDNode.
 
int getLocalSlot (const Value *V)
 Return the slot number of the specified value in it's type plane.
 
int getGlobalSlot (const GlobalValue *V)
 getGlobalSlot - Get the slot number of a global value.
 
int getMetadataSlot (const MDNode *N) override
 getMetadataSlot - Get the slot number of a MDNode.
 
int getAttributeGroupSlot (AttributeSet AS)
 
int getModulePathSlot (StringRef Path)
 
int getGUIDSlot (GlobalValue::GUID GUID)
 
int getTypeIdSlot (StringRef Id)
 
int getTypeIdCompatibleVtableSlot (StringRef Id)
 
void incorporateFunction (const Function *F)
 If you'd like to deal with a function instead of just a module, use this method to get its data into the SlotTracker.
 
const FunctiongetFunction () const
 
void purgeFunction ()
 After calling incorporateFunction, use this method to remove the most recently incorporated function from the SlotTracker.
 
mdn_iterator mdn_begin ()
 
mdn_iterator mdn_end ()
 
unsigned mdn_size () const
 
bool mdn_empty () const
 
as_iterator as_begin ()
 
as_iterator as_end ()
 
unsigned as_size () const
 
bool as_empty () const
 
void initializeIfNeeded ()
 These functions do the actual initialization.
 
int initializeIndexIfNeeded ()
 
- Public Member Functions inherited from llvm::AbstractSlotTrackerStorage
virtual ~AbstractSlotTrackerStorage ()
 
virtual unsigned getNextMetadataSlot ()=0
 
virtual void createMetadataSlot (const MDNode *)=0
 
virtual int getMetadataSlot (const MDNode *)=0
 

Detailed Description

This class provides computation of slot numbers for LLVM Assembly writing.

Definition at line 690 of file AsmWriter.cpp.

Member Typedef Documentation

◆ as_iterator

AttributeSet map iterators.

Definition at line 813 of file AsmWriter.cpp.

◆ guid_iterator

GUID map iterators.

Definition at line 821 of file AsmWriter.cpp.

◆ mdn_iterator

MDNode map iterators.

Definition at line 805 of file AsmWriter.cpp.

◆ ValueMap

ValueMap - A mapping of Values to slot numbers.

Definition at line 693 of file AsmWriter.cpp.

Constructor & Destructor Documentation

◆ SlotTracker() [1/4]

SlotTracker::SlotTracker ( const Module M,
bool  ShouldInitializeAllMetadata = false 
)
explicit

Construct from a module.

If ShouldInitializeAllMetadata, initializes all metadata in all functions, giving correct numbering for metadata referenced only from within a function (even if no functions have been initialized).

Definition at line 961 of file AsmWriter.cpp.

◆ SlotTracker() [2/4]

SlotTracker::SlotTracker ( const Function F,
bool  ShouldInitializeAllMetadata = false 
)
explicit

Construct from a function, starting out in incorp state.

If ShouldInitializeAllMetadata, initializes all metadata in all functions, giving correct numbering for metadata referenced only from within a function (even if no functions have been initialized).

Definition at line 966 of file AsmWriter.cpp.

◆ SlotTracker() [3/4]

SlotTracker::SlotTracker ( const ModuleSummaryIndex Index)
explicit

Construct from a module summary index.

Definition at line 970 of file AsmWriter.cpp.

◆ SlotTracker() [4/4]

llvm::SlotTracker::SlotTracker ( const SlotTracker )
delete

◆ ~SlotTracker()

llvm::SlotTracker::~SlotTracker ( )
default

Member Function Documentation

◆ as_begin()

as_iterator llvm::SlotTracker::as_begin ( )
inline

◆ as_empty()

bool llvm::SlotTracker::as_empty ( ) const
inline

◆ as_end()

as_iterator llvm::SlotTracker::as_end ( )
inline

◆ as_size()

unsigned llvm::SlotTracker::as_size ( ) const
inline

◆ createMetadataSlot()

void SlotTracker::createMetadataSlot ( const MDNode N)
overridevirtual

getMetadataSlot - Get the slot number of a MDNode.

Implements llvm::AbstractSlotTrackerStorage.

Definition at line 1203 of file AsmWriter.cpp.

References N.

◆ getAttributeGroupSlot()

int SlotTracker::getAttributeGroupSlot ( AttributeSet  AS)

◆ getFunction()

const Function * llvm::SlotTracker::getFunction ( ) const
inline

Definition at line 797 of file AsmWriter.cpp.

◆ getGlobalSlot()

int SlotTracker::getGlobalSlot ( const GlobalValue V)

◆ getGUIDSlot()

int SlotTracker::getGUIDSlot ( GlobalValue::GUID  GUID)

◆ getLocalSlot()

int SlotTracker::getLocalSlot ( const Value V)

Return the slot number of the specified value in it's type plane.

getLocalSlot - Get the slot number for a value that is local to a function.

If something is not in the SlotTracker, return -1.

Definition at line 1216 of file AsmWriter.cpp.

References assert(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), and initializeIfNeeded().

Referenced by llvm::ModuleSlotTracker::getLocalSlot().

◆ getMetadataSlot()

int SlotTracker::getMetadataSlot ( const MDNode N)
overridevirtual

◆ getModulePathSlot()

int SlotTracker::getModulePathSlot ( StringRef  Path)

◆ getNextMetadataSlot()

unsigned llvm::SlotTracker::getNextMetadataSlot ( )
inlineoverridevirtual

Implements llvm::AbstractSlotTrackerStorage.

Definition at line 775 of file AsmWriter.cpp.

◆ getTypeIdCompatibleVtableSlot()

int SlotTracker::getTypeIdCompatibleVtableSlot ( StringRef  Id)

◆ getTypeIdSlot()

int SlotTracker::getTypeIdSlot ( StringRef  Id)

◆ incorporateFunction()

void llvm::SlotTracker::incorporateFunction ( const Function F)
inline

If you'd like to deal with a function instead of just a module, use this method to get its data into the SlotTracker.

Definition at line 792 of file AsmWriter.cpp.

References F.

Referenced by llvm::ModuleSlotTracker::incorporateFunction().

◆ initializeIfNeeded()

void SlotTracker::initializeIfNeeded ( )
inline

These functions do the actual initialization.

< Prevent re-processing next time we're called.

Definition at line 973 of file AsmWriter.cpp.

Referenced by getAttributeGroupSlot(), getGlobalSlot(), getLocalSlot(), and getMetadataSlot().

◆ initializeIndexIfNeeded()

int SlotTracker::initializeIndexIfNeeded ( )

< Prevent re-processing next time we're called.

Definition at line 983 of file AsmWriter.cpp.

Referenced by getGUIDSlot(), getModulePathSlot(), getTypeIdCompatibleVtableSlot(), and getTypeIdSlot().

◆ mdn_begin()

mdn_iterator llvm::SlotTracker::mdn_begin ( )
inline

◆ mdn_empty()

bool llvm::SlotTracker::mdn_empty ( ) const
inline

◆ mdn_end()

mdn_iterator llvm::SlotTracker::mdn_end ( )
inline

◆ mdn_size()

unsigned llvm::SlotTracker::mdn_size ( ) const
inline

◆ operator=()

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

◆ purgeFunction()

void SlotTracker::purgeFunction ( )

After calling incorporateFunction, use this method to remove the most recently incorporated function from the SlotTracker.

Clean up after incorporating a function.

This will reset the state of the machine back to just the module contents.

This is the only way to get out of the function incorporation state that affects get*Slot/Create*Slot. Function incorporation state is indicated by TheFunction != 0.

Definition at line 1172 of file AsmWriter.cpp.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::clear(), and ST_DEBUG.

Referenced by llvm::ModuleSlotTracker::incorporateFunction().

◆ setProcessHook() [1/2]

void SlotTracker::setProcessHook ( std::function< void(AbstractSlotTrackerStorage *, const Function *, bool)>  Fn)

Definition at line 1196 of file AsmWriter.cpp.

◆ setProcessHook() [2/2]

void SlotTracker::setProcessHook ( std::function< void(AbstractSlotTrackerStorage *, const Module *, bool)>  Fn)

Definition at line 1190 of file AsmWriter.cpp.

Referenced by llvm::ModuleSlotTracker::getMachine().


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