LLVM  9.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::ModuleSummaryIndex Class Reference

Class to hold module path string table and global value map, and encapsulate methods for operating on them. More...

#include "llvm/IR/ModuleSummaryIndex.h"

Public Types

typedef ModulePathStringTableTy::value_type ModuleInfo
 

Public Member Functions

 ModuleSummaryIndex (bool HaveGVs, bool EnableSplitLTOUnit=false)
 
bool haveGVs () const
 
gvsummary_iterator begin ()
 
const_gvsummary_iterator begin () const
 
gvsummary_iterator end ()
 
const_gvsummary_iterator end () const
 
size_t size () const
 
FunctionSummary calculateCallGraphRoot ()
 
bool withGlobalValueDeadStripping () const
 
void setWithGlobalValueDeadStripping ()
 
bool hasSyntheticEntryCounts () const
 
void setHasSyntheticEntryCounts ()
 
bool skipModuleByDistributedBackend () const
 
void setSkipModuleByDistributedBackend ()
 
bool enableSplitLTOUnit () const
 
void setEnableSplitLTOUnit ()
 
bool partiallySplitLTOUnits () const
 
void setPartiallySplitLTOUnits ()
 
bool isGlobalValueLive (const GlobalValueSummary *GVS) const
 
bool isGUIDLive (GlobalValue::GUID GUID) const
 
ValueInfo getValueInfo (const GlobalValueSummaryMapTy::value_type &R) const
 Return a ValueInfo for the index value_type (convenient when iterating index). More...
 
ValueInfo getValueInfo (GlobalValue::GUID GUID) const
 Return a ValueInfo for GUID if it exists, otherwise return ValueInfo(). More...
 
ValueInfo getOrInsertValueInfo (GlobalValue::GUID GUID)
 Return a ValueInfo for GUID. More...
 
StringRef saveString (StringRef String)
 
ValueInfo getOrInsertValueInfo (GlobalValue::GUID GUID, StringRef Name)
 Return a ValueInfo for GUID setting value Name. More...
 
ValueInfo getOrInsertValueInfo (const GlobalValue *GV)
 Return a ValueInfo for GV and mark it as belonging to GV. More...
 
GlobalValue::GUID getGUIDFromOriginalID (GlobalValue::GUID OriginalID) const
 Return the GUID for OriginalId in the OidGuidMap. More...
 
std::set< std::string > & cfiFunctionDefs ()
 
const std::set< std::string > & cfiFunctionDefs () const
 
std::set< std::string > & cfiFunctionDecls ()
 
const std::set< std::string > & cfiFunctionDecls () const
 
void addGlobalValueSummary (const GlobalValue &GV, std::unique_ptr< GlobalValueSummary > Summary)
 Add a global value summary for a value. More...
 
void addGlobalValueSummary (StringRef ValueName, std::unique_ptr< GlobalValueSummary > Summary)
 Add a global value summary for a value of the given name. More...
 
void addGlobalValueSummary (ValueInfo VI, std::unique_ptr< GlobalValueSummary > Summary)
 Add a global value summary for the given ValueInfo. More...
 
void addOriginalName (GlobalValue::GUID ValueGUID, GlobalValue::GUID OrigGUID)
 Add an original name for the value of the given GUID. More...
 
GlobalValueSummaryfindSummaryInModule (ValueInfo VI, StringRef ModuleId) const
 Find the summary for ValueInfo VI in module ModuleId, or nullptr if not found. More...
 
GlobalValueSummaryfindSummaryInModule (GlobalValue::GUID ValueGUID, StringRef ModuleId) const
 Find the summary for global GUID in module ModuleId, or nullptr if not found. More...
 
GlobalValueSummarygetGlobalValueSummary (const GlobalValue &GV, bool PerModuleIndex=true) const
 Returns the first GlobalValueSummary for GV, asserting that there is only one if PerModuleIndex. More...
 
GlobalValueSummarygetGlobalValueSummary (GlobalValue::GUID ValueGUID, bool PerModuleIndex=true) const
 Returns the first GlobalValueSummary for ValueGUID, asserting that there is only one if PerModuleIndex. More...
 
const StringMap< std::pair< uint64_t, ModuleHash > > & modulePaths () const
 Table of modules, containing module hash and id. More...
 
StringMap< std::pair< uint64_t, ModuleHash > > & modulePaths ()
 Table of modules, containing hash and id. More...
 
uint64_t getModuleId (const StringRef ModPath) const
 Get the module ID recorded for the given module path. More...
 
const ModuleHashgetModuleHash (const StringRef ModPath) const
 Get the module SHA1 hash recorded for the given module path. More...
 
ModuleInfoaddModule (StringRef ModPath, uint64_t ModId, ModuleHash Hash=ModuleHash{{0}})
 Add a new module with the given Hash, mapped to the given ModID, and return a reference to the module. More...
 
ModuleInfogetModule (StringRef ModPath)
 Return module entry for module with the given ModPath. More...
 
bool hasExportedFunctions (const Module &M) const
 Check if the given Module has any functions available for exporting in the index. More...
 
const TypeIdSummaryMapTytypeIds () const
 
TypeIdSummarygetOrInsertTypeIdSummary (StringRef TypeId)
 Return an existing or new TypeIdSummary entry for TypeId. More...
 
const TypeIdSummarygetTypeIdSummary (StringRef TypeId) const
 This returns either a pointer to the type id summary (if present in the summary map) or null (if not present). More...
 
void collectDefinedFunctionsForModule (StringRef ModulePath, GVSummaryMapTy &GVSummaryMap) const
 Collect for the given module the list of functions it defines (GUID -> Summary). More...
 
template<class Map >
void collectDefinedGVSummariesPerModule (Map &ModuleToDefinedGVSummaries) const
 Collect for each module the list of Summaries it defines (GUID -> Summary). More...
 
void print (raw_ostream &OS, bool IsForDebug=false) const
 Print to an output stream. More...
 
void dump () const
 Dump to stderr (for debugging). More...
 
void exportToDot (raw_ostream &OS) const
 Export summary to dot file for GraphViz. More...
 
void dumpSCCs (raw_ostream &OS)
 Print out strongly connected components for debugging. More...
 
void propagateConstants (const DenseSet< GlobalValue::GUID > &PreservedSymbols)
 Analyze index and detect unmodified globals. More...
 

Static Public Member Functions

static void discoverNodes (ValueInfo V, std::map< ValueInfo, bool > &FunctionHasParent)
 Convenience function for doing a DFS on a ValueInfo. More...
 
static std::string getGlobalNameForLocal (StringRef Name, ModuleHash ModHash)
 Convenience method for creating a promoted global name for the given value name of a local, and its original module's ID. More...
 
static StringRef getOriginalNameBeforePromote (StringRef Name)
 Helper to obtain the unpromoted name for a global value (or the original name if not promoted). More...
 

Detailed Description

Class to hold module path string table and global value map, and encapsulate methods for operating on them.

Definition at line 808 of file ModuleSummaryIndex.h.

Member Typedef Documentation

◆ ModuleInfo

Definition at line 1136 of file ModuleSummaryIndex.h.

Constructor & Destructor Documentation

◆ ModuleSummaryIndex()

llvm::ModuleSummaryIndex::ModuleSummaryIndex ( bool  HaveGVs,
bool  EnableSplitLTOUnit = false 
)
inline

Definition at line 872 of file ModuleSummaryIndex.h.

Member Function Documentation

◆ addGlobalValueSummary() [1/3]

void llvm::ModuleSummaryIndex::addGlobalValueSummary ( const GlobalValue GV,
std::unique_ptr< GlobalValueSummary Summary 
)
inline

Add a global value summary for a value.

Definition at line 1026 of file ModuleSummaryIndex.h.

Referenced by llvm::buildModuleSummaryIndex(), computeAliasSummary(), computeFunctionSummary(), computeVariableSummary(), and setImmutableRefs().

◆ addGlobalValueSummary() [2/3]

void llvm::ModuleSummaryIndex::addGlobalValueSummary ( StringRef  ValueName,
std::unique_ptr< GlobalValueSummary Summary 
)
inline

Add a global value summary for a value of the given name.

Definition at line 1032 of file ModuleSummaryIndex.h.

References llvm::GlobalValue::getGUID().

◆ addGlobalValueSummary() [3/3]

void llvm::ModuleSummaryIndex::addGlobalValueSummary ( ValueInfo  VI,
std::unique_ptr< GlobalValueSummary Summary 
)
inline

Add a global value summary for the given ValueInfo.

Definition at line 1039 of file ModuleSummaryIndex.h.

References llvm::ValueInfo::getGUID(), llvm::ValueInfo::getRef(), and second.

◆ addModule()

ModuleInfo* llvm::ModuleSummaryIndex::addModule ( StringRef  ModPath,
uint64_t  ModId,
ModuleHash  Hash = ModuleHash{{0}} 
)
inline

Add a new module with the given Hash, mapped to the given ModID, and return a reference to the module.

Definition at line 1140 of file ModuleSummaryIndex.h.

References first, and llvm::StringMap< ValueTy, AllocatorTy >::insert().

Referenced by setImmutableRefs().

◆ addOriginalName()

void llvm::ModuleSummaryIndex::addOriginalName ( GlobalValue::GUID  ValueGUID,
GlobalValue::GUID  OrigGUID 
)
inline

Add an original name for the value of the given GUID.

Definition at line 1049 of file ModuleSummaryIndex.h.

Referenced by setImmutableRefs().

◆ begin() [1/2]

gvsummary_iterator llvm::ModuleSummaryIndex::begin ( )
inline

Definition at line 878 of file ModuleSummaryIndex.h.

◆ begin() [2/2]

const_gvsummary_iterator llvm::ModuleSummaryIndex::begin ( ) const
inline

Definition at line 879 of file ModuleSummaryIndex.h.

◆ calculateCallGraphRoot()

FunctionSummary llvm::ModuleSummaryIndex::calculateCallGraphRoot ( )
inline

◆ cfiFunctionDecls() [1/2]

std::set<std::string>& llvm::ModuleSummaryIndex::cfiFunctionDecls ( )
inline

Definition at line 1022 of file ModuleSummaryIndex.h.

Referenced by isDirectCall(), and setImmutableRefs().

◆ cfiFunctionDecls() [2/2]

const std::set<std::string>& llvm::ModuleSummaryIndex::cfiFunctionDecls ( ) const
inline

Definition at line 1023 of file ModuleSummaryIndex.h.

◆ cfiFunctionDefs() [1/2]

std::set<std::string>& llvm::ModuleSummaryIndex::cfiFunctionDefs ( )
inline

Definition at line 1019 of file ModuleSummaryIndex.h.

Referenced by isDirectCall(), and setImmutableRefs().

◆ cfiFunctionDefs() [2/2]

const std::set<std::string>& llvm::ModuleSummaryIndex::cfiFunctionDefs ( ) const
inline

Definition at line 1020 of file ModuleSummaryIndex.h.

◆ collectDefinedFunctionsForModule()

void ModuleSummaryIndex::collectDefinedFunctionsForModule ( StringRef  ModulePath,
GVSummaryMapTy GVSummaryMap 
) const

Collect for the given module the list of functions it defines (GUID -> Summary).

Definition at line 51 of file ModuleSummaryIndex.cpp.

Referenced by llvm::ComputeCrossModuleImportForModule().

◆ collectDefinedGVSummariesPerModule()

template<class Map >
void llvm::ModuleSummaryIndex::collectDefinedGVSummariesPerModule ( Map &  ModuleToDefinedGVSummaries) const
inline

◆ discoverNodes()

static void llvm::ModuleSummaryIndex::discoverNodes ( ValueInfo  V,
std::map< ValueInfo, bool > &  FunctionHasParent 
)
inlinestatic

Convenience function for doing a DFS on a ValueInfo.

Marks the function in the FunctionHasParent map.

Definition at line 886 of file ModuleSummaryIndex.h.

References assert(), C, llvm::FunctionSummary::calls(), llvm::dyn_cast(), F(), and llvm::ValueInfo::getSummaryList().

◆ dump()

LLVM_DUMP_METHOD void ModuleSummaryIndex::dump ( ) const

Dump to stderr (for debugging).

Definition at line 4374 of file AsmWriter.cpp.

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

◆ dumpSCCs()

LLVM_DUMP_METHOD void ModuleSummaryIndex::dumpSCCs ( raw_ostream OS)

Print out strongly connected components for debugging.

Definition at line 169 of file ModuleSummaryIndex.cpp.

References llvm::ARM_AM::add, llvm::AMDGPU::HSAMD::Kernel::Key::Attrs, F(), I, llvm::Twine::isTriviallyEmpty(), Name, llvm::MipsISD::Ret, llvm::Twine::str(), and llvm::utostr().

◆ enableSplitLTOUnit()

bool llvm::ModuleSummaryIndex::enableSplitLTOUnit ( ) const
inline

Definition at line 964 of file ModuleSummaryIndex.h.

◆ end() [1/2]

gvsummary_iterator llvm::ModuleSummaryIndex::end ( )
inline

Definition at line 880 of file ModuleSummaryIndex.h.

◆ end() [2/2]

const_gvsummary_iterator llvm::ModuleSummaryIndex::end ( ) const
inline

Definition at line 881 of file ModuleSummaryIndex.h.

◆ exportToDot()

void ModuleSummaryIndex::exportToDot ( raw_ostream OS) const

Export summary to dot file for GraphViz.

Definition at line 330 of file ModuleSummaryIndex.cpp.

References assert(), defineExternalNode(), E, llvm::sys::path::filename(), getNodeLabel(), hasReadOnlyFlag(), llvm::to_string(), and VI.

◆ findSummaryInModule() [1/2]

GlobalValueSummary* llvm::ModuleSummaryIndex::findSummaryInModule ( ValueInfo  VI,
StringRef  ModuleId 
) const
inline

Find the summary for ValueInfo VI in module ModuleId, or nullptr if not found.

Definition at line 1061 of file ModuleSummaryIndex.h.

References llvm::find_if(), and llvm::ValueInfo::getSummaryList().

Referenced by llvm::computeLTOCacheKey(), llvm::FunctionImportGlobalProcessing::doImportAsDefinition(), and setImmutableRefs().

◆ findSummaryInModule() [2/2]

GlobalValueSummary* llvm::ModuleSummaryIndex::findSummaryInModule ( GlobalValue::GUID  ValueGUID,
StringRef  ModuleId 
) const
inline

Find the summary for global GUID in module ModuleId, or nullptr if not found.

Definition at line 1075 of file ModuleSummaryIndex.h.

◆ getGlobalNameForLocal()

static std::string llvm::ModuleSummaryIndex::getGlobalNameForLocal ( StringRef  Name,
ModuleHash  ModHash 
)
inlinestatic

Convenience method for creating a promoted global name for the given value name of a local, and its original module's ID.

Definition at line 1121 of file ModuleSummaryIndex.h.

References llvm::SmallString< InternalLen >::str(), and llvm::utostr().

Referenced by llvm::FunctionImportGlobalProcessing::doImportAsDefinition().

◆ getGlobalValueSummary() [1/2]

GlobalValueSummary* llvm::ModuleSummaryIndex::getGlobalValueSummary ( const GlobalValue GV,
bool  PerModuleIndex = true 
) const
inline

Returns the first GlobalValueSummary for GV, asserting that there is only one if PerModuleIndex.

Definition at line 1085 of file ModuleSummaryIndex.h.

References assert(), llvm::GlobalValue::getGUID(), and llvm::Value::hasName().

Referenced by llvm::buildModuleSummaryIndex().

◆ getGlobalValueSummary() [2/2]

GlobalValueSummary * ModuleSummaryIndex::getGlobalValueSummary ( GlobalValue::GUID  ValueGUID,
bool  PerModuleIndex = true 
) const

Returns the first GlobalValueSummary for ValueGUID, asserting that there is only one if PerModuleIndex.

Definition at line 69 of file ModuleSummaryIndex.cpp.

References assert(), and VI.

◆ getGUIDFromOriginalID()

GlobalValue::GUID llvm::ModuleSummaryIndex::getGUIDFromOriginalID ( GlobalValue::GUID  OriginalID) const
inline

Return the GUID for OriginalId in the OidGuidMap.

Definition at line 1014 of file ModuleSummaryIndex.h.

References I.

Referenced by updateValueInfoForIndirectCalls().

◆ getModule()

ModuleInfo* llvm::ModuleSummaryIndex::getModule ( StringRef  ModPath)
inline

Return module entry for module with the given ModPath.

Definition at line 1146 of file ModuleSummaryIndex.h.

References assert(), llvm::StringMap< ValueTy, AllocatorTy >::end(), and llvm::StringMap< ValueTy, AllocatorTy >::find().

◆ getModuleHash()

const ModuleHash& llvm::ModuleSummaryIndex::getModuleHash ( const StringRef  ModPath) const
inline

◆ getModuleId()

uint64_t llvm::ModuleSummaryIndex::getModuleId ( const StringRef  ModPath) const
inline

Get the module ID recorded for the given module path.

Definition at line 1108 of file ModuleSummaryIndex.h.

References llvm::StringMap< ValueTy, AllocatorTy >::lookup().

◆ getOriginalNameBeforePromote()

static StringRef llvm::ModuleSummaryIndex::getOriginalNameBeforePromote ( StringRef  Name)
inlinestatic

Helper to obtain the unpromoted name for a global value (or the original name if not promoted).

Definition at line 1131 of file ModuleSummaryIndex.h.

References llvm::StringRef::split().

Referenced by llvm::thinLTOInternalizeModule().

◆ getOrInsertTypeIdSummary()

TypeIdSummary& llvm::ModuleSummaryIndex::getOrInsertTypeIdSummary ( StringRef  TypeId)
inline

Return an existing or new TypeIdSummary entry for TypeId.

This accessor can mutate the map and therefore should not be used in the ThinLTO backends.

Definition at line 1164 of file ModuleSummaryIndex.h.

References llvm::GlobalValue::getGUID().

Referenced by parseTypeIdSummaryRecord().

◆ getOrInsertValueInfo() [1/3]

ValueInfo llvm::ModuleSummaryIndex::getOrInsertValueInfo ( GlobalValue::GUID  GUID)
inline

Return a ValueInfo for GUID.

Definition at line 988 of file ModuleSummaryIndex.h.

Referenced by computeFunctionSummary(), findRefEdges(), and setImmutableRefs().

◆ getOrInsertValueInfo() [2/3]

ValueInfo llvm::ModuleSummaryIndex::getOrInsertValueInfo ( GlobalValue::GUID  GUID,
StringRef  Name 
)
inline

Return a ValueInfo for GUID setting value Name.

Definition at line 998 of file ModuleSummaryIndex.h.

References assert(), and Name.

◆ getOrInsertValueInfo() [3/3]

ValueInfo llvm::ModuleSummaryIndex::getOrInsertValueInfo ( const GlobalValue GV)
inline

Return a ValueInfo for GV and mark it as belonging to GV.

Definition at line 1006 of file ModuleSummaryIndex.h.

References assert(), and llvm::GlobalValue::getGUID().

◆ getTypeIdSummary()

const TypeIdSummary* llvm::ModuleSummaryIndex::getTypeIdSummary ( StringRef  TypeId) const
inline

This returns either a pointer to the type id summary (if present in the summary map) or null (if not present).

This may be used when importing.

Definition at line 1176 of file ModuleSummaryIndex.h.

References llvm::GlobalValue::getGUID().

◆ getValueInfo() [1/2]

ValueInfo llvm::ModuleSummaryIndex::getValueInfo ( const GlobalValueSummaryMapTy::value_type &  R) const
inline

◆ getValueInfo() [2/2]

ValueInfo llvm::ModuleSummaryIndex::getValueInfo ( GlobalValue::GUID  GUID) const
inline

Return a ValueInfo for GUID if it exists, otherwise return ValueInfo().

Definition at line 982 of file ModuleSummaryIndex.h.

References I.

◆ hasExportedFunctions()

bool llvm::ModuleSummaryIndex::hasExportedFunctions ( const Module M) const
inline

Check if the given Module has any functions available for exporting in the index.

We consider any module present in the ModulePathStringTable to have exported functions.

Definition at line 1155 of file ModuleSummaryIndex.h.

References llvm::StringMap< ValueTy, AllocatorTy >::count(), and llvm::Module::getModuleIdentifier().

Referenced by llvm::FunctionImportGlobalProcessing::FunctionImportGlobalProcessing().

◆ hasSyntheticEntryCounts()

bool llvm::ModuleSummaryIndex::hasSyntheticEntryCounts ( ) const
inline

◆ haveGVs()

bool llvm::ModuleSummaryIndex::haveGVs ( ) const
inline

◆ isGlobalValueLive()

bool llvm::ModuleSummaryIndex::isGlobalValueLive ( const GlobalValueSummary GVS) const
inline

◆ isGUIDLive()

bool ModuleSummaryIndex::isGUIDLive ( GlobalValue::GUID  GUID) const

Definition at line 79 of file ModuleSummaryIndex.cpp.

References I, and VI.

◆ modulePaths() [1/2]

const StringMap<std::pair<uint64_t, ModuleHash> >& llvm::ModuleSummaryIndex::modulePaths ( ) const
inline

◆ modulePaths() [2/2]

StringMap<std::pair<uint64_t, ModuleHash> >& llvm::ModuleSummaryIndex::modulePaths ( )
inline

Table of modules, containing hash and id.

Definition at line 1103 of file ModuleSummaryIndex.h.

◆ partiallySplitLTOUnits()

bool llvm::ModuleSummaryIndex::partiallySplitLTOUnits ( ) const
inline

Definition at line 967 of file ModuleSummaryIndex.h.

Referenced by isDirectCall().

◆ print()

void ModuleSummaryIndex::print ( raw_ostream OS,
bool  IsForDebug = false 
) const

Print to an output stream.

Definition at line 4332 of file AsmWriter.cpp.

References LLVM_DUMP_METHOD, and llvm::RISCVFenceField::W.

◆ propagateConstants()

void ModuleSummaryIndex::propagateConstants ( const DenseSet< GlobalValue::GUID > &  PreservedSymbols)

◆ saveString()

StringRef llvm::ModuleSummaryIndex::saveString ( StringRef  String)
inline

Definition at line 995 of file ModuleSummaryIndex.h.

References llvm::StringSaver::save().

◆ setEnableSplitLTOUnit()

void llvm::ModuleSummaryIndex::setEnableSplitLTOUnit ( )
inline

Definition at line 965 of file ModuleSummaryIndex.h.

Referenced by setImmutableRefs().

◆ setHasSyntheticEntryCounts()

void llvm::ModuleSummaryIndex::setHasSyntheticEntryCounts ( )
inline

Definition at line 955 of file ModuleSummaryIndex.h.

Referenced by llvm::computeSyntheticCounts(), and setImmutableRefs().

◆ setPartiallySplitLTOUnits()

void llvm::ModuleSummaryIndex::setPartiallySplitLTOUnits ( )
inline

Definition at line 968 of file ModuleSummaryIndex.h.

Referenced by setImmutableRefs().

◆ setSkipModuleByDistributedBackend()

void llvm::ModuleSummaryIndex::setSkipModuleByDistributedBackend ( )
inline

Definition at line 960 of file ModuleSummaryIndex.h.

Referenced by setImmutableRefs().

◆ setWithGlobalValueDeadStripping()

void llvm::ModuleSummaryIndex::setWithGlobalValueDeadStripping ( )
inline

Definition at line 950 of file ModuleSummaryIndex.h.

Referenced by setImmutableRefs().

◆ size()

size_t llvm::ModuleSummaryIndex::size ( ) const
inline

Definition at line 882 of file ModuleSummaryIndex.h.

◆ skipModuleByDistributedBackend()

bool llvm::ModuleSummaryIndex::skipModuleByDistributedBackend ( ) const
inline

Definition at line 957 of file ModuleSummaryIndex.h.

◆ typeIds()

const TypeIdSummaryMapTy& llvm::ModuleSummaryIndex::typeIds ( ) const
inline

Definition at line 1159 of file ModuleSummaryIndex.h.

Referenced by llvm::computeLTOCacheKey().

◆ withGlobalValueDeadStripping()

bool llvm::ModuleSummaryIndex::withGlobalValueDeadStripping ( ) const
inline

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