LLVM 19.0.0git
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
llvm::GlobalVarSummary Class Reference

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

#include "llvm/IR/ModuleSummaryIndex.h"

Inheritance diagram for llvm::GlobalVarSummary:
Inheritance graph


struct  GVarFlags

Public Member Functions

 GlobalVarSummary (GVFlags Flags, GVarFlags VarFlags, std::vector< ValueInfo > Refs)
GVarFlags varflags () const
void setReadOnly (bool RO)
void setWriteOnly (bool WO)
bool maybeReadOnly () const
bool maybeWriteOnly () const
bool isConstant () const
void setVCallVisibility (GlobalObject::VCallVisibility Vis)
GlobalObject::VCallVisibility getVCallVisibility () const
void setVTableFuncs (VTableFuncList Funcs)
ArrayRef< VirtFuncOffsetvTableFuncs () const
- Public Member Functions inherited from llvm::GlobalValueSummary
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)
GlobalValue::VisibilityTypes getVisibility () const
void setVisibility (GlobalValue::VisibilityTypes Vis)
void setNotEligibleToImport ()
 Flag that this global value cannot be imported.
ArrayRef< ValueInforefs () const
 Return the list of values referenced by this global value definition.
GlobalValueSummarygetBaseObject ()
 If this is an alias summary, returns the summary of the aliased object (a global variable or function), otherwise returns itself.
const GlobalValueSummarygetBaseObject () const

Static Public Member Functions

static bool classof (const GlobalValueSummary *GVS)
 Check if this is a global variable summary.

Public Attributes

struct llvm::GlobalVarSummary::GVarFlags VarFlags

Additional Inherited Members

- Public Types inherited from llvm::GlobalValueSummary
enum  SummaryKind : unsigned { AliasKind , FunctionKind , GlobalVarKind }
 Sububclass discriminator (for dyn_cast<> et al.) More...
enum  ImportKind : unsigned { Definition = 0 , Declaration = 1 }
- Protected Member Functions inherited from llvm::GlobalValueSummary
 GlobalValueSummary (SummaryKind K, GVFlags Flags, std::vector< ValueInfo > Refs)

Detailed Description

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

Global variable summary has two extra flag, telling if it is readonly or writeonly. Both readonly and writeonly variables can be optimized in the backed: readonly variables can be const-folded, while writeonly vars can be completely eliminated together with corresponding stores. We let both things happen by means of internalizing such variables after ThinLTO import.

Definition at line 1112 of file ModuleSummaryIndex.h.

Constructor & Destructor Documentation

◆ GlobalVarSummary()

llvm::GlobalVarSummary::GlobalVarSummary ( GVFlags  Flags,
GVarFlags  VarFlags,
std::vector< ValueInfo Refs 

Definition at line 1149 of file ModuleSummaryIndex.h.

Member Function Documentation

◆ classof()

static bool llvm::GlobalVarSummary::classof ( const GlobalValueSummary GVS)

Check if this is a global variable summary.

Definition at line 1155 of file ModuleSummaryIndex.h.

References llvm::GlobalValueSummary::getSummaryKind(), and llvm::GlobalValueSummary::GlobalVarKind.

◆ getVCallVisibility()

GlobalObject::VCallVisibility llvm::GlobalVarSummary::getVCallVisibility ( ) const

◆ isConstant()

bool llvm::GlobalVarSummary::isConstant ( ) const

Definition at line 1164 of file ModuleSummaryIndex.h.

References llvm::GlobalVarSummary::GVarFlags::Constant, and VarFlags.

◆ maybeReadOnly()

bool llvm::GlobalVarSummary::maybeReadOnly ( ) const

◆ maybeWriteOnly()

bool llvm::GlobalVarSummary::maybeWriteOnly ( ) const

◆ setReadOnly()

void llvm::GlobalVarSummary::setReadOnly ( bool  RO)

◆ setVCallVisibility()

void llvm::GlobalVarSummary::setVCallVisibility ( GlobalObject::VCallVisibility  Vis)

◆ setVTableFuncs()

void llvm::GlobalVarSummary::setVTableFuncs ( VTableFuncList  Funcs)

Definition at line 1172 of file ModuleSummaryIndex.h.

References assert().

◆ setWriteOnly()

void llvm::GlobalVarSummary::setWriteOnly ( bool  WO)

◆ varflags()

GVarFlags llvm::GlobalVarSummary::varflags ( ) const

Definition at line 1159 of file ModuleSummaryIndex.h.

References VarFlags.

◆ vTableFuncs()

ArrayRef< VirtFuncOffset > llvm::GlobalVarSummary::vTableFuncs ( ) const

Definition at line 1177 of file ModuleSummaryIndex.h.

Member Data Documentation

◆ VarFlags

struct llvm::GlobalVarSummary::GVarFlags llvm::GlobalVarSummary::VarFlags

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