LLVM  6.0.0svn
Classes | Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
llvm::GlobalValueSummary Class Reference

Function and variable summary information to aid decisions and implementation of importing. More...

#include "llvm/IR/ModuleSummaryIndex.h"

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

Classes

struct  GVFlags
 Group flags (Linkage, NotEligibleToImport, etc.) as a bitfield. More...
 

Public Types

enum  SummaryKind : unsigned { AliasKind, FunctionKind, GlobalVarKind }
 Sububclass discriminator (for dyn_cast<> et al.) More...
 

Public Member Functions

virtual ~GlobalValueSummary ()=default
 
GlobalValue::GUID getOriginalName ()
 Returns the hash of the original name, it is identical to the GUID for externally visible symbols, but not for local ones. More...
 
void setOriginalName (GlobalValue::GUID Name)
 Initialize the original name hash in this summary. More...
 
SummaryKind getSummaryKind () const
 Which kind of summary subclass this is. More...
 
void setModulePath (StringRef ModPath)
 Set the path to the module containing this function, for use in the combined index. More...
 
StringRef modulePath () const
 Get the path to the module containing this function. More...
 
GVFlags flags ()
 Get the flags for this GlobalValue (see struct GVFlags). More...
 
GlobalValue::LinkageTypes linkage () const
 Return linkage type recorded for this global value. More...
 
void setLinkage (GlobalValue::LinkageTypes Linkage)
 Sets the linkage to the value determined by global summary-based optimization. More...
 
bool notEligibleToImport () const
 Return true if this global value can't be imported. More...
 
void setLive (bool Live)
 
void setNotEligibleToImport ()
 Flag that this global value cannot be imported. More...
 
ArrayRef< ValueInforefs () const
 Return the list of values referenced by this global value definition. More...
 
GlobalValueSummarygetBaseObject ()
 If this is an alias summary, returns the summary of the aliased object (a global variable or function), otherwise returns itself. More...
 

Protected Member Functions

 GlobalValueSummary (SummaryKind K, GVFlags Flags, std::vector< ValueInfo > Refs)
 

Friends

class ModuleSummaryIndex
 
void computeDeadSymbols (class ModuleSummaryIndex &, const DenseSet< GlobalValue::GUID > &)
 Compute all the symbols that are "dead": i.e these that can't be reached in the graph from any of the given symbols listed in GUIDPreservedSymbols. More...
 

Detailed Description

Function and variable summary information to aid decisions and implementation of importing.

Definition at line 124 of file ModuleSummaryIndex.h.

Member Enumeration Documentation

◆ SummaryKind

Sububclass discriminator (for dyn_cast<> et al.)

Enumerator
AliasKind 
FunctionKind 
GlobalVarKind 

Definition at line 127 of file ModuleSummaryIndex.h.

Constructor & Destructor Documentation

◆ GlobalValueSummary()

llvm::GlobalValueSummary::GlobalValueSummary ( SummaryKind  K,
GVFlags  Flags,
std::vector< ValueInfo Refs 
)
inlineprotected

Definition at line 187 of file ModuleSummaryIndex.h.

References assert().

◆ ~GlobalValueSummary()

virtual llvm::GlobalValueSummary::~GlobalValueSummary ( )
virtualdefault

Member Function Documentation

◆ flags()

GVFlags llvm::GlobalValueSummary::flags ( )
inline

Get the flags for this GlobalValue (see struct GVFlags).

Definition at line 214 of file ModuleSummaryIndex.h.

Referenced by writeFunctionTypeMetadataRecords().

◆ getBaseObject()

GlobalValueSummary * llvm::GlobalValueSummary::getBaseObject ( )
inline

If this is an alias summary, returns the summary of the aliased object (a global variable or function), otherwise returns itself.

Definition at line 273 of file ModuleSummaryIndex.h.

References AS.

◆ getOriginalName()

GlobalValue::GUID llvm::GlobalValueSummary::getOriginalName ( )
inline

Returns the hash of the original name, it is identical to the GUID for externally visible symbols, but not for local ones.

Definition at line 198 of file ModuleSummaryIndex.h.

◆ getSummaryKind()

SummaryKind llvm::GlobalValueSummary::getSummaryKind ( ) const
inline

Which kind of summary subclass this is.

Definition at line 204 of file ModuleSummaryIndex.h.

References Kind.

Referenced by llvm::AliasSummary::classof(), llvm::FunctionSummary::classof(), and llvm::GlobalVarSummary::classof().

◆ linkage()

GlobalValue::LinkageTypes llvm::GlobalValueSummary::linkage ( ) const
inline

Return linkage type recorded for this global value.

Definition at line 217 of file ModuleSummaryIndex.h.

References llvm::GlobalValueSummary::GVFlags::Linkage.

◆ modulePath()

StringRef llvm::GlobalValueSummary::modulePath ( ) const
inline

Get the path to the module containing this function.

Definition at line 211 of file ModuleSummaryIndex.h.

Referenced by computeImportForFunction().

◆ notEligibleToImport()

bool llvm::GlobalValueSummary::notEligibleToImport ( ) const
inline

Return true if this global value can't be imported.

Definition at line 228 of file ModuleSummaryIndex.h.

References llvm::GlobalValueSummary::GVFlags::NotEligibleToImport.

◆ refs()

ArrayRef<ValueInfo> llvm::GlobalValueSummary::refs ( ) const
inline

Return the list of values referenced by this global value definition.

Definition at line 236 of file ModuleSummaryIndex.h.

Referenced by llvm::computeDeadSymbols(), and writeFunctionTypeMetadataRecords().

◆ setLinkage()

void llvm::GlobalValueSummary::setLinkage ( GlobalValue::LinkageTypes  Linkage)
inline

Sets the linkage to the value determined by global summary-based optimization.

Will be applied in the ThinLTO backends.

Definition at line 223 of file ModuleSummaryIndex.h.

References llvm::GlobalValueSummary::GVFlags::Linkage.

◆ setLive()

void llvm::GlobalValueSummary::setLive ( bool  Live)
inline

Definition at line 230 of file ModuleSummaryIndex.h.

References llvm::GlobalValueSummary::GVFlags::Live.

◆ setModulePath()

void llvm::GlobalValueSummary::setModulePath ( StringRef  ModPath)
inline

Set the path to the module containing this function, for use in the combined index.

Definition at line 208 of file ModuleSummaryIndex.h.

Referenced by readWideAPInt().

◆ setNotEligibleToImport()

void llvm::GlobalValueSummary::setNotEligibleToImport ( )
inline

Flag that this global value cannot be imported.

Definition at line 233 of file ModuleSummaryIndex.h.

References llvm::GlobalValueSummary::GVFlags::NotEligibleToImport.

◆ setOriginalName()

void llvm::GlobalValueSummary::setOriginalName ( GlobalValue::GUID  Name)
inline

Initialize the original name hash in this summary.

Definition at line 201 of file ModuleSummaryIndex.h.

Referenced by readWideAPInt().

Friends And Related Function Documentation

◆ computeDeadSymbols

void computeDeadSymbols ( class ModuleSummaryIndex ,
const DenseSet< GlobalValue::GUID > &   
)
friend

Compute all the symbols that are "dead": i.e these that can't be reached in the graph from any of the given symbols listed in GUIDPreservedSymbols.

◆ ModuleSummaryIndex

friend class ModuleSummaryIndex
friend

Definition at line 242 of file ModuleSummaryIndex.h.


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