LLVM 23.0.0git
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:
[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...
enum  ImportKind : unsigned { Definition = 0 , Declaration = 1 }

Public Member Functions

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

Protected Member Functions

 GlobalValueSummary (SummaryKind K, GVFlags Flags, SmallVectorImpl< ValueInfo > &&Refs)

Friends

class ModuleSummaryIndex

Detailed Description

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

Definition at line 451 of file ModuleSummaryIndex.h.

Member Enumeration Documentation

◆ ImportKind

enum llvm::GlobalValueSummary::ImportKind : unsigned
Enumerator
Definition 
Declaration 

Definition at line 456 of file ModuleSummaryIndex.h.

◆ SummaryKind

enum llvm::GlobalValueSummary::SummaryKind : unsigned

Sububclass discriminator (for dyn_cast<> et al.)

Enumerator
AliasKind 
FunctionKind 
GlobalVarKind 

Definition at line 454 of file ModuleSummaryIndex.h.

Constructor & Destructor Documentation

◆ GlobalValueSummary()

llvm::GlobalValueSummary::GlobalValueSummary ( SummaryKind K,
GVFlags Flags,
SmallVectorImpl< ValueInfo > && Refs )
inlineprotected

Definition at line 552 of file ModuleSummaryIndex.h.

References AliasKind, assert(), and llvm::move().

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

◆ ~GlobalValueSummary()

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

Member Function Documentation

◆ canAutoHide()

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

Definition at line 606 of file ModuleSummaryIndex.h.

◆ flags()

GVFlags llvm::GlobalValueSummary::flags ( ) const
inline

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

Definition at line 580 of file ModuleSummaryIndex.h.

◆ getBaseObject() [1/2]

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 713 of file ModuleSummaryIndex.h.

References llvm::dyn_cast(), and GlobalValueSummary().

Referenced by llvm::ModuleSummaryIndex::canImportGlobalVar().

◆ getBaseObject() [2/2]

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

Definition at line 707 of file ModuleSummaryIndex.h.

References llvm::dyn_cast(), and GlobalValueSummary().

◆ getOriginalName()

GlobalValue::GUID llvm::GlobalValueSummary::getOriginalName ( ) const
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 564 of file ModuleSummaryIndex.h.

◆ getSummaryKind()

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

Which kind of summary subclass this is.

Definition at line 570 of file ModuleSummaryIndex.h.

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

◆ getVisibility()

GlobalValue::VisibilityTypes llvm::GlobalValueSummary::getVisibility ( ) const
inline

Definition at line 618 of file ModuleSummaryIndex.h.

◆ importType()

GlobalValueSummary::ImportKind llvm::GlobalValueSummary::importType ( ) const
inline

Definition at line 614 of file ModuleSummaryIndex.h.

◆ isDSOLocal()

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

Definition at line 602 of file ModuleSummaryIndex.h.

◆ isLive()

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

Definition at line 596 of file ModuleSummaryIndex.h.

Referenced by llvm::ModuleSummaryIndex::isGlobalValueLive().

◆ linkage()

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

Return linkage type recorded for this global value.

Definition at line 583 of file ModuleSummaryIndex.h.

Referenced by llvm::ModuleSummaryIndex::canImportGlobalVar(), llvm::JITSymbolFlags::fromSummary(), getNodeLabel(), and shouldSkipLocalInAnotherModule().

◆ modulePath()

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

Get the path to the module containing this function.

Definition at line 577 of file ModuleSummaryIndex.h.

Referenced by shouldSkipLocalInAnotherModule().

◆ notEligibleToImport()

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

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

Definition at line 594 of file ModuleSummaryIndex.h.

Referenced by llvm::ModuleSummaryIndex::canImportGlobalVar().

◆ refs()

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

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

Definition at line 629 of file ModuleSummaryIndex.h.

Referenced by propagateAttributesToRefs(), and llvm::FunctionSummary::specialRefCounts().

◆ setCanAutoHide()

void llvm::GlobalValueSummary::setCanAutoHide ( bool CanAutoHide)
inline

Definition at line 604 of file ModuleSummaryIndex.h.

◆ setDSOLocal()

void llvm::GlobalValueSummary::setDSOLocal ( bool Local)
inline

Definition at line 600 of file ModuleSummaryIndex.h.

References Local.

◆ setImportKind()

void llvm::GlobalValueSummary::setImportKind ( ImportKind IK)
inline

Definition at line 612 of file ModuleSummaryIndex.h.

◆ 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 589 of file ModuleSummaryIndex.h.

References Linkage.

◆ setLive()

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

Definition at line 598 of file ModuleSummaryIndex.h.

◆ 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 574 of file ModuleSummaryIndex.h.

◆ setNotEligibleToImport()

void llvm::GlobalValueSummary::setNotEligibleToImport ( )
inline

Flag that this global value cannot be imported.

Definition at line 626 of file ModuleSummaryIndex.h.

◆ setOriginalName()

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

Initialize the original name hash in this summary.

Definition at line 567 of file ModuleSummaryIndex.h.

◆ setVisibility()

void llvm::GlobalValueSummary::setVisibility ( GlobalValue::VisibilityTypes Vis)
inline

Definition at line 621 of file ModuleSummaryIndex.h.

◆ shouldImportAsDecl()

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

Definition at line 608 of file ModuleSummaryIndex.h.

References Declaration.

◆ ModuleSummaryIndex

friend class ModuleSummaryIndex
friend

Definition at line 636 of file ModuleSummaryIndex.h.

References ModuleSummaryIndex.

Referenced by ModuleSummaryIndex.

The documentation for this class was generated from the following file:
Generated on for LLVM by doxygen 1.14.0