blob: 2b355deade3cac28d662a643b2a7cc24940fe112 [file] [log] [blame]
Teresa Johnson2d5487c2016-04-11 13:58:45 +00001//===- ModuleSummaryAnalysis.cpp - Module summary index builder -----------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This pass builds a ModuleSummaryIndex object for the module, to be written
11// to bitcode or LLVM assembly.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/Analysis/ModuleSummaryAnalysis.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000016#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/DenseSet.h"
Peter Collingbourne0c30f082016-12-20 21:12:28 +000018#include "llvm/ADT/MapVector.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000019#include "llvm/ADT/STLExtras.h"
Peter Collingbourne0c30f082016-12-20 21:12:28 +000020#include "llvm/ADT/SetVector.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000021#include "llvm/ADT/SmallPtrSet.h"
22#include "llvm/ADT/SmallVector.h"
23#include "llvm/ADT/StringRef.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000024#include "llvm/Analysis/BlockFrequencyInfo.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000025#include "llvm/Analysis/BranchProbabilityInfo.h"
Teresa Johnsoncd21a642016-07-17 14:47:01 +000026#include "llvm/Analysis/IndirectCallPromotionAnalysis.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000027#include "llvm/Analysis/LoopInfo.h"
Piotr Padlewskid9830eb2016-09-26 20:37:32 +000028#include "llvm/Analysis/ProfileSummaryInfo.h"
Peter Collingbourne1b4137a72016-12-21 23:03:45 +000029#include "llvm/Analysis/TypeMetadataUtils.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000030#include "llvm/IR/Attributes.h"
31#include "llvm/IR/BasicBlock.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000032#include "llvm/IR/CallSite.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000033#include "llvm/IR/Constant.h"
34#include "llvm/IR/Constants.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000035#include "llvm/IR/Dominators.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000036#include "llvm/IR/Function.h"
37#include "llvm/IR/GlobalAlias.h"
38#include "llvm/IR/GlobalValue.h"
39#include "llvm/IR/GlobalVariable.h"
40#include "llvm/IR/Instructions.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000041#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000042#include "llvm/IR/Intrinsics.h"
43#include "llvm/IR/Metadata.h"
44#include "llvm/IR/Module.h"
45#include "llvm/IR/ModuleSummaryIndex.h"
46#include "llvm/IR/Use.h"
47#include "llvm/IR/User.h"
Peter Collingbourne61781ac2017-03-31 00:08:24 +000048#include "llvm/Object/ModuleSymbolTable.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000049#include "llvm/Object/SymbolicFile.h"
Teresa Johnson2d5487c2016-04-11 13:58:45 +000050#include "llvm/Pass.h"
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +000051#include "llvm/Support/Casting.h"
52#include <algorithm>
53#include <cassert>
54#include <cstdint>
55#include <vector>
56
Teresa Johnson2d5487c2016-04-11 13:58:45 +000057using namespace llvm;
58
59#define DEBUG_TYPE "module-summary-analysis"
60
61// Walk through the operands of a given User via worklist iteration and populate
62// the set of GlobalValue references encountered. Invoked either on an
63// Instruction or a GlobalVariable (which walks its initializer).
Peter Collingbourne9667b912017-05-04 18:03:25 +000064static void findRefEdges(ModuleSummaryIndex &Index, const User *CurUser,
65 SetVector<ValueInfo> &RefEdges,
Teresa Johnson2d5487c2016-04-11 13:58:45 +000066 SmallPtrSet<const User *, 8> &Visited) {
67 SmallVector<const User *, 32> Worklist;
68 Worklist.push_back(CurUser);
69
70 while (!Worklist.empty()) {
71 const User *U = Worklist.pop_back_val();
72
73 if (!Visited.insert(U).second)
74 continue;
75
76 ImmutableCallSite CS(U);
77
78 for (const auto &OI : U->operands()) {
79 const User *Operand = dyn_cast<User>(OI);
80 if (!Operand)
81 continue;
82 if (isa<BlockAddress>(Operand))
83 continue;
Peter Collingbourne0c30f082016-12-20 21:12:28 +000084 if (auto *GV = dyn_cast<GlobalValue>(Operand)) {
Teresa Johnson2d5487c2016-04-11 13:58:45 +000085 // We have a reference to a global value. This should be added to
86 // the reference set unless it is a callee. Callees are handled
87 // specially by WriteFunction and are added to a separate list.
88 if (!(CS && CS.isCallee(&OI)))
Peter Collingbourne9667b912017-05-04 18:03:25 +000089 RefEdges.insert(Index.getOrInsertValueInfo(GV));
Teresa Johnson2d5487c2016-04-11 13:58:45 +000090 continue;
91 }
92 Worklist.push_back(Operand);
93 }
94 }
95}
96
Piotr Padlewskid9830eb2016-09-26 20:37:32 +000097static CalleeInfo::HotnessType getHotness(uint64_t ProfileCount,
98 ProfileSummaryInfo *PSI) {
99 if (!PSI)
100 return CalleeInfo::HotnessType::Unknown;
101 if (PSI->isHotCount(ProfileCount))
102 return CalleeInfo::HotnessType::Hot;
103 if (PSI->isColdCount(ProfileCount))
104 return CalleeInfo::HotnessType::Cold;
105 return CalleeInfo::HotnessType::None;
106}
107
Teresa Johnson519465b2017-01-05 14:32:16 +0000108static bool isNonRenamableLocal(const GlobalValue &GV) {
109 return GV.hasSection() && GV.hasLocalLinkage();
110}
111
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +0000112/// Determine whether this call has all constant integer arguments (excluding
113/// "this") and summarize it to VCalls or ConstVCalls as appropriate.
114static void addVCallToSet(DevirtCallSite Call, GlobalValue::GUID Guid,
115 SetVector<FunctionSummary::VFuncId> &VCalls,
116 SetVector<FunctionSummary::ConstVCall> &ConstVCalls) {
117 std::vector<uint64_t> Args;
118 // Start from the second argument to skip the "this" pointer.
119 for (auto &Arg : make_range(Call.CS.arg_begin() + 1, Call.CS.arg_end())) {
120 auto *CI = dyn_cast<ConstantInt>(Arg);
121 if (!CI || CI->getBitWidth() > 64) {
122 VCalls.insert({Guid, Call.Offset});
123 return;
124 }
125 Args.push_back(CI->getZExtValue());
126 }
127 ConstVCalls.insert({{Guid, Call.Offset}, std::move(Args)});
128}
129
130/// If this intrinsic call requires that we add information to the function
131/// summary, do so via the non-constant reference arguments.
132static void addIntrinsicToSummary(
133 const CallInst *CI, SetVector<GlobalValue::GUID> &TypeTests,
134 SetVector<FunctionSummary::VFuncId> &TypeTestAssumeVCalls,
135 SetVector<FunctionSummary::VFuncId> &TypeCheckedLoadVCalls,
136 SetVector<FunctionSummary::ConstVCall> &TypeTestAssumeConstVCalls,
137 SetVector<FunctionSummary::ConstVCall> &TypeCheckedLoadConstVCalls) {
138 switch (CI->getCalledFunction()->getIntrinsicID()) {
139 case Intrinsic::type_test: {
140 auto *TypeMDVal = cast<MetadataAsValue>(CI->getArgOperand(1));
141 auto *TypeId = dyn_cast<MDString>(TypeMDVal->getMetadata());
142 if (!TypeId)
143 break;
144 GlobalValue::GUID Guid = GlobalValue::getGUID(TypeId->getString());
145
146 // Produce a summary from type.test intrinsics. We only summarize type.test
147 // intrinsics that are used other than by an llvm.assume intrinsic.
148 // Intrinsics that are assumed are relevant only to the devirtualization
149 // pass, not the type test lowering pass.
150 bool HasNonAssumeUses = llvm::any_of(CI->uses(), [](const Use &CIU) {
151 auto *AssumeCI = dyn_cast<CallInst>(CIU.getUser());
152 if (!AssumeCI)
153 return true;
154 Function *F = AssumeCI->getCalledFunction();
155 return !F || F->getIntrinsicID() != Intrinsic::assume;
156 });
157 if (HasNonAssumeUses)
158 TypeTests.insert(Guid);
159
160 SmallVector<DevirtCallSite, 4> DevirtCalls;
161 SmallVector<CallInst *, 4> Assumes;
162 findDevirtualizableCallsForTypeTest(DevirtCalls, Assumes, CI);
163 for (auto &Call : DevirtCalls)
164 addVCallToSet(Call, Guid, TypeTestAssumeVCalls,
165 TypeTestAssumeConstVCalls);
166
167 break;
168 }
169
170 case Intrinsic::type_checked_load: {
171 auto *TypeMDVal = cast<MetadataAsValue>(CI->getArgOperand(2));
172 auto *TypeId = dyn_cast<MDString>(TypeMDVal->getMetadata());
173 if (!TypeId)
174 break;
175 GlobalValue::GUID Guid = GlobalValue::getGUID(TypeId->getString());
176
177 SmallVector<DevirtCallSite, 4> DevirtCalls;
178 SmallVector<Instruction *, 4> LoadedPtrs;
179 SmallVector<Instruction *, 4> Preds;
180 bool HasNonCallUses = false;
181 findDevirtualizableCallsForTypeCheckedLoad(DevirtCalls, LoadedPtrs, Preds,
182 HasNonCallUses, CI);
183 // Any non-call uses of the result of llvm.type.checked.load will
184 // prevent us from optimizing away the llvm.type.test.
185 if (HasNonCallUses)
186 TypeTests.insert(Guid);
187 for (auto &Call : DevirtCalls)
188 addVCallToSet(Call, Guid, TypeCheckedLoadVCalls,
189 TypeCheckedLoadConstVCalls);
190
191 break;
192 }
193 default:
194 break;
195 }
196}
197
Teresa Johnson519465b2017-01-05 14:32:16 +0000198static void
199computeFunctionSummary(ModuleSummaryIndex &Index, const Module &M,
200 const Function &F, BlockFrequencyInfo *BFI,
Peter Collingbourne5e8b94c12017-09-01 16:24:02 +0000201 ProfileSummaryInfo *PSI, bool HasLocalsInUsedOrAsm,
Teresa Johnsone27b0582017-01-05 14:59:56 +0000202 DenseSet<GlobalValue::GUID> &CantBePromoted) {
Teresa Johnson02563cd2016-10-28 02:39:38 +0000203 // Summary not currently supported for anonymous functions, they should
204 // have been named.
205 assert(F.hasName());
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000206
207 unsigned NumInsts = 0;
208 // Map from callee ValueId to profile count. Used to accumulate profile
209 // counts for all static calls to a given callee.
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000210 MapVector<ValueInfo, CalleeInfo> CallGraphEdges;
211 SetVector<ValueInfo> RefEdges;
Peter Collingbourne1b4137a72016-12-21 23:03:45 +0000212 SetVector<GlobalValue::GUID> TypeTests;
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +0000213 SetVector<FunctionSummary::VFuncId> TypeTestAssumeVCalls,
214 TypeCheckedLoadVCalls;
215 SetVector<FunctionSummary::ConstVCall> TypeTestAssumeConstVCalls,
216 TypeCheckedLoadConstVCalls;
Teresa Johnsoncd21a642016-07-17 14:47:01 +0000217 ICallPromotionAnalysis ICallAnalysis;
Peter Collingbourne681fbb62017-09-07 05:35:35 +0000218 SmallPtrSet<const User *, 8> Visited;
219
220 // Add personality function, prefix data and prologue data to function's ref
221 // list.
222 findRefEdges(Index, &F, RefEdges, Visited);
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000223
Teresa Johnsond5033a42016-11-14 16:40:19 +0000224 bool HasInlineAsmMaybeReferencingInternal = false;
Benjamin Krameraa209152016-06-26 17:27:42 +0000225 for (const BasicBlock &BB : F)
226 for (const Instruction &I : BB) {
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000227 if (isa<DbgInfoIntrinsic>(I))
228 continue;
229 ++NumInsts;
Peter Collingbourne9667b912017-05-04 18:03:25 +0000230 findRefEdges(Index, &I, RefEdges, Visited);
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000231 auto CS = ImmutableCallSite(&I);
232 if (!CS)
233 continue;
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000234
235 const auto *CI = dyn_cast<CallInst>(&I);
236 // Since we don't know exactly which local values are referenced in inline
Teresa Johnsond5033a42016-11-14 16:40:19 +0000237 // assembly, conservatively mark the function as possibly referencing
238 // a local value from inline assembly to ensure we don't export a
239 // reference (which would require renaming and promotion of the
240 // referenced value).
Peter Collingbourne5e8b94c12017-09-01 16:24:02 +0000241 if (HasLocalsInUsedOrAsm && CI && CI->isInlineAsm())
Teresa Johnsond5033a42016-11-14 16:40:19 +0000242 HasInlineAsmMaybeReferencingInternal = true;
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000243
Teresa Johnson897bab92016-10-08 16:11:42 +0000244 auto *CalledValue = CS.getCalledValue();
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000245 auto *CalledFunction = CS.getCalledFunction();
Teresa Johnson897bab92016-10-08 16:11:42 +0000246 // Check if this is an alias to a function. If so, get the
247 // called aliasee for the checks below.
248 if (auto *GA = dyn_cast<GlobalAlias>(CalledValue)) {
249 assert(!CalledFunction && "Expected null called function in callsite for alias");
250 CalledFunction = dyn_cast<Function>(GA->getBaseObject());
251 }
Peter Collingbourne1b4137a72016-12-21 23:03:45 +0000252 // Check if this is a direct call to a known function or a known
253 // intrinsic, or an indirect call with profile data.
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000254 if (CalledFunction) {
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +0000255 if (CI && CalledFunction->isIntrinsic()) {
256 addIntrinsicToSummary(
257 CI, TypeTests, TypeTestAssumeVCalls, TypeCheckedLoadVCalls,
258 TypeTestAssumeConstVCalls, TypeCheckedLoadConstVCalls);
259 continue;
Peter Collingbourne1b4137a72016-12-21 23:03:45 +0000260 }
Teresa Johnson02563cd2016-10-28 02:39:38 +0000261 // We should have named any anonymous globals
262 assert(CalledFunction->hasName());
Easwaran Ramanf5f91602017-05-09 23:21:10 +0000263 auto ScaledCount = PSI->getProfileCount(&I, BFI);
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000264 auto Hotness = ScaledCount ? getHotness(ScaledCount.getValue(), PSI)
265 : CalleeInfo::HotnessType::Unknown;
266
Teresa Johnson897bab92016-10-08 16:11:42 +0000267 // Use the original CalledValue, in case it was an alias. We want
268 // to record the call edge to the alias in that case. Eventually
269 // an alias summary will be created to associate the alias and
270 // aliasee.
Peter Collingbourne9667b912017-05-04 18:03:25 +0000271 CallGraphEdges[Index.getOrInsertValueInfo(
272 cast<GlobalValue>(CalledValue))]
273 .updateHotness(Hotness);
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000274 } else {
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000275 // Skip inline assembly calls.
276 if (CI && CI->isInlineAsm())
277 continue;
278 // Skip direct calls.
279 if (!CS.getCalledValue() || isa<Constant>(CS.getCalledValue()))
280 continue;
281
282 uint32_t NumVals, NumCandidates;
283 uint64_t TotalCount;
284 auto CandidateProfileData =
285 ICallAnalysis.getPromotionCandidatesForInstruction(
286 &I, NumVals, TotalCount, NumCandidates);
287 for (auto &Candidate : CandidateProfileData)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000288 CallGraphEdges[Index.getOrInsertValueInfo(Candidate.Value)]
289 .updateHotness(getHotness(Candidate.Count, PSI));
Piotr Padlewski442d38c2016-08-30 00:46:26 +0000290 }
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000291 }
292
Dehao Chena60cdd32017-02-28 18:09:44 +0000293 // Explicit add hot edges to enforce importing for designated GUIDs for
294 // sample PGO, to enable the same inlines as the profiled optimized binary.
295 for (auto &I : F.getImportGUIDs())
Peter Collingbourne9667b912017-05-04 18:03:25 +0000296 CallGraphEdges[Index.getOrInsertValueInfo(I)].updateHotness(
Dehao Chen64c46572017-07-07 21:01:00 +0000297 CalleeInfo::HotnessType::Critical);
Dehao Chena60cdd32017-02-28 18:09:44 +0000298
Teresa Johnson519465b2017-01-05 14:32:16 +0000299 bool NonRenamableLocal = isNonRenamableLocal(F);
300 bool NotEligibleForImport =
301 NonRenamableLocal || HasInlineAsmMaybeReferencingInternal ||
302 // Inliner doesn't handle variadic functions.
303 // FIXME: refactor this to use the same code that inliner is using.
304 F.isVarArg();
Teresa Johnson6c475a72017-01-05 21:34:18 +0000305 GlobalValueSummary::GVFlags Flags(F.getLinkage(), NotEligibleForImport,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +0000306 /* Live = */ false);
Charles Saternos75da10d2017-08-04 16:00:58 +0000307 FunctionSummary::FFlags FunFlags{
308 F.hasFnAttribute(Attribute::ReadNone),
309 F.hasFnAttribute(Attribute::ReadOnly),
310 F.hasFnAttribute(Attribute::NoRecurse),
311 F.returnDoesNotAlias(),
312 };
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000313 auto FuncSummary = llvm::make_unique<FunctionSummary>(
Charles Saternos75da10d2017-08-04 16:00:58 +0000314 Flags, NumInsts, FunFlags, RefEdges.takeVector(),
315 CallGraphEdges.takeVector(), TypeTests.takeVector(),
316 TypeTestAssumeVCalls.takeVector(), TypeCheckedLoadVCalls.takeVector(),
Peter Collingbournebe9ffaa2017-02-10 22:29:38 +0000317 TypeTestAssumeConstVCalls.takeVector(),
318 TypeCheckedLoadConstVCalls.takeVector());
Teresa Johnson519465b2017-01-05 14:32:16 +0000319 if (NonRenamableLocal)
320 CantBePromoted.insert(F.getGUID());
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000321 Index.addGlobalValueSummary(F.getName(), std::move(FuncSummary));
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000322}
323
Teresa Johnson519465b2017-01-05 14:32:16 +0000324static void
325computeVariableSummary(ModuleSummaryIndex &Index, const GlobalVariable &V,
Teresa Johnsone27b0582017-01-05 14:59:56 +0000326 DenseSet<GlobalValue::GUID> &CantBePromoted) {
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000327 SetVector<ValueInfo> RefEdges;
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000328 SmallPtrSet<const User *, 8> Visited;
Peter Collingbourne9667b912017-05-04 18:03:25 +0000329 findRefEdges(Index, &V, RefEdges, Visited);
Teresa Johnson519465b2017-01-05 14:32:16 +0000330 bool NonRenamableLocal = isNonRenamableLocal(V);
Teresa Johnson6c475a72017-01-05 21:34:18 +0000331 GlobalValueSummary::GVFlags Flags(V.getLinkage(), NonRenamableLocal,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +0000332 /* Live = */ false);
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000333 auto GVarSummary =
334 llvm::make_unique<GlobalVarSummary>(Flags, RefEdges.takeVector());
Teresa Johnson519465b2017-01-05 14:32:16 +0000335 if (NonRenamableLocal)
336 CantBePromoted.insert(V.getGUID());
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000337 Index.addGlobalValueSummary(V.getName(), std::move(GVarSummary));
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000338}
339
Teresa Johnson519465b2017-01-05 14:32:16 +0000340static void
341computeAliasSummary(ModuleSummaryIndex &Index, const GlobalAlias &A,
Teresa Johnsone27b0582017-01-05 14:59:56 +0000342 DenseSet<GlobalValue::GUID> &CantBePromoted) {
Teresa Johnson519465b2017-01-05 14:32:16 +0000343 bool NonRenamableLocal = isNonRenamableLocal(A);
Teresa Johnson6c475a72017-01-05 21:34:18 +0000344 GlobalValueSummary::GVFlags Flags(A.getLinkage(), NonRenamableLocal,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +0000345 /* Live = */ false);
Peter Collingbourne0c30f082016-12-20 21:12:28 +0000346 auto AS = llvm::make_unique<AliasSummary>(Flags, ArrayRef<ValueInfo>{});
Teresa Johnson02563cd2016-10-28 02:39:38 +0000347 auto *Aliasee = A.getBaseObject();
348 auto *AliaseeSummary = Index.getGlobalValueSummary(*Aliasee);
349 assert(AliaseeSummary && "Alias expects aliasee summary to be parsed");
350 AS->setAliasee(AliaseeSummary);
Teresa Johnson519465b2017-01-05 14:32:16 +0000351 if (NonRenamableLocal)
352 CantBePromoted.insert(A.getGUID());
Teresa Johnson02563cd2016-10-28 02:39:38 +0000353 Index.addGlobalValueSummary(A.getName(), std::move(AS));
354}
355
Teresa Johnson6c475a72017-01-05 21:34:18 +0000356// Set LiveRoot flag on entries matching the given value name.
357static void setLiveRoot(ModuleSummaryIndex &Index, StringRef Name) {
Peter Collingbourne9667b912017-05-04 18:03:25 +0000358 if (ValueInfo VI = Index.getValueInfo(GlobalValue::getGUID(Name)))
359 for (auto &Summary : VI.getSummaryList())
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +0000360 Summary->setLive(true);
Teresa Johnson6c475a72017-01-05 21:34:18 +0000361}
362
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000363ModuleSummaryIndex llvm::buildModuleSummaryIndex(
364 const Module &M,
Piotr Padlewskid9830eb2016-09-26 20:37:32 +0000365 std::function<BlockFrequencyInfo *(const Function &F)> GetBFICallback,
366 ProfileSummaryInfo *PSI) {
Teresa Johnson94624ac2017-05-10 18:52:16 +0000367 assert(PSI);
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000368 ModuleSummaryIndex Index;
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000369
Teresa Johnsona0811452016-11-10 16:57:32 +0000370 // Identify the local values in the llvm.used and llvm.compiler.used sets,
371 // which should not be exported as they would then require renaming and
372 // promotion, but we may have opaque uses e.g. in inline asm. We collect them
373 // here because we use this information to mark functions containing inline
374 // assembly calls as not importable.
Mehdi Aminib6a11a72016-11-09 01:45:13 +0000375 SmallPtrSet<GlobalValue *, 8> LocalsUsed;
Teresa Johnsona0811452016-11-10 16:57:32 +0000376 SmallPtrSet<GlobalValue *, 8> Used;
377 // First collect those in the llvm.used set.
378 collectUsedGlobalVariables(M, Used, /*CompilerUsed*/ false);
Teresa Johnsona0811452016-11-10 16:57:32 +0000379 // Next collect those in the llvm.compiler.used set.
380 collectUsedGlobalVariables(M, Used, /*CompilerUsed*/ true);
Teresa Johnsone27b0582017-01-05 14:59:56 +0000381 DenseSet<GlobalValue::GUID> CantBePromoted;
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000382 for (auto *V : Used) {
Teresa Johnson519465b2017-01-05 14:32:16 +0000383 if (V->hasLocalLinkage()) {
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000384 LocalsUsed.insert(V);
Teresa Johnson519465b2017-01-05 14:32:16 +0000385 CantBePromoted.insert(V->getGUID());
386 }
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000387 }
Teresa Johnsonb35cc692016-04-20 14:39:45 +0000388
Peter Collingbourne5e8b94c12017-09-01 16:24:02 +0000389 bool HasLocalInlineAsmSymbol = false;
390 if (!M.getModuleInlineAsm().empty()) {
391 // Collect the local values defined by module level asm, and set up
392 // summaries for these symbols so that they can be marked as NoRename,
393 // to prevent export of any use of them in regular IR that would require
394 // renaming within the module level asm. Note we don't need to create a
395 // summary for weak or global defs, as they don't need to be flagged as
396 // NoRename, and defs in module level asm can't be imported anyway.
397 // Also, any values used but not defined within module level asm should
398 // be listed on the llvm.used or llvm.compiler.used global and marked as
399 // referenced from there.
400 ModuleSymbolTable::CollectAsmSymbols(
401 M, [&](StringRef Name, object::BasicSymbolRef::Flags Flags) {
402 // Symbols not marked as Weak or Global are local definitions.
403 if (Flags & (object::BasicSymbolRef::SF_Weak |
404 object::BasicSymbolRef::SF_Global))
405 return;
406 HasLocalInlineAsmSymbol = true;
407 GlobalValue *GV = M.getNamedValue(Name);
408 if (!GV)
409 return;
410 assert(GV->isDeclaration() && "Def in module asm already has definition");
411 GlobalValueSummary::GVFlags GVFlags(GlobalValue::InternalLinkage,
412 /* NotEligibleToImport = */ true,
413 /* Live = */ true);
414 CantBePromoted.insert(GlobalValue::getGUID(Name));
415 // Create the appropriate summary type.
416 if (Function *F = dyn_cast<Function>(GV)) {
417 std::unique_ptr<FunctionSummary> Summary =
418 llvm::make_unique<FunctionSummary>(
419 GVFlags, 0,
420 FunctionSummary::FFlags{
421 F->hasFnAttribute(Attribute::ReadNone),
422 F->hasFnAttribute(Attribute::ReadOnly),
423 F->hasFnAttribute(Attribute::NoRecurse),
424 F->returnDoesNotAlias()},
425 ArrayRef<ValueInfo>{}, ArrayRef<FunctionSummary::EdgeTy>{},
426 ArrayRef<GlobalValue::GUID>{},
427 ArrayRef<FunctionSummary::VFuncId>{},
428 ArrayRef<FunctionSummary::VFuncId>{},
429 ArrayRef<FunctionSummary::ConstVCall>{},
430 ArrayRef<FunctionSummary::ConstVCall>{});
431 Index.addGlobalValueSummary(Name, std::move(Summary));
432 } else {
433 std::unique_ptr<GlobalVarSummary> Summary =
434 llvm::make_unique<GlobalVarSummary>(GVFlags,
435 ArrayRef<ValueInfo>{});
436 Index.addGlobalValueSummary(Name, std::move(Summary));
437 }
438 });
439 }
440
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000441 // Compute summaries for all functions defined in module, and save in the
442 // index.
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000443 for (auto &F : M) {
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000444 if (F.isDeclaration())
445 continue;
446
447 BlockFrequencyInfo *BFI = nullptr;
448 std::unique_ptr<BlockFrequencyInfo> BFIPtr;
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000449 if (GetBFICallback)
450 BFI = GetBFICallback(F);
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000451 else if (F.getEntryCount().hasValue()) {
452 LoopInfo LI{DominatorTree(const_cast<Function &>(F))};
453 BranchProbabilityInfo BPI{F, LI};
454 BFIPtr = llvm::make_unique<BlockFrequencyInfo>(F, BPI, LI);
455 BFI = BFIPtr.get();
456 }
457
Peter Collingbourne5e8b94c12017-09-01 16:24:02 +0000458 computeFunctionSummary(Index, M, F, BFI, PSI,
459 !LocalsUsed.empty() || HasLocalInlineAsmSymbol,
Teresa Johnson519465b2017-01-05 14:32:16 +0000460 CantBePromoted);
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000461 }
462
463 // Compute summaries for all variables defined in module, and save in the
464 // index.
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000465 for (const GlobalVariable &G : M.globals()) {
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000466 if (G.isDeclaration())
467 continue;
Teresa Johnson519465b2017-01-05 14:32:16 +0000468 computeVariableSummary(Index, G, CantBePromoted);
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000469 }
Teresa Johnson02563cd2016-10-28 02:39:38 +0000470
471 // Compute summaries for all aliases defined in module, and save in the
472 // index.
473 for (const GlobalAlias &A : M.aliases())
Teresa Johnson519465b2017-01-05 14:32:16 +0000474 computeAliasSummary(Index, A, CantBePromoted);
Teresa Johnson02563cd2016-10-28 02:39:38 +0000475
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000476 for (auto *V : LocalsUsed) {
477 auto *Summary = Index.getGlobalValueSummary(*V);
478 assert(Summary && "Missing summary for global value");
Teresa Johnson519465b2017-01-05 14:32:16 +0000479 Summary->setNotEligibleToImport();
Teresa Johnsonbf28c8f2016-10-30 05:40:44 +0000480 }
481
Teresa Johnson6c475a72017-01-05 21:34:18 +0000482 // The linker doesn't know about these LLVM produced values, so we need
483 // to flag them as live in the index to ensure index-based dead value
484 // analysis treats them as live roots of the analysis.
485 setLiveRoot(Index, "llvm.used");
486 setLiveRoot(Index, "llvm.compiler.used");
487 setLiveRoot(Index, "llvm.global_ctors");
488 setLiveRoot(Index, "llvm.global_dtors");
489 setLiveRoot(Index, "llvm.global.annotations");
490
Peter Collingbournee357fbd2017-06-08 23:01:49 +0000491 bool IsThinLTO = true;
492 if (auto *MD =
493 mdconst::extract_or_null<ConstantInt>(M.getModuleFlag("ThinLTO")))
494 IsThinLTO = MD->getZExtValue();
495
Teresa Johnson519465b2017-01-05 14:32:16 +0000496 for (auto &GlobalList : Index) {
Peter Collingbourne9667b912017-05-04 18:03:25 +0000497 // Ignore entries for references that are undefined in the current module.
498 if (GlobalList.second.SummaryList.empty())
499 continue;
500
501 assert(GlobalList.second.SummaryList.size() == 1 &&
Teresa Johnson519465b2017-01-05 14:32:16 +0000502 "Expected module's index to have one summary per GUID");
Peter Collingbourne9667b912017-05-04 18:03:25 +0000503 auto &Summary = GlobalList.second.SummaryList[0];
Peter Collingbournee357fbd2017-06-08 23:01:49 +0000504 if (!IsThinLTO) {
505 Summary->setNotEligibleToImport();
506 continue;
507 }
508
Teresa Johnson519465b2017-01-05 14:32:16 +0000509 bool AllRefsCanBeExternallyReferenced =
510 llvm::all_of(Summary->refs(), [&](const ValueInfo &VI) {
Peter Collingbourne9667b912017-05-04 18:03:25 +0000511 return !CantBePromoted.count(VI.getGUID());
Teresa Johnson519465b2017-01-05 14:32:16 +0000512 });
513 if (!AllRefsCanBeExternallyReferenced) {
514 Summary->setNotEligibleToImport();
515 continue;
516 }
517
518 if (auto *FuncSummary = dyn_cast<FunctionSummary>(Summary.get())) {
519 bool AllCallsCanBeExternallyReferenced = llvm::all_of(
520 FuncSummary->calls(), [&](const FunctionSummary::EdgeTy &Edge) {
Peter Collingbourne9667b912017-05-04 18:03:25 +0000521 return !CantBePromoted.count(Edge.first.getGUID());
Teresa Johnson519465b2017-01-05 14:32:16 +0000522 });
523 if (!AllCallsCanBeExternallyReferenced)
524 Summary->setNotEligibleToImport();
525 }
526 }
527
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000528 return Index;
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000529}
530
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000531AnalysisKey ModuleSummaryIndexAnalysis::Key;
Teresa Johnsonf93b2462016-08-12 13:53:02 +0000532
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000533ModuleSummaryIndex
Teresa Johnsonf93b2462016-08-12 13:53:02 +0000534ModuleSummaryIndexAnalysis::run(Module &M, ModuleAnalysisManager &AM) {
Piotr Padlewskid9830eb2016-09-26 20:37:32 +0000535 ProfileSummaryInfo &PSI = AM.getResult<ProfileSummaryAnalysis>(M);
Teresa Johnsonf93b2462016-08-12 13:53:02 +0000536 auto &FAM = AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
Piotr Padlewskid9830eb2016-09-26 20:37:32 +0000537 return buildModuleSummaryIndex(
538 M,
539 [&FAM](const Function &F) {
540 return &FAM.getResult<BlockFrequencyAnalysis>(
541 *const_cast<Function *>(&F));
542 },
543 &PSI);
Teresa Johnsonf93b2462016-08-12 13:53:02 +0000544}
545
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000546char ModuleSummaryIndexWrapperPass::ID = 0;
Eugene Zelenkobb1b2d02017-08-16 22:07:40 +0000547
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000548INITIALIZE_PASS_BEGIN(ModuleSummaryIndexWrapperPass, "module-summary-analysis",
549 "Module Summary Analysis", false, true)
550INITIALIZE_PASS_DEPENDENCY(BlockFrequencyInfoWrapperPass)
Mehdi Amini89029482017-01-21 06:01:22 +0000551INITIALIZE_PASS_DEPENDENCY(ProfileSummaryInfoWrapperPass)
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000552INITIALIZE_PASS_END(ModuleSummaryIndexWrapperPass, "module-summary-analysis",
553 "Module Summary Analysis", false, true)
554
555ModulePass *llvm::createModuleSummaryIndexWrapperPass() {
556 return new ModuleSummaryIndexWrapperPass();
557}
558
559ModuleSummaryIndexWrapperPass::ModuleSummaryIndexWrapperPass()
560 : ModulePass(ID) {
561 initializeModuleSummaryIndexWrapperPassPass(*PassRegistry::getPassRegistry());
562}
563
564bool ModuleSummaryIndexWrapperPass::runOnModule(Module &M) {
Dehao Chen5461d8b2016-09-28 21:00:58 +0000565 auto &PSI = *getAnalysis<ProfileSummaryInfoWrapperPass>().getPSI();
Piotr Padlewskid9830eb2016-09-26 20:37:32 +0000566 Index = buildModuleSummaryIndex(
567 M,
568 [this](const Function &F) {
569 return &(this->getAnalysis<BlockFrequencyInfoWrapperPass>(
570 *const_cast<Function *>(&F))
571 .getBFI());
572 },
573 &PSI);
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000574 return false;
575}
576
577bool ModuleSummaryIndexWrapperPass::doFinalization(Module &M) {
Chandler Carruthb7be5b62016-08-19 07:49:19 +0000578 Index.reset();
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000579 return false;
580}
581
582void ModuleSummaryIndexWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
583 AU.setPreservesAll();
584 AU.addRequired<BlockFrequencyInfoWrapperPass>();
Piotr Padlewskid9830eb2016-09-26 20:37:32 +0000585 AU.addRequired<ProfileSummaryInfoWrapperPass>();
Teresa Johnson2d5487c2016-04-11 13:58:45 +0000586}