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");
31 cl::desc(
"Propagate attributes in index"));
35 cl::desc(
"Import constant global variables with references"));
43 bool HasProtected =
false;
57 return WithDSOLocalPropagation
62 [](
const std::unique_ptr<GlobalValueSummary> &Summary) {
63 return Summary->isDSOLocal();
71 [](
const std::unique_ptr<GlobalValueSummary> &Summary) {
72 return Summary->canAutoHide();
81 unsigned RORefCnt = 0, WORefCnt = 0;
83 for (
I = Refs.size() - 1;
I >= 0 && Refs[
I].isWriteOnly(); --
I)
85 for (;
I >= 0 && Refs[
I].isReadOnly(); --
I)
87 return {RORefCnt, WORefCnt};
116 assert(
Flags <= 0x1ff &&
"Unexpected bits in flag");
160 for (
auto &GlobalList : *
this) {
161 auto GUID = GlobalList.first;
162 for (
auto &GlobSummary : GlobalList.second.SummaryList) {
163 auto *Summary = dyn_cast_or_null<FunctionSummary>(GlobSummary.get());
168 if (Summary->modulePath() != ModulePath)
170 GVSummaryMap[GUID] = Summary;
177 bool PerModuleIndex)
const {
179 assert(
VI &&
"GlobalValue not found in index");
180 assert((!PerModuleIndex ||
VI.getSummaryList().size() == 1) &&
181 "Expected a single entry per global value in per-module index");
182 auto &Summary =
VI.getSummaryList()[0];
183 return Summary.get();
190 const auto &SummaryList =
VI.getSummaryList();
191 if (SummaryList.empty())
193 for (
auto &
I : SummaryList)
210 for (
auto &
VI : S->
refs()) {
211 assert(
VI.getAccessSpecifier() == 0 || isa<FunctionSummary>(S));
212 if (!
VI.getAccessSpecifier()) {
213 if (!MarkedNonReadWriteOnly.
insert(
VI).second)
215 }
else if (MarkedNonReadWriteOnly.
contains(
VI))
217 for (
auto &
Ref :
VI.getSummaryList())
220 if (
auto *GVS = dyn_cast<GlobalVarSummary>(
Ref->getBaseObject())) {
221 if (!
VI.isReadOnly())
222 GVS->setReadOnly(
false);
223 if (!
VI.isWriteOnly())
224 GVS->setWriteOnly(
false);
261 for (
auto &
P : *
this) {
262 bool IsDSOLocal =
true;
263 for (
auto &S :
P.second.SummaryList) {
273 P.second.SummaryList,
274 [&](
const std::unique_ptr<GlobalValueSummary> &Summary) {
275 return isGlobalValueLive(Summary.get());
290 if (
auto *GVS = dyn_cast<GlobalVarSummary>(S->getBaseObject()))
295 GUIDPreservedSymbols.
count(
P.first)) {
296 GVS->setReadOnly(
false);
297 GVS->setWriteOnly(
false);
302 IsDSOLocal &= S->isDSOLocal();
307 for (
const std::unique_ptr<GlobalValueSummary> &Summary :
308 P.second.SummaryList)
309 Summary->setDSOLocal(
false);
314 for (
auto &
P : *
this)
315 if (
P.second.SummaryList.size())
316 if (
auto *GVS = dyn_cast<GlobalVarSummary>(
317 P.second.SummaryList[0]->getBaseObject()))
319 if (GVS->maybeReadOnly())
321 if (GVS->maybeWriteOnly())
322 WriteOnlyLiveGVars++;
327 bool AnalyzeRefs)
const {
355 (!AnalyzeRefs || !HasRefsPreventingImport(GVS));
363 scc_begin<ModuleSummaryIndex *>(
this);
365 O <<
"SCC (" << utostr(
I->size()) <<
" node" << (
I->size() == 1 ?
"" :
"s")
369 if (V.getSummaryList().size())
370 F = cast<FunctionSummary>(V.getSummaryList().front().get());
371 O <<
" " << (
F ==
nullptr ?
"External" :
"") <<
" " << utostr(V.getGUID())
372 << (
I.hasCycle() ?
" (has cycle)" :
"") <<
"\n";
382 void addComment(
const Twine &Comment);
383 std::string getAsString()
const;
385 std::vector<std::string> Attrs;
386 std::string Comments;
398 const Twine &Comment) {
399 std::string
A =
Name.str();
407void Attributes::addComment(
const Twine &Comment) {
408 if (!
Comment.isTriviallyEmpty()) {
409 if (Comments.empty())
417std::string Attributes::getAsString()
const {
421 std::string
Ret =
"[";
422 for (
auto &
A : Attrs)
439 return "linkonce_odr";
451 return "extern_weak";
460 auto FlagValue = [](
unsigned V) {
return V ?
'1' :
'0'; };
461 char FlagRep[] = {FlagValue(
F.ReadNone),
462 FlagValue(
F.ReadOnly),
463 FlagValue(
F.NoRecurse),
464 FlagValue(
F.ReturnDoesNotAlias),
465 FlagValue(
F.NoInline),
466 FlagValue(
F.AlwaysInline),
467 FlagValue(
F.NoUnwind),
468 FlagValue(
F.MayThrow),
469 FlagValue(
F.HasUnknownCall),
470 FlagValue(
F.MustBeUnreachable),
478 auto *FS = dyn_cast_or_null<FunctionSummary>(GVS);
482 return std::string(
"inst: ") + std::to_string(FS->instCount()) +
487 return std::string(
"@") + std::to_string(Id);
495 if (isa<AliasSummary>(GVS))
502 Label += std::string(
" (") + Attrs +
")";
513 auto StrId = std::to_string(Id);
514 OS <<
" " << StrId <<
" [label=\"";
521 OS <<
"\"]; // defined externally\n";
525 if (
auto *GVS = dyn_cast<GlobalVarSummary>(S))
526 return GVS->maybeReadOnly();
531 if (
auto *GVS = dyn_cast<GlobalVarSummary>(S))
532 return GVS->maybeWriteOnly();
537 if (
auto *GVS = dyn_cast<GlobalVarSummary>(S))
538 return GVS->isConstant();
545 std::vector<Edge> CrossModuleEdges;
547 using GVSOrderedMapTy = std::map<GlobalValue::GUID, GlobalValueSummary *>;
548 std::map<StringRef, GVSOrderedMapTy> ModuleToDefinedGVS;
554 return ModId == (
uint64_t)-1 ? std::to_string(Id)
555 : std::string(
"M") + std::to_string(ModId) +
556 "_" + std::to_string(Id);
568 static const char *EdgeAttrs[] = {
569 " [style=dotted]; // alias",
570 " [style=dashed]; // ref",
571 " [style=dashed,color=forestgreen]; // const-ref",
572 " [style=dashed,color=violetred]; // writeOnly-ref",
573 " // call (hotness : Unknown)",
574 " [color=blue]; // call (hotness : Cold)",
575 " // call (hotness : None)",
576 " [color=brown]; // call (hotness : Hot)",
577 " [style=bold,color=red]; // call (hotness : Critical)"};
579 assert(
static_cast<size_t>(TypeOrHotness) < std::size(EdgeAttrs));
580 OS << Pfx << NodeId(SrcMod, SrcId) <<
" -> " << NodeId(DstMod, DstId)
581 << EdgeAttrs[TypeOrHotness] <<
"\n";
584 OS <<
"digraph Summary {\n";
585 for (
auto &ModIt : ModuleToDefinedGVS) {
587 OS <<
" // Module: " << ModIt.first <<
"\n";
588 OS <<
" subgraph cluster_" << std::to_string(ModId) <<
" {\n";
589 OS <<
" style = filled;\n";
590 OS <<
" color = lightgrey;\n";
592 OS <<
" node [style=filled,fillcolor=lightblue];\n";
594 auto &GVSMap = ModIt.second;
596 if (!GVSMap.count(IdTo)) {
597 CrossModuleEdges.push_back({ModId, Hotness, IdFrom, IdTo});
600 DrawEdge(
" ", ModId, IdFrom, ModId, IdTo, Hotness);
603 for (
auto &SummaryIt : GVSMap) {
604 NodeMap[SummaryIt.first].push_back(ModId);
605 auto Flags = SummaryIt.second->flags();
607 if (isa<FunctionSummary>(SummaryIt.second)) {
608 A.add(
"shape",
"record",
"function");
609 }
else if (isa<AliasSummary>(SummaryIt.second)) {
610 A.add(
"style",
"dotted,filled",
"alias");
611 A.add(
"shape",
"box");
613 A.add(
"shape",
"Mrecord",
"variable");
615 A.addComment(
"immutable");
617 A.addComment(
"writeOnly");
619 A.addComment(
"constant");
621 if (
Flags.Visibility)
622 A.addComment(
"visibility");
624 A.addComment(
"dsoLocal");
625 if (
Flags.CanAutoHide)
626 A.addComment(
"canAutoHide");
627 if (GUIDPreservedSymbols.
count(SummaryIt.first))
628 A.addComment(
"preserved");
633 A.add(
"fillcolor",
"red",
"dead");
634 else if (
Flags.NotEligibleToImport)
635 A.add(
"fillcolor",
"yellow",
"not eligible to import");
637 OS <<
" " << NodeId(ModId, SummaryIt.first) <<
" " <<
A.getAsString()
640 OS <<
" // Edges:\n";
642 for (
auto &SummaryIt : GVSMap) {
643 auto *GVS = SummaryIt.second;
644 for (
auto &R : GVS->refs())
645 Draw(SummaryIt.first, R.getGUID(),
646 R.isWriteOnly() ? -1 : (R.isReadOnly() ? -2 : -3));
648 if (
auto *AS = dyn_cast_or_null<AliasSummary>(SummaryIt.second)) {
649 Draw(SummaryIt.first, AS->getAliaseeGUID(), -4);
653 if (
auto *FS = dyn_cast_or_null<FunctionSummary>(SummaryIt.second))
654 for (
auto &CGEdge : FS->calls())
655 Draw(SummaryIt.first, CGEdge.first.getGUID(),
656 static_cast<int>(CGEdge.second.Hotness));
661 OS <<
" // Cross-module edges:\n";
662 for (
auto &
E : CrossModuleEdges) {
663 auto &ModList = NodeMap[
E.Dst];
664 if (ModList.empty()) {
668 ModList.push_back(-1);
670 for (
auto DstMod : ModList)
676 if (DstMod !=
E.SrcMod)
677 DrawEdge(
" ",
E.SrcMod,
E.Src, DstMod,
E.Dst,
E.Hotness);
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#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 ...
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
#define STATISTIC(VARNAME, DESC)
Implements a dense probed hash-table based set.
Function summary information to aid decisions and implementation of importing.
static FunctionSummary ExternalNode
A dummy node to reference external functions that aren't in the index.
static FunctionSummary makeDummyFunctionSummary(std::vector< FunctionSummary::EdgeTy > Edges)
Create an empty FunctionSummary (with specified call edges).
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 withGlobalValueDeadStripping() const
bool withWholeProgramVisibility() const
bool isGUIDLive(GlobalValue::GUID GUID) const
bool isReadOnly(const GlobalVarSummary *GVS) const
void setFlags(uint64_t Flags)
uint64_t getModuleId(const StringRef ModPath) const
Get the module ID recorded for the given module path.
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()
void setHasSyntheticEntryCounts()
bool hasSyntheticEntryCounts() const
bool partiallySplitLTOUnits() const
void collectDefinedFunctionsForModule(StringRef ModulePath, GVSummaryMapTy &GVSummaryMap) const
Collect for the given module the list of functions it defines (GUID -> Summary).
void dumpSCCs(raw_ostream &OS)
Print out strongly connected components for debugging.
bool isGlobalValueLive(const GlobalValueSummary *GVS) const
bool enableSplitLTOUnit() const
void setWithSupportsHotColdNew()
void propagateAttributes(const DenseSet< GlobalValue::GUID > &PreservedSymbols)
Do the access attribute and DSOLocal propagation in combined index.
void setSkipModuleByDistributedBackend()
void setWithAttributePropagation()
bool withSupportsHotColdNew() const
void collectDefinedGVSummariesPerModule(Map &ModuleToDefinedGVSummaries) const
Collect for each module the list of Summaries it defines (GUID -> Summary).
static constexpr uint64_t BitcodeSummaryVersion
bool withDSOLocalPropagation() const
void exportToDot(raw_ostream &OS, const DenseSet< GlobalValue::GUID > &GUIDPreservedSymbols) const
Export summary to dot file for GraphViz.
void setWithDSOLocalPropagation()
bool skipModuleByDistributedBackend() const
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()
bool canImportGlobalVar(const GlobalValueSummary *S, bool AnalyzeRefs) const
Checks if we can import global variable from another module.
StringRef - 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)
StringRef filename(StringRef path, 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.
iterator_range< pointee_iterator< WrappedIteratorT > > make_pointee_range(RangeT &&Range)
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
bool AreStatisticsEnabled()
Check if statistics are enabled.
@ Ref
The access may reference the value stored in memory.
Flags specific to function summaries.
static constexpr uint32_t RangeWidth
Struct that holds a reference to a particular GUID in a global value summary.
GlobalValue::VisibilityTypes getELFVisibility() const
Returns the most constraining visibility among summaries.
ArrayRef< std::unique_ptr< GlobalValueSummary > > getSummaryList() const
bool canAutoHide() const
Checks if all copies are eligible for auto-hiding (have flag set).
bool isDSOLocal(bool WithDSOLocalPropagation=false) const
Checks if all summaries are DSO local (have the flag set).