LLVM 22.0.0git
ModuleSummaryIndex.cpp
Go to the documentation of this file.
1//===-- ModuleSummaryIndex.cpp - Module Summary Index ---------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the module index and summary classes for the
10// IR library.
11//
12//===----------------------------------------------------------------------===//
13
16#include "llvm/ADT/Statistic.h"
18#include "llvm/Support/Path.h"
20using namespace llvm;
21
22#define DEBUG_TYPE "module-summary-index"
23
24STATISTIC(ReadOnlyLiveGVars,
25 "Number of live global variables marked read only");
26STATISTIC(WriteOnlyLiveGVars,
27 "Number of live global variables marked write only");
28
29static cl::opt<bool> PropagateAttrs("propagate-attrs", cl::init(true),
31 cl::desc("Propagate attributes in index"));
32
34 "import-constants-with-refs", cl::init(true), cl::Hidden,
35 cl::desc("Import constant global variables with references"));
36
40
42 bool HasProtected = false;
43 for (const auto &S : make_pointee_range(getSummaryList())) {
44 if (S.getVisibility() == GlobalValue::HiddenVisibility)
46 if (S.getVisibility() == GlobalValue::ProtectedVisibility)
47 HasProtected = true;
48 }
49 return HasProtected ? GlobalValue::ProtectedVisibility
51}
52
53bool ValueInfo::isDSOLocal(bool WithDSOLocalPropagation) const {
54 // With DSOLocal propagation done, the flag in evey summary is the same.
55 // Check the first one is enough.
56 return WithDSOLocalPropagation
57 ? getSummaryList().size() && getSummaryList()[0]->isDSOLocal()
58 : getSummaryList().size() &&
61 [](const std::unique_ptr<GlobalValueSummary> &Summary) {
62 return Summary->isDSOLocal();
63 });
64}
65
67 // Can only auto hide if all copies are eligible to auto hide.
68 return getSummaryList().size() &&
70 [](const std::unique_ptr<GlobalValueSummary> &Summary) {
71 return Summary->canAutoHide();
72 });
73}
74
75// Gets the number of readonly and writeonly refs in RefEdgeList
76std::pair<unsigned, unsigned> FunctionSummary::specialRefCounts() const {
77 // Here we take advantage of having all readonly and writeonly references
78 // located in the end of the RefEdgeList.
79 auto Refs = refs();
80 unsigned RORefCnt = 0, WORefCnt = 0;
81 int I;
82 for (I = Refs.size() - 1; I >= 0 && Refs[I].isWriteOnly(); --I)
83 WORefCnt++;
84 for (; I >= 0 && Refs[I].isReadOnly(); --I)
85 RORefCnt++;
86 return {RORefCnt, WORefCnt};
87}
88
90 uint64_t Flags = 0;
91 // Flags & 0x4 is reserved. DO NOT REUSE.
93 Flags |= 0x1;
95 Flags |= 0x2;
97 Flags |= 0x8;
99 Flags |= 0x10;
101 Flags |= 0x20;
103 Flags |= 0x40;
105 Flags |= 0x80;
107 Flags |= 0x100;
108 if (hasUnifiedLTO())
109 Flags |= 0x200;
111 Flags |= 0x400;
112 return Flags;
113}
114
116 assert(Flags <= 0x7ff && "Unexpected bits in flag");
117 // 1 bit: WithGlobalValueDeadStripping flag.
118 // Set on combined index only.
119 if (Flags & 0x1)
121 // 1 bit: SkipModuleByDistributedBackend flag.
122 // Set on combined index only.
123 if (Flags & 0x2)
125 // Flags & 0x4 is reserved. DO NOT REUSE.
126 // 1 bit: DisableSplitLTOUnit flag.
127 // Set on per module indexes. It is up to the client to validate
128 // the consistency of this flag across modules being linked.
129 if (Flags & 0x8)
131 // 1 bit: PartiallySplitLTOUnits flag.
132 // Set on combined index only.
133 if (Flags & 0x10)
135 // 1 bit: WithAttributePropagation flag.
136 // Set on combined index only.
137 if (Flags & 0x20)
139 // 1 bit: WithDSOLocalPropagation flag.
140 // Set on combined index only.
141 if (Flags & 0x40)
143 // 1 bit: WithWholeProgramVisibility flag.
144 // Set on combined index only.
145 if (Flags & 0x80)
147 // 1 bit: WithSupportsHotColdNew flag.
148 // Set on combined index only.
149 if (Flags & 0x100)
151 // 1 bit: WithUnifiedLTO flag.
152 // Set on combined index only.
153 if (Flags & 0x200)
155 // 1 bit: WithInternalizeAndPromote flag.
156 // Set on combined index only.
157 if (Flags & 0x400)
159}
160
161// Collect for the given module the list of function it defines
162// (GUID -> Summary).
164 StringRef ModulePath, GVSummaryMapTy &GVSummaryMap) const {
165 for (auto &GlobalList : *this) {
166 auto GUID = GlobalList.first;
167 for (auto &GlobSummary : GlobalList.second.getSummaryList()) {
168 auto *Summary = dyn_cast_or_null<FunctionSummary>(GlobSummary.get());
169 if (!Summary)
170 // Ignore global variable, focus on functions
171 continue;
172 // Ignore summaries from other modules.
173 if (Summary->modulePath() != ModulePath)
174 continue;
175 GVSummaryMap[GUID] = Summary;
176 }
177 }
178}
179
182 bool PerModuleIndex) const {
183 auto VI = getValueInfo(ValueGUID);
184 assert(VI && "GlobalValue not found in index");
185 assert((!PerModuleIndex || VI.getSummaryList().size() == 1) &&
186 "Expected a single entry per global value in per-module index");
187 auto &Summary = VI.getSummaryList()[0];
188 return Summary.get();
189}
190
192 auto VI = getValueInfo(GUID);
193 if (!VI)
194 return true;
195 const auto &SummaryList = VI.getSummaryList();
196 if (SummaryList.empty())
197 return true;
198 for (auto &I : SummaryList)
199 if (isGlobalValueLive(I.get()))
200 return true;
201 return false;
202}
203
204static void
206 DenseSet<ValueInfo> &MarkedNonReadWriteOnly) {
207 // If reference is not readonly or writeonly then referenced summary is not
208 // read/writeonly either. Note that:
209 // - All references from GlobalVarSummary are conservatively considered as
210 // not readonly or writeonly. Tracking them properly requires more complex
211 // analysis then we have now.
212 //
213 // - AliasSummary objects have no refs at all so this function is a no-op
214 // for them.
215 for (auto &VI : S->refs()) {
216 assert(VI.getAccessSpecifier() == 0 || isa<FunctionSummary>(S));
217 if (!VI.getAccessSpecifier()) {
218 if (!MarkedNonReadWriteOnly.insert(VI).second)
219 continue;
220 } else if (MarkedNonReadWriteOnly.contains(VI))
221 continue;
222 for (auto &Ref : VI.getSummaryList())
223 // If references to alias is not read/writeonly then aliasee
224 // is not read/writeonly
225 if (auto *GVS = dyn_cast<GlobalVarSummary>(Ref->getBaseObject())) {
226 if (!VI.isReadOnly())
227 GVS->setReadOnly(false);
228 if (!VI.isWriteOnly())
229 GVS->setWriteOnly(false);
230 }
231 }
232}
233
234// Do the access attribute and DSOLocal propagation in combined index.
235// The goal of attribute propagation is internalization of readonly (RO)
236// or writeonly (WO) variables. To determine which variables are RO or WO
237// and which are not we take following steps:
238// - During analysis we speculatively assign readonly and writeonly
239// attribute to all variables which can be internalized. When computing
240// function summary we also assign readonly or writeonly attribute to a
241// reference if function doesn't modify referenced variable (readonly)
242// or doesn't read it (writeonly).
243//
244// - After computing dead symbols in combined index we do the attribute
245// and DSOLocal propagation. During this step we:
246// a. clear RO and WO attributes from variables which are preserved or
247// can't be imported
248// b. clear RO and WO attributes from variables referenced by any global
249// variable initializer
250// c. clear RO attribute from variable referenced by a function when
251// reference is not readonly
252// d. clear WO attribute from variable referenced by a function when
253// reference is not writeonly
254// e. clear IsDSOLocal flag in every summary if any of them is false.
255//
256// Because of (c, d) we don't internalize variables read by function A
257// and modified by function B.
258//
259// Internalization itself happens in the backend after import is finished
260// See internalizeGVsAfterImport.
262 const DenseSet<GlobalValue::GUID> &GUIDPreservedSymbols) {
263 if (!PropagateAttrs)
264 return;
265 DenseSet<ValueInfo> MarkedNonReadWriteOnly;
266 for (auto &P : *this) {
267 bool IsDSOLocal = true;
268 for (auto &S : P.second.getSummaryList()) {
269 if (!isGlobalValueLive(S.get())) {
270 // computeDeadSymbolsAndUpdateIndirectCalls should have marked all
271 // copies live. Note that it is possible that there is a GUID collision
272 // between internal symbols with the same name in different files of the
273 // same name but not enough distinguishing path. Because
274 // computeDeadSymbolsAndUpdateIndirectCalls should conservatively mark
275 // all copies live we can assert here that all are dead if any copy is
276 // dead.
278 P.second.getSummaryList(),
279 [&](const std::unique_ptr<GlobalValueSummary> &Summary) {
280 return isGlobalValueLive(Summary.get());
281 }));
282 // We don't examine references from dead objects
283 break;
284 }
285
286 // Global variable can't be marked read/writeonly if it is not eligible
287 // to import since we need to ensure that all external references get
288 // a local (imported) copy. It also can't be marked read/writeonly if
289 // it or any alias (since alias points to the same memory) are preserved
290 // or notEligibleToImport, since either of those means there could be
291 // writes (or reads in case of writeonly) that are not visible (because
292 // preserved means it could have external to DSO writes or reads, and
293 // notEligibleToImport means it could have writes or reads via inline
294 // assembly leading it to be in the @llvm.*used).
295 if (auto *GVS = dyn_cast<GlobalVarSummary>(S->getBaseObject()))
296 // Here we intentionally pass S.get() not GVS, because S could be
297 // an alias. We don't analyze references here, because we have to
298 // know exactly if GV is readonly to do so.
299 if (!canImportGlobalVar(S.get(), /* AnalyzeRefs */ false) ||
300 GUIDPreservedSymbols.count(P.first)) {
301 GVS->setReadOnly(false);
302 GVS->setWriteOnly(false);
303 }
304 propagateAttributesToRefs(S.get(), MarkedNonReadWriteOnly);
305
306 // If the flag from any summary is false, the GV is not DSOLocal.
307 IsDSOLocal &= S->isDSOLocal();
308 }
309 if (!IsDSOLocal)
310 // Mark the flag in all summaries false so that we can do quick check
311 // without going through the whole list.
312 for (const std::unique_ptr<GlobalValueSummary> &Summary :
313 P.second.getSummaryList())
314 Summary->setDSOLocal(false);
315 }
319 for (auto &P : *this)
320 if (P.second.getSummaryList().size())
321 if (auto *GVS = dyn_cast<GlobalVarSummary>(
322 P.second.getSummaryList()[0]->getBaseObject()))
323 if (isGlobalValueLive(GVS)) {
324 if (GVS->maybeReadOnly())
325 ReadOnlyLiveGVars++;
326 if (GVS->maybeWriteOnly())
327 WriteOnlyLiveGVars++;
328 }
329}
330
332 bool AnalyzeRefs) const {
333 bool CanImportDecl;
334 return canImportGlobalVar(S, AnalyzeRefs, CanImportDecl);
335}
336
338 bool AnalyzeRefs,
339 bool &CanImportDecl) const {
340 auto HasRefsPreventingImport = [this](const GlobalVarSummary *GVS) {
341 // We don't analyze GV references during attribute propagation, so
342 // GV with non-trivial initializer can be marked either read or
343 // write-only.
344 // Importing definiton of readonly GV with non-trivial initializer
345 // allows us doing some extra optimizations (like converting indirect
346 // calls to direct).
347 // Definition of writeonly GV with non-trivial initializer should also
348 // be imported. Not doing so will result in:
349 // a) GV internalization in source module (because it's writeonly)
350 // b) Importing of GV declaration to destination module as a result
351 // of promotion.
352 // c) Link error (external declaration with internal definition).
353 // However we do not promote objects referenced by writeonly GV
354 // initializer by means of converting it to 'zeroinitializer'
355 return !(ImportConstantsWithRefs && GVS->isConstant()) &&
356 !isReadOnly(GVS) && !isWriteOnly(GVS) && GVS->refs().size();
357 };
358 auto *GVS = cast<GlobalVarSummary>(S->getBaseObject());
359
360 const bool nonInterposable =
362 const bool eligibleToImport = !S->notEligibleToImport();
363
364 // It's correct to import a global variable only when it is not interposable
365 // and eligible to import.
366 CanImportDecl = (nonInterposable && eligibleToImport);
367
368 // Global variable with non-trivial initializer can be imported
369 // if it's readonly. This gives us extra opportunities for constant
370 // folding and converting indirect calls to direct calls. We don't
371 // analyze GV references during attribute propagation, because we
372 // don't know yet if it is readonly or not.
373 return nonInterposable && eligibleToImport &&
374 (!AnalyzeRefs || !HasRefsPreventingImport(GVS));
375}
376
377// TODO: write a graphviz dumper for SCCs (see ModuleSummaryIndex::exportToDot)
378// then delete this function and update its tests
383 !I.isAtEnd(); ++I) {
384 O << "SCC (" << utostr(I->size()) << " node" << (I->size() == 1 ? "" : "s")
385 << ") {\n";
386 for (const ValueInfo &V : *I) {
387 FunctionSummary *F = nullptr;
388 if (V.getSummaryList().size())
389 F = cast<FunctionSummary>(V.getSummaryList().front().get());
390 O << " " << (F == nullptr ? "External" : "") << " " << utostr(V.getGUID())
391 << (I.hasCycle() ? " (has cycle)" : "") << "\n";
392 }
393 O << "}\n";
394 }
395}
396
397namespace {
398struct Attributes {
399 void add(const Twine &Name, const Twine &Value,
400 const Twine &Comment = Twine());
401 void addComment(const Twine &Comment);
402 std::string getAsString() const;
403
404 std::vector<std::string> Attrs;
405 std::string Comments;
406};
407
408struct Edge {
409 uint64_t SrcMod;
410 int Hotness;
413};
414} // namespace
415
416void Attributes::add(const Twine &Name, const Twine &Value,
417 const Twine &Comment) {
418 std::string A = Name.str();
419 A += "=\"";
420 A += Value.str();
421 A += "\"";
422 Attrs.push_back(A);
423 addComment(Comment);
424}
425
426void Attributes::addComment(const Twine &Comment) {
427 if (!Comment.isTriviallyEmpty()) {
428 if (Comments.empty())
429 Comments = " // ";
430 else
431 Comments += ", ";
432 Comments += Comment.str();
433 }
434}
435
436std::string Attributes::getAsString() const {
437 if (Attrs.empty())
438 return "";
439
440 std::string Ret = "[";
441 for (auto &A : Attrs)
442 Ret += A + ",";
443 Ret.pop_back();
444 Ret += "];";
445 Ret += Comments;
446 return Ret;
447}
448
450 switch (LT) {
452 return "extern";
454 return "av_ext";
456 return "linkonce";
458 return "linkonce_odr";
460 return "weak";
462 return "weak_odr";
464 return "appending";
466 return "internal";
468 return "private";
470 return "extern_weak";
472 return "common";
473 }
474
475 return "<unknown>";
476}
477
479 auto FlagValue = [](unsigned V) { return V ? '1' : '0'; };
480 char FlagRep[] = {FlagValue(F.ReadNone),
481 FlagValue(F.ReadOnly),
482 FlagValue(F.NoRecurse),
483 FlagValue(F.ReturnDoesNotAlias),
484 FlagValue(F.NoInline),
485 FlagValue(F.AlwaysInline),
486 FlagValue(F.NoUnwind),
487 FlagValue(F.MayThrow),
488 FlagValue(F.HasUnknownCall),
489 FlagValue(F.MustBeUnreachable),
490 0};
491
492 return FlagRep;
493}
494
495// Get string representation of function instruction count and flags.
496static std::string getSummaryAttributes(GlobalValueSummary* GVS) {
497 auto *FS = dyn_cast_or_null<FunctionSummary>(GVS);
498 if (!FS)
499 return "";
500
501 return std::string("inst: ") + std::to_string(FS->instCount()) +
502 ", ffl: " + fflagsToString(FS->fflags());
503}
504
505static std::string getNodeVisualName(GlobalValue::GUID Id) {
506 return std::string("@") + std::to_string(Id);
507}
508
509static std::string getNodeVisualName(const ValueInfo &VI) {
510 return VI.name().empty() ? getNodeVisualName(VI.getGUID()) : VI.name().str();
511}
512
513static std::string getNodeLabel(const ValueInfo &VI, GlobalValueSummary *GVS) {
514 if (isa<AliasSummary>(GVS))
515 return getNodeVisualName(VI);
516
517 std::string Attrs = getSummaryAttributes(GVS);
518 std::string Label =
519 getNodeVisualName(VI) + "|" + linkageToString(GVS->linkage());
520 if (!Attrs.empty())
521 Label += std::string(" (") + Attrs + ")";
522 Label += "}";
523
524 return Label;
525}
526
527// Write definition of external node, which doesn't have any
528// specific module associated with it. Typically this is function
529// or variable defined in native object or library.
530static void defineExternalNode(raw_ostream &OS, const char *Pfx,
531 const ValueInfo &VI, GlobalValue::GUID Id) {
532 auto StrId = std::to_string(Id);
533 OS << " " << StrId << " [label=\"";
534
535 if (VI) {
536 OS << getNodeVisualName(VI);
537 } else {
538 OS << getNodeVisualName(Id);
539 }
540 OS << "\"]; // defined externally\n";
541}
542
543static bool hasReadOnlyFlag(const GlobalValueSummary *S) {
544 if (auto *GVS = dyn_cast<GlobalVarSummary>(S))
545 return GVS->maybeReadOnly();
546 return false;
547}
548
550 if (auto *GVS = dyn_cast<GlobalVarSummary>(S))
551 return GVS->maybeWriteOnly();
552 return false;
553}
554
555static bool hasConstantFlag(const GlobalValueSummary *S) {
556 if (auto *GVS = dyn_cast<GlobalVarSummary>(S))
557 return GVS->isConstant();
558 return false;
559}
560
562 raw_ostream &OS,
563 const DenseSet<GlobalValue::GUID> &GUIDPreservedSymbols) const {
564 std::vector<Edge> CrossModuleEdges;
566 using GVSOrderedMapTy = std::map<GlobalValue::GUID, GlobalValueSummary *>;
567 std::map<StringRef, GVSOrderedMapTy> ModuleToDefinedGVS;
568 collectDefinedGVSummariesPerModule(ModuleToDefinedGVS);
569
570 // Assign an id to each module path for use in graph labels. Since the
571 // StringMap iteration order isn't guaranteed, order by path string before
572 // assigning ids.
573 std::vector<StringRef> ModulePaths;
574 for (auto &[ModPath, _] : modulePaths())
575 ModulePaths.push_back(ModPath);
576 llvm::sort(ModulePaths);
578 for (auto &ModPath : ModulePaths)
579 ModuleIdMap.try_emplace(ModPath, ModuleIdMap.size());
580
581 // Get node identifier in form MXXX_<GUID>. The MXXX prefix is required,
582 // because we may have multiple linkonce functions summaries.
583 auto NodeId = [](uint64_t ModId, GlobalValue::GUID Id) {
584 return ModId == (uint64_t)-1 ? std::to_string(Id)
585 : std::string("M") + std::to_string(ModId) +
586 "_" + std::to_string(Id);
587 };
588
589 auto DrawEdge = [&](const char *Pfx, uint64_t SrcMod, GlobalValue::GUID SrcId,
590 uint64_t DstMod, GlobalValue::GUID DstId,
591 int TypeOrHotness) {
592 // 0 - alias
593 // 1 - reference
594 // 2 - constant reference
595 // 3 - writeonly reference
596 // Other value: (hotness - 4).
597 TypeOrHotness += 4;
598 static const char *EdgeAttrs[] = {
599 " [style=dotted]; // alias",
600 " [style=dashed]; // ref",
601 " [style=dashed,color=forestgreen]; // const-ref",
602 " [style=dashed,color=violetred]; // writeOnly-ref",
603 " // call (hotness : Unknown)",
604 " [color=blue]; // call (hotness : Cold)",
605 " // call (hotness : None)",
606 " [color=brown]; // call (hotness : Hot)",
607 " [style=bold,color=red]; // call (hotness : Critical)"};
608
609 assert(static_cast<size_t>(TypeOrHotness) < std::size(EdgeAttrs));
610 OS << Pfx << NodeId(SrcMod, SrcId) << " -> " << NodeId(DstMod, DstId)
611 << EdgeAttrs[TypeOrHotness] << "\n";
612 };
613
614 OS << "digraph Summary {\n";
615 for (auto &ModIt : ModuleToDefinedGVS) {
616 // Will be empty for a just built per-module index, which doesn't setup a
617 // module paths table. In that case use 0 as the module id.
618 assert(ModuleIdMap.count(ModIt.first) || ModuleIdMap.empty());
619 auto ModId = ModuleIdMap.empty() ? 0 : ModuleIdMap[ModIt.first];
620 OS << " // Module: " << ModIt.first << "\n";
621 OS << " subgraph cluster_" << std::to_string(ModId) << " {\n";
622 OS << " style = filled;\n";
623 OS << " color = lightgrey;\n";
624 OS << " label = \"" << sys::path::filename(ModIt.first) << "\";\n";
625 OS << " node [style=filled,fillcolor=lightblue];\n";
626
627 auto &GVSMap = ModIt.second;
628 auto Draw = [&](GlobalValue::GUID IdFrom, GlobalValue::GUID IdTo, int Hotness) {
629 if (!GVSMap.count(IdTo)) {
630 CrossModuleEdges.push_back({ModId, Hotness, IdFrom, IdTo});
631 return;
632 }
633 DrawEdge(" ", ModId, IdFrom, ModId, IdTo, Hotness);
634 };
635
636 for (auto &SummaryIt : GVSMap) {
637 NodeMap[SummaryIt.first].push_back(ModId);
638 auto Flags = SummaryIt.second->flags();
639 Attributes A;
640 if (isa<FunctionSummary>(SummaryIt.second)) {
641 A.add("shape", "record", "function");
642 } else if (isa<AliasSummary>(SummaryIt.second)) {
643 A.add("style", "dotted,filled", "alias");
644 A.add("shape", "box");
645 } else {
646 A.add("shape", "Mrecord", "variable");
647 if (Flags.Live && hasReadOnlyFlag(SummaryIt.second))
648 A.addComment("immutable");
649 if (Flags.Live && hasWriteOnlyFlag(SummaryIt.second))
650 A.addComment("writeOnly");
651 if (Flags.Live && hasConstantFlag(SummaryIt.second))
652 A.addComment("constant");
653 }
654 if (Flags.Visibility)
655 A.addComment("visibility");
656 if (Flags.DSOLocal)
657 A.addComment("dsoLocal");
658 if (Flags.CanAutoHide)
659 A.addComment("canAutoHide");
660 if (Flags.ImportType == GlobalValueSummary::ImportKind::Definition)
661 A.addComment("definition");
662 else if (Flags.ImportType == GlobalValueSummary::ImportKind::Declaration)
663 A.addComment("declaration");
664 if (GUIDPreservedSymbols.count(SummaryIt.first))
665 A.addComment("preserved");
666
667 auto VI = getValueInfo(SummaryIt.first);
668 A.add("label", getNodeLabel(VI, SummaryIt.second));
669 if (!Flags.Live)
670 A.add("fillcolor", "red", "dead");
671 else if (Flags.NotEligibleToImport)
672 A.add("fillcolor", "yellow", "not eligible to import");
673
674 OS << " " << NodeId(ModId, SummaryIt.first) << " " << A.getAsString()
675 << "\n";
676 }
677 OS << " // Edges:\n";
678
679 for (auto &SummaryIt : GVSMap) {
680 auto *GVS = SummaryIt.second;
681 for (auto &R : GVS->refs())
682 Draw(SummaryIt.first, R.getGUID(),
683 R.isWriteOnly() ? -1 : (R.isReadOnly() ? -2 : -3));
684
685 if (auto *AS = dyn_cast_or_null<AliasSummary>(SummaryIt.second)) {
686 Draw(SummaryIt.first, AS->getAliaseeGUID(), -4);
687 continue;
688 }
689
690 if (auto *FS = dyn_cast_or_null<FunctionSummary>(SummaryIt.second))
691 for (auto &CGEdge : FS->calls())
692 Draw(SummaryIt.first, CGEdge.first.getGUID(),
693 static_cast<int>(CGEdge.second.Hotness));
694 }
695 OS << " }\n";
696 }
697
698 OS << " // Cross-module edges:\n";
699 for (auto &E : CrossModuleEdges) {
700 auto &ModList = NodeMap[E.Dst];
701 if (ModList.empty()) {
702 defineExternalNode(OS, " ", getValueInfo(E.Dst), E.Dst);
703 // Add fake module to the list to draw an edge to an external node
704 // in the loop below.
705 ModList.push_back(-1);
706 }
707 for (auto DstMod : ModList)
708 // The edge representing call or ref is drawn to every module where target
709 // symbol is defined. When target is a linkonce symbol there can be
710 // multiple edges representing a single call or ref, both intra-module and
711 // cross-module. As we've already drawn all intra-module edges before we
712 // skip it here.
713 if (DstMod != E.SrcMod)
714 DrawEdge(" ", E.SrcMod, E.Src, DstMod, E.Dst, E.Hotness);
715 }
716
717 OS << "}";
718}
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.
Definition Compiler.h:638
#define _
#define F(x, y, z)
Definition MD5.cpp:55
#define I(x, y, z)
Definition MD5.cpp:58
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...
#define P(N)
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)
Definition Statistic.h:171
std::pair< iterator, bool > try_emplace(KeyT &&Key, Ts &&...Args)
Definition DenseMap.h:248
unsigned size() const
Definition DenseMap.h:110
bool empty() const
Definition DenseMap.h:109
size_type count(const_arg_type_t< KeyT > Val) const
Return 1 if the specified key is in the map, 0 otherwise.
Definition DenseMap.h:174
Implements a dense probed hash-table based set.
Definition DenseSet.h:279
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.
Definition GlobalValue.h:67
@ DefaultVisibility
The GV is visible.
Definition GlobalValue.h:68
@ HiddenVisibility
The GV is hidden.
Definition GlobalValue.h:69
@ ProtectedVisibility
The GV is protected.
Definition GlobalValue.h:70
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.
Definition GlobalValue.h:52
@ PrivateLinkage
Like Internal, but omit from symbol table.
Definition GlobalValue.h:61
@ CommonLinkage
Tentative definitions.
Definition GlobalValue.h:63
@ InternalLinkage
Rename collisions when linking (static functions).
Definition GlobalValue.h:60
@ LinkOnceAnyLinkage
Keep one copy of function when linking (inline)
Definition GlobalValue.h:55
@ WeakODRLinkage
Same, but only replaced by something equivalent.
Definition GlobalValue.h:58
@ ExternalLinkage
Externally visible function.
Definition GlobalValue.h:53
@ WeakAnyLinkage
Keep one copy of named function when linking (weak)
Definition GlobalValue.h:57
@ AppendingLinkage
Special purpose, only applies to global arrays.
Definition GlobalValue.h:59
@ AvailableExternallyLinkage
Available for inspection, not emission.
Definition GlobalValue.h:54
@ ExternalWeakLinkage
ExternalWeak linkage description.
Definition GlobalValue.h:62
@ LinkOnceODRLinkage
Same, but only replaced by something equivalent.
Definition GlobalValue.h:56
Global variable summary information to aid decisions and implementation of importing.
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
ValueInfo getValueInfo(const GlobalValueSummaryMapTy::value_type &R) const
Return a ValueInfo for the index value_type (convenient when iterating index).
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
LLVM_ABI void propagateAttributes(const DenseSet< GlobalValue::GUID > &PreservedSymbols)
Do the access attribute and DSOLocal propagation in combined index.
const StringMap< ModuleHash > & modulePaths() const
Table of modules, containing module hash and id.
void collectDefinedGVSummariesPerModule(Map &ModuleToDefinedGVSummaries) const
Collect for each module the list of Summaries it defines (GUID -> Summary).
LLVM_ABI void exportToDot(raw_ostream &OS, const DenseSet< GlobalValue::GUID > &GUIDPreservedSymbols) const
Export summary to dot file for GraphViz.
bool skipModuleByDistributedBackend() const
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.
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.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
LLVM Value Representation.
Definition Value.h:75
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:202
bool contains(const_arg_type_t< ValueT > V) const
Check if the set contains the given element.
Definition DenseSet.h:175
size_type count(const_arg_type_t< ValueT > V) const
Return 1 if the specified key is in the set, 0 otherwise.
Definition DenseSet.h:180
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
Enumerate the SCCs of a directed graph in reverse topological order of the SCC DAG.
Definition SCCIterator.h:49
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.
Definition Path.cpp:577
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.
Definition STLExtras.h:1725
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
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)
Definition Casting.h:753
iterator_range< pointee_iterator< WrappedIteratorT > > make_pointee_range(RangeT &&Range)
Definition iterator.h:336
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1622
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1739
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...
Definition Casting.h:547
@ Ref
The access may reference the value stored in memory.
Definition ModRef.h:32
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
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).