22#define DEBUG_TYPE "module-summary-index"
25 "Number of live global variables marked read only");
27 "Number of live global variables marked write only");
33 cl::desc(
"Always rename promoted locals."));
38 cl::desc(
"Propagate attributes in index"));
42 cl::desc(
"Import constant global variables with references"));
49 bool HasProtected =
false;
63 return WithDSOLocalPropagation
68 [](
const std::unique_ptr<GlobalValueSummary> &Summary) {
69 return Summary->isDSOLocal();
77 [](
const std::unique_ptr<GlobalValueSummary> &Summary) {
78 return Summary->canAutoHide();
87 unsigned RORefCnt = 0, WORefCnt = 0;
89 for (
I = Refs.size() - 1;
I >= 0 && Refs[
I].isWriteOnly(); --
I)
91 for (;
I >= 0 && Refs[
I].isReadOnly(); --
I)
93 return {RORefCnt, WORefCnt};
125 assert(Flags <= 0xfff &&
"Unexpected bits in flag");
178 for (
auto &GlobalList : *
this) {
179 auto GUID = GlobalList.first;
180 for (
auto &GlobSummary : GlobalList.second.getSummaryList()) {
186 if (Summary->modulePath() != ModulePath)
188 GVSummaryMap[GUID] = Summary;
195 bool PerModuleIndex)
const {
197 assert(VI &&
"GlobalValue not found in index");
198 assert((!PerModuleIndex || VI.getSummaryList().size() == 1) &&
199 "Expected a single entry per global value in per-module index");
200 auto &Summary = VI.getSummaryList()[0];
201 return Summary.get();
208 const auto &SummaryList = VI.getSummaryList();
209 if (SummaryList.empty())
211 for (
auto &
I : SummaryList)
228 for (
auto &VI : S->
refs()) {
230 if (!VI.getAccessSpecifier()) {
231 if (!MarkedNonReadWriteOnly.
insert(VI).second)
233 }
else if (MarkedNonReadWriteOnly.
contains(VI))
235 bool HasNonGVar =
false;
236 for (
auto &
Ref : VI.getSummaryList()) {
240 if (!VI.isReadOnly())
241 GVS->setReadOnly(
false);
242 if (!VI.isWriteOnly())
243 GVS->setWriteOnly(
false);
258 for (
auto &
Ref : VI.getSummaryList()) {
262 GVS->setReadOnly(
false);
263 GVS->setWriteOnly(
false);
265 MarkedNonReadWriteOnly.
insert(VI);
304 for (
auto &
P : *
this) {
305 bool IsDSOLocal =
true;
306 for (
auto &S :
P.second.getSummaryList()) {
316 P.second.getSummaryList(),
317 [&](
const std::unique_ptr<GlobalValueSummary> &Summary) {
318 return isGlobalValueLive(Summary.get());
338 GUIDPreservedSymbols.
count(
P.first)) {
339 GVS->setReadOnly(
false);
340 GVS->setWriteOnly(
false);
345 IsDSOLocal &= S->isDSOLocal();
350 for (
const std::unique_ptr<GlobalValueSummary> &Summary :
351 P.second.getSummaryList())
352 Summary->setDSOLocal(
false);
357 for (
auto &
P : *
this)
358 if (
P.second.getSummaryList().size())
360 P.second.getSummaryList()[0]->getBaseObject()))
362 if (GVS->maybeReadOnly())
364 if (GVS->maybeWriteOnly())
365 WriteOnlyLiveGVars++;
370 bool AnalyzeRefs)
const {
377 bool &CanImportDecl)
const {
398 const bool nonInterposable =
404 CanImportDecl = (nonInterposable && eligibleToImport);
411 return nonInterposable && eligibleToImport &&
412 (!AnalyzeRefs || !HasRefsPreventingImport(GVS));
422 O <<
"SCC (" <<
utostr(
I->size()) <<
" node" << (
I->size() == 1 ?
"" :
"s")
426 if (V.getSummaryList().size())
428 O <<
" " << (
F ==
nullptr ?
"External" :
"") <<
" " <<
utostr(V.getGUID())
429 << (
I.hasCycle() ?
" (has cycle)" :
"") <<
"\n";
439 void addComment(
const Twine &Comment);
440 std::string getAsString()
const;
442 std::vector<std::string> Attrs;
443 std::string Comments;
455 const Twine &Comment) {
456 std::string
A =
Name.str();
464void Attributes::addComment(
const Twine &Comment) {
465 if (!
Comment.isTriviallyEmpty()) {
466 if (Comments.empty())
474std::string Attributes::getAsString()
const {
478 std::string Ret =
"[";
479 for (
auto &
A : Attrs)
496 return "linkonce_odr";
508 return "extern_weak";
517 auto FlagValue = [](
unsigned V) {
return V ?
'1' :
'0'; };
518 char FlagRep[] = {FlagValue(
F.ReadNone),
519 FlagValue(
F.ReadOnly),
520 FlagValue(
F.NoRecurse),
521 FlagValue(
F.ReturnDoesNotAlias),
522 FlagValue(
F.NoInline),
523 FlagValue(
F.AlwaysInline),
524 FlagValue(
F.NoUnwind),
525 FlagValue(
F.MayThrow),
526 FlagValue(
F.HasUnknownCall),
527 FlagValue(
F.MustBeUnreachable),
539 return std::string(
"inst: ") + std::to_string(FS->instCount()) +
544 return std::string(
"@") + std::to_string(Id);
559 Label += std::string(
" (") + Attrs +
")";
570 auto StrId = std::to_string(Id);
571 OS <<
" " << StrId <<
" [label=\"";
578 OS <<
"\"]; // defined externally\n";
583 return GVS->maybeReadOnly();
589 return GVS->maybeWriteOnly();
595 return GVS->isConstant();
602 std::vector<Edge> CrossModuleEdges;
604 using GVSOrderedMapTy = std::map<GlobalValue::GUID, GlobalValueSummary *>;
605 std::map<StringRef, GVSOrderedMapTy> ModuleToDefinedGVS;
611 std::vector<StringRef> ModulePaths;
613 ModulePaths.push_back(ModPath);
616 for (
auto &ModPath : ModulePaths)
622 return ModId == (uint64_t)-1 ? std::to_string(Id)
623 : std::string(
"M") + std::to_string(ModId) +
624 "_" + std::to_string(Id);
636 static const char *EdgeAttrs[] = {
637 " [style=dotted]; // alias",
638 " [style=dashed]; // ref",
639 " [style=dashed,color=forestgreen]; // const-ref",
640 " [style=dashed,color=violetred]; // writeOnly-ref",
641 " // call (hotness : Unknown)",
642 " [color=blue]; // call (hotness : Cold)",
643 " // call (hotness : None)",
644 " [color=brown]; // call (hotness : Hot)",
645 " [style=bold,color=red]; // call (hotness : Critical)"};
647 assert(
static_cast<size_t>(TypeOrHotness) < std::size(EdgeAttrs));
648 OS << Pfx << NodeId(SrcMod, SrcId) <<
" -> " << NodeId(DstMod, DstId)
649 << EdgeAttrs[TypeOrHotness] <<
"\n";
652 OS <<
"digraph Summary {\n";
653 for (
auto &ModIt : ModuleToDefinedGVS) {
657 auto ModId = ModuleIdMap.
empty() ? 0 : ModuleIdMap[ModIt.first];
658 OS <<
" // Module: " << ModIt.first <<
"\n";
659 OS <<
" subgraph cluster_" << std::to_string(ModId) <<
" {\n";
660 OS <<
" style = filled;\n";
661 OS <<
" color = lightgrey;\n";
663 OS <<
" node [style=filled,fillcolor=lightblue];\n";
665 auto &GVSMap = ModIt.second;
667 if (!GVSMap.count(IdTo)) {
668 CrossModuleEdges.push_back({ModId, Hotness, IdFrom, IdTo});
671 DrawEdge(
" ", ModId, IdFrom, ModId, IdTo, Hotness);
674 for (
auto &SummaryIt : GVSMap) {
675 NodeMap[SummaryIt.first].push_back(ModId);
676 auto Flags = SummaryIt.second->flags();
679 A.add(
"shape",
"record",
"function");
681 A.add(
"style",
"dotted,filled",
"alias");
682 A.add(
"shape",
"box");
684 A.add(
"shape",
"Mrecord",
"variable");
686 A.addComment(
"immutable");
688 A.addComment(
"writeOnly");
690 A.addComment(
"constant");
692 if (Flags.Visibility)
693 A.addComment(
"visibility");
695 A.addComment(
"dsoLocal");
696 if (Flags.CanAutoHide)
697 A.addComment(
"canAutoHide");
698 switch (SummaryIt.second->importType()) {
700 A.addComment(
"definition");
703 A.addComment(
"declaration");
706 if (Flags.NoRenameOnPromotion)
707 A.addComment(
"noRenameOnPromotion");
708 if (GUIDPreservedSymbols.
count(SummaryIt.first))
709 A.addComment(
"preserved");
714 A.add(
"fillcolor",
"red",
"dead");
715 else if (Flags.NotEligibleToImport)
716 A.add(
"fillcolor",
"yellow",
"not eligible to import");
718 OS <<
" " << NodeId(ModId, SummaryIt.first) <<
" " <<
A.getAsString()
721 OS <<
" // Edges:\n";
723 for (
auto &SummaryIt : GVSMap) {
724 auto *GVS = SummaryIt.second;
725 for (
auto &R : GVS->refs())
726 Draw(SummaryIt.first, R.getGUID(),
727 R.isWriteOnly() ? -1 : (R.isReadOnly() ? -2 : -3));
730 Draw(SummaryIt.first, AS->getAliaseeGUID(), -4);
735 for (
auto &CGEdge : FS->calls())
736 Draw(SummaryIt.first, CGEdge.first.getGUID(),
737 static_cast<int>(CGEdge.second.Hotness));
742 OS <<
" // Cross-module edges:\n";
743 for (
auto &E : CrossModuleEdges) {
744 auto &ModList = NodeMap[E.Dst];
745 if (ModList.empty()) {
749 ModList.push_back(-1);
751 for (
auto DstMod : ModList)
757 if (DstMod != E.SrcMod)
758 DrawEdge(
" ", E.SrcMod, E.Src, DstMod, E.Dst, E.Hotness);
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
static std::string getNodeVisualName(GlobalValue::GUID Id)
static std::string getNodeLabel(const ValueInfo &VI, GlobalValueSummary *GVS)
static std::string getSummaryAttributes(GlobalValueSummary *GVS)
static cl::opt< bool > ImportConstantsWithRefs("import-constants-with-refs", cl::init(true), cl::Hidden, cl::desc("Import constant global variables with references"))
static std::string fflagsToString(FunctionSummary::FFlags F)
static bool hasWriteOnlyFlag(const GlobalValueSummary *S)
static void propagateAttributesToRefs(GlobalValueSummary *S, DenseSet< ValueInfo > &MarkedNonReadWriteOnly)
static std::string linkageToString(GlobalValue::LinkageTypes LT)
static void defineExternalNode(raw_ostream &OS, const char *Pfx, const ValueInfo &VI, GlobalValue::GUID Id)
static cl::opt< bool > PropagateAttrs("propagate-attrs", cl::init(true), cl::Hidden, cl::desc("Propagate attributes in index"))
static bool hasReadOnlyFlag(const GlobalValueSummary *S)
static bool hasConstantFlag(const GlobalValueSummary *S)
ModuleSummaryIndex.h This file contains the declarations the classes that hold the module index and s...
This builds on the llvm/ADT/GraphTraits.h file to find the strongly connected components (SCCs) of a ...
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
#define STATISTIC(VARNAME, DESC)
size_type count(const_arg_type_t< KeyT > Val) const
Return 1 if the specified key is in the map, 0 otherwise.
std::pair< iterator, bool > try_emplace(KeyT &&Key, Ts &&...Args)
Implements a dense probed hash-table based set.
Function summary information to aid decisions and implementation of importing.
static LLVM_ABI FunctionSummary ExternalNode
A dummy node to reference external functions that aren't in the index.
static FunctionSummary makeDummyFunctionSummary(SmallVectorImpl< FunctionSummary::EdgeTy > &&Edges)
Create an empty FunctionSummary (with specified call edges).
LLVM_ABI std::pair< unsigned, unsigned > specialRefCounts() const
Function and variable summary information to aid decisions and implementation of importing.
GlobalValueSummary * getBaseObject()
If this is an alias summary, returns the summary of the aliased object (a global variable or function...
ArrayRef< ValueInfo > refs() const
Return the list of values referenced by this global value definition.
GlobalValue::LinkageTypes linkage() const
Return linkage type recorded for this global value.
bool notEligibleToImport() const
Return true if this global value can't be imported.
uint64_t GUID
Declare a type to represent a global unique identifier for a global value.
VisibilityTypes
An enumeration for the kinds of visibility of global values.
@ DefaultVisibility
The GV is visible.
@ HiddenVisibility
The GV is hidden.
@ ProtectedVisibility
The GV is protected.
static bool isInterposableLinkage(LinkageTypes Linkage)
Whether the definition of this global may be replaced by something non-equivalent at link time.
LinkageTypes
An enumeration for the kinds of linkage for global values.
@ PrivateLinkage
Like Internal, but omit from symbol table.
@ CommonLinkage
Tentative definitions.
@ InternalLinkage
Rename collisions when linking (static functions).
@ LinkOnceAnyLinkage
Keep one copy of function when linking (inline)
@ WeakODRLinkage
Same, but only replaced by something equivalent.
@ ExternalLinkage
Externally visible function.
@ WeakAnyLinkage
Keep one copy of named function when linking (weak)
@ AppendingLinkage
Special purpose, only applies to global arrays.
@ AvailableExternallyLinkage
Available for inspection, not emission.
@ ExternalWeakLinkage
ExternalWeak linkage description.
@ LinkOnceODRLinkage
Same, but only replaced by something equivalent.
Global variable summary information to aid decisions and implementation of importing.
bool withAttributePropagation() const
bool withInternalizeAndPromote() const
bool withGlobalValueDeadStripping() const
bool withWholeProgramVisibility() const
LLVM_ABI bool isGUIDLive(GlobalValue::GUID GUID) const
bool isReadOnly(const GlobalVarSummary *GVS) const
LLVM_ABI void setFlags(uint64_t Flags)
bool isWriteOnly(const GlobalVarSummary *GVS) const
void setPartiallySplitLTOUnits()
ValueInfo getValueInfo(const GlobalValueSummaryMapTy::value_type &R) const
Return a ValueInfo for the index value_type (convenient when iterating index).
void setEnableSplitLTOUnit()
bool partiallySplitLTOUnits() const
LLVM_ABI void collectDefinedFunctionsForModule(StringRef ModulePath, GVSummaryMapTy &GVSummaryMap) const
Collect for the given module the list of functions it defines (GUID -> Summary).
LLVM_ABI void dumpSCCs(raw_ostream &OS)
Print out strongly connected components for debugging.
bool isGlobalValueLive(const GlobalValueSummary *GVS) const
bool enableSplitLTOUnit() const
void setWithSupportsHotColdNew()
LLVM_ABI void propagateAttributes(const DenseSet< GlobalValue::GUID > &PreservedSymbols)
Do the access attribute and DSOLocal propagation in combined index.
void setSkipModuleByDistributedBackend()
void setWithAttributePropagation()
const StringMap< ModuleHash > & modulePaths() const
Table of modules, containing module hash and id.
bool withSupportsHotColdNew() const
void collectDefinedGVSummariesPerModule(Map &ModuleToDefinedGVSummaries) const
Collect for each module the list of Summaries it defines (GUID -> Summary).
bool withSpeculativeDevirt() const
bool withDSOLocalPropagation() const
LLVM_ABI void exportToDot(raw_ostream &OS, const DenseSet< GlobalValue::GUID > &GUIDPreservedSymbols) const
Export summary to dot file for GraphViz.
bool hasUnifiedLTO() const
void setWithDSOLocalPropagation()
void setWithInternalizeAndPromote()
bool skipModuleByDistributedBackend() const
void setWithSpeculativeDevirt()
LLVM_ABI uint64_t getFlags() const
GlobalValueSummary * getGlobalValueSummary(const GlobalValue &GV, bool PerModuleIndex=true) const
Returns the first GlobalValueSummary for GV, asserting that there is only one if PerModuleIndex.
void setWithGlobalValueDeadStripping()
void setWithWholeProgramVisibility()
LLVM_ABI bool canImportGlobalVar(const GlobalValueSummary *S, bool AnalyzeRefs) const
Checks if we can import global variable from another module.
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Represent a constant reference to a string, i.e.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
LLVM Value Representation.
std::pair< iterator, bool > insert(const ValueT &V)
bool contains(const_arg_type_t< ValueT > V) const
Check if the set contains the given element.
size_type count(const_arg_type_t< ValueT > V) const
Return 1 if the specified key is in the set, 0 otherwise.
This class implements an extremely fast bulk output stream that can only output to a stream.
Enumerate the SCCs of a directed graph in reverse topological order of the SCC DAG.
constexpr char Attrs[]
Key for Kernel::Metadata::mAttrs.
initializer< Ty > init(const Ty &Val)
LLVM_ABI StringRef filename(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get filename.
This is an optimization pass for GlobalISel generic memory operations.
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
DenseMap< GlobalValue::GUID, GlobalValueSummary * > GVSummaryMapTy
Map of global value GUID to its summary, used to identify values defined in a particular module,...
scc_iterator< T > scc_begin(const T &G)
Construct the begin iterator for a deduced graph type T.
std::string utostr(uint64_t X, bool isNeg=false)
auto dyn_cast_or_null(const Y &Val)
iterator_range< pointee_iterator< WrappedIteratorT > > make_pointee_range(RangeT &&Range)
void sort(IteratorTy Start, IteratorTy End)
cl::opt< bool > AlwaysRenamePromotedLocals("always-rename-promoted-locals", cl::init(true), cl::Hidden, cl::desc("Always rename promoted locals."))
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
LLVM_ABI bool AreStatisticsEnabled()
Check if statistics are enabled.
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
@ Ref
The access may reference the value stored in memory.
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Flags specific to function summaries.
Struct that holds a reference to a particular GUID in a global value summary.
LLVM_ABI GlobalValue::VisibilityTypes getELFVisibility() const
Returns the most constraining visibility among summaries.
ArrayRef< std::unique_ptr< GlobalValueSummary > > getSummaryList() const
LLVM_ABI bool canAutoHide() const
Checks if all copies are eligible for auto-hiding (have flag set).
LLVM_ABI bool isDSOLocal(bool WithDSOLocalPropagation=false) const
Checks if all summaries are DSO local (have the flag set).