blob: f2211edba216149d910d9661084535602e992269 [file] [log] [blame]
Chris Lattnerf7e95942003-08-31 01:54:59 +00001//===- CallGraphSCCPass.cpp - Pass that operates BU on call graph ---------===//
Misha Brukman01808ca2005-04-21 21:13:18 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman01808ca2005-04-21 21:13:18 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerf7e95942003-08-31 01:54:59 +00009//
10// This file implements the CallGraphSCCPass class, which is used for passes
11// which are implemented as bottom-up traversals on the call graph. Because
12// there may be cycles in the call graph, passes of this type operate on the
13// call-graph in SCC order: that is, they process function bottom-up, except for
14// recursive functions, which they process all at once.
15//
16//===----------------------------------------------------------------------===//
17
Chandler Carruth839a98e2013-01-07 15:26:48 +000018#include "llvm/Analysis/CallGraphSCCPass.h"
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000019#include "llvm/ADT/DenseMap.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000020#include "llvm/ADT/SCCIterator.h"
Chris Lattner6fbe7042010-04-21 00:47:40 +000021#include "llvm/ADT/Statistic.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000022#include "llvm/Analysis/CallGraph.h"
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000023#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/Function.h"
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000025#include "llvm/IR/Intrinsics.h"
Juergen Ributzka34390c72014-05-16 02:33:15 +000026#include "llvm/IR/LLVMContext.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000027#include "llvm/IR/LegacyPassManagers.h"
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000028#include "llvm/IR/Module.h"
Andrew Kayloraa641a52016-04-22 22:06:11 +000029#include "llvm/IR/OptBisect.h"
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000030#include "llvm/Pass.h"
Chris Lattner6fbe7042010-04-21 00:47:40 +000031#include "llvm/Support/CommandLine.h"
Chris Lattnereedcd842009-08-31 07:23:46 +000032#include "llvm/Support/Debug.h"
Chris Lattner707431c2010-03-30 04:03:22 +000033#include "llvm/Support/Timer.h"
Chris Lattner13626022009-08-23 06:03:38 +000034#include "llvm/Support/raw_ostream.h"
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000035#include <cassert>
36#include <string>
37#include <utility>
38#include <vector>
39
Chris Lattner8d083812004-04-20 21:30:06 +000040using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000041
Chandler Carruthf1221bd2014-04-22 02:48:03 +000042#define DEBUG_TYPE "cgscc-passmgr"
43
Chris Lattner6fbe7042010-04-21 00:47:40 +000044static cl::opt<unsigned>
Chris Lattnerfc8d9ee2010-05-01 01:15:56 +000045MaxIterations("max-cg-scc-iterations", cl::ReallyHidden, cl::init(4));
Chris Lattner6fbe7042010-04-21 00:47:40 +000046
47STATISTIC(MaxSCCIterations, "Maximum CGSCCPassMgr iterations on one SCC");
48
Devang Patel48537a02007-01-17 21:45:01 +000049//===----------------------------------------------------------------------===//
50// CGPassManager
51//
Dale Johannesen50f03762009-09-10 22:01:32 +000052/// CGPassManager manages FPPassManagers and CallGraphSCCPasses.
Devang Patel48537a02007-01-17 21:45:01 +000053
Dan Gohmand78c4002008-05-13 00:00:25 +000054namespace {
55
Devang Patel48537a02007-01-17 21:45:01 +000056class CGPassManager : public ModulePass, public PMDataManager {
Devang Patel48537a02007-01-17 21:45:01 +000057public:
Devang Patel8c78a0b2007-05-03 01:11:54 +000058 static char ID;
Eugene Zelenkofa6434b2017-08-31 21:56:16 +000059
60 explicit CGPassManager() : ModulePass(ID), PMDataManager() {}
Devang Patel48537a02007-01-17 21:45:01 +000061
Sanjay Pateld45a3f12015-03-10 03:48:14 +000062 /// Execute all of the passes scheduled for execution. Keep track of
Devang Patel48537a02007-01-17 21:45:01 +000063 /// whether any of the passes modifies the module, and if so, return true.
Craig Toppere9ba7592014-03-05 07:30:04 +000064 bool runOnModule(Module &M) override;
Devang Patel48537a02007-01-17 21:45:01 +000065
Owen Anderson1aa27512012-11-15 00:14:15 +000066 using ModulePass::doInitialization;
67 using ModulePass::doFinalization;
68
Bill Wendling5f14a012009-02-11 18:19:24 +000069 bool doInitialization(CallGraph &CG);
70 bool doFinalization(CallGraph &CG);
Devang Patel48537a02007-01-17 21:45:01 +000071
72 /// Pass Manager itself does not invalidate any analysis info.
Craig Toppere9ba7592014-03-05 07:30:04 +000073 void getAnalysisUsage(AnalysisUsage &Info) const override {
Devang Patel48537a02007-01-17 21:45:01 +000074 // CGPassManager walks SCC and it needs CallGraph.
Chandler Carruth6378cf52013-11-26 04:19:30 +000075 Info.addRequired<CallGraphWrapperPass>();
Devang Patel48537a02007-01-17 21:45:01 +000076 Info.setPreservesAll();
77 }
78
Mehdi Amini117296c2016-10-01 02:56:57 +000079 StringRef getPassName() const override { return "CallGraph Pass Manager"; }
Devang Patelf7fea8a2007-02-01 22:09:37 +000080
Craig Toppere9ba7592014-03-05 07:30:04 +000081 PMDataManager *getAsPMDataManager() override { return this; }
82 Pass *getAsPass() override { return this; }
Chris Lattner2fa26e52010-01-22 05:24:46 +000083
Devang Patel48537a02007-01-17 21:45:01 +000084 // Print passes managed by this manager
Craig Toppere9ba7592014-03-05 07:30:04 +000085 void dumpPassStructure(unsigned Offset) override {
David Greene3d646312009-12-23 23:09:39 +000086 errs().indent(Offset*2) << "Call Graph SCC Pass Manager\n";
Devang Patel48537a02007-01-17 21:45:01 +000087 for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
88 Pass *P = getContainedPass(Index);
Dan Gohmanf71c5212010-08-19 01:29:07 +000089 P->dumpPassStructure(Offset + 1);
Devang Patel48537a02007-01-17 21:45:01 +000090 dumpLastUses(P, Offset+1);
91 }
92 }
93
94 Pass *getContainedPass(unsigned N) {
Chris Lattner13626022009-08-23 06:03:38 +000095 assert(N < PassVector.size() && "Pass number out of range!");
96 return static_cast<Pass *>(PassVector[N]);
Devang Patel48537a02007-01-17 21:45:01 +000097 }
98
Craig Toppere9ba7592014-03-05 07:30:04 +000099 PassManagerType getPassManagerType() const override {
Devang Patel48537a02007-01-17 21:45:01 +0000100 return PMT_CallGraphPassManager;
101 }
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000102
103private:
Chris Lattner6fbe7042010-04-21 00:47:40 +0000104 bool RunAllPassesOnSCC(CallGraphSCC &CurSCC, CallGraph &CG,
105 bool &DevirtualizedCall);
106
Chris Lattner4422d312010-04-16 22:42:17 +0000107 bool RunPassOnSCC(Pass *P, CallGraphSCC &CurSCC,
Chris Lattner6fbe7042010-04-21 00:47:40 +0000108 CallGraph &CG, bool &CallGraphUpToDate,
109 bool &DevirtualizedCall);
Mehdi Aminic137c282016-08-08 18:51:05 +0000110 bool RefreshCallGraph(const CallGraphSCC &CurSCC, CallGraph &CG,
Chris Lattnere33167a2009-09-01 18:32:03 +0000111 bool IsCheckingMode);
Devang Patel48537a02007-01-17 21:45:01 +0000112};
113
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000114} // end anonymous namespace.
Dan Gohmand78c4002008-05-13 00:00:25 +0000115
Devang Patel8c78a0b2007-05-03 01:11:54 +0000116char CGPassManager::ID = 0;
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000117
Chris Lattner4422d312010-04-16 22:42:17 +0000118bool CGPassManager::RunPassOnSCC(Pass *P, CallGraphSCC &CurSCC,
Chris Lattner6fbe7042010-04-21 00:47:40 +0000119 CallGraph &CG, bool &CallGraphUpToDate,
120 bool &DevirtualizedCall) {
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000121 bool Changed = false;
Chris Lattner0b1c7232010-01-22 05:46:59 +0000122 PMDataManager *PM = P->getAsPMDataManager();
Jessica Paquettee49374d2018-05-18 17:26:39 +0000123 Module &M = CG.getModule();
Chris Lattner0b1c7232010-01-22 05:46:59 +0000124
Craig Topper353eda42014-04-24 06:44:33 +0000125 if (!PM) {
Chris Lattner0b1c7232010-01-22 05:46:59 +0000126 CallGraphSCCPass *CGSP = (CallGraphSCCPass*)P;
Chris Lattnereedcd842009-08-31 07:23:46 +0000127 if (!CallGraphUpToDate) {
Chris Lattner6fbe7042010-04-21 00:47:40 +0000128 DevirtualizedCall |= RefreshCallGraph(CurSCC, CG, false);
Chris Lattnereedcd842009-08-31 07:23:46 +0000129 CallGraphUpToDate = true;
130 }
Chris Lattner339c82d2009-09-01 20:33:43 +0000131
Chris Lattner707431c2010-03-30 04:03:22 +0000132 {
Xin Tong023e25a2018-07-22 05:27:41 +0000133 unsigned InstrCount = 0;
134 bool EmitICRemark = M.shouldEmitInstrCountChangedRemark();
Chris Lattner707431c2010-03-30 04:03:22 +0000135 TimeRegion PassTimer(getPassTimer(CGSP));
Xin Tong023e25a2018-07-22 05:27:41 +0000136 if (EmitICRemark)
137 InstrCount = initSizeRemarkInfo(M);
Chris Lattner707431c2010-03-30 04:03:22 +0000138 Changed = CGSP->runOnSCC(CurSCC);
Jessica Paquettee49374d2018-05-18 17:26:39 +0000139
140 // If the pass modified the module, it may have modified the instruction
141 // count of the module. Try emitting a remark.
Xin Tong023e25a2018-07-22 05:27:41 +0000142 if (EmitICRemark)
143 emitInstrCountChangedRemark(P, M, InstrCount);
Chris Lattner707431c2010-03-30 04:03:22 +0000144 }
Chris Lattnere33167a2009-09-01 18:32:03 +0000145
146 // After the CGSCCPass is done, when assertions are enabled, use
147 // RefreshCallGraph to verify that the callgraph was correctly updated.
148#ifndef NDEBUG
149 if (Changed)
150 RefreshCallGraph(CurSCC, CG, true);
151#endif
152
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000153 return Changed;
154 }
155
Chris Lattner0b1c7232010-01-22 05:46:59 +0000156 assert(PM->getPassManagerType() == PMT_FunctionPassManager &&
157 "Invalid CGPassManager member");
158 FPPassManager *FPP = (FPPassManager*)P;
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000159
160 // Run pass P on all functions in the current SCC.
Sanjay Patelc6012542015-03-10 03:26:39 +0000161 for (CallGraphNode *CGN : CurSCC) {
162 if (Function *F = CGN->getFunction()) {
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000163 dumpPassInfo(P, EXECUTION_MSG, ON_FUNCTION_MSG, F->getName());
Juergen Ributzka34390c72014-05-16 02:33:15 +0000164 {
165 TimeRegion PassTimer(getPassTimer(FPP));
166 Changed |= FPP->runOnFunction(*F);
167 }
168 F->getContext().yield();
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000169 }
170 }
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000171
Chris Lattnera9262bb2009-08-31 17:08:30 +0000172 // The function pass(es) modified the IR, they may have clobbered the
Chris Lattnereedcd842009-08-31 07:23:46 +0000173 // callgraph.
174 if (Changed && CallGraphUpToDate) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000175 LLVM_DEBUG(dbgs() << "CGSCCPASSMGR: Pass Dirtied SCC: " << P->getPassName()
176 << '\n');
Chris Lattnereedcd842009-08-31 07:23:46 +0000177 CallGraphUpToDate = false;
178 }
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000179 return Changed;
180}
181
Sanjay Pateld45a3f12015-03-10 03:48:14 +0000182/// Scan the functions in the specified CFG and resync the
Chris Lattnere33167a2009-09-01 18:32:03 +0000183/// callgraph with the call sites found in it. This is used after
184/// FunctionPasses have potentially munged the callgraph, and can be used after
185/// CallGraphSCC passes to verify that they correctly updated the callgraph.
186///
Chris Lattner6fbe7042010-04-21 00:47:40 +0000187/// This function returns true if it devirtualized an existing function call,
188/// meaning it turned an indirect call into a direct call. This happens when
189/// a function pass like GVN optimizes away stuff feeding the indirect call.
190/// This never happens in checking mode.
Mehdi Aminic137c282016-08-08 18:51:05 +0000191bool CGPassManager::RefreshCallGraph(const CallGraphSCC &CurSCC, CallGraph &CG,
192 bool CheckingMode) {
Chris Lattner063d0652009-09-01 06:31:31 +0000193 DenseMap<Value*, CallGraphNode*> CallSites;
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000194
195 LLVM_DEBUG(dbgs() << "CGSCCPASSMGR: Refreshing SCC with " << CurSCC.size()
196 << " nodes:\n";
197 for (CallGraphNode *CGN
198 : CurSCC) CGN->dump(););
Chris Lattnereedcd842009-08-31 07:23:46 +0000199
200 bool MadeChange = false;
Chris Lattner6fbe7042010-04-21 00:47:40 +0000201 bool DevirtualizedCall = false;
Chris Lattnereedcd842009-08-31 07:23:46 +0000202
203 // Scan all functions in the SCC.
Chris Lattner4422d312010-04-16 22:42:17 +0000204 unsigned FunctionNo = 0;
205 for (CallGraphSCC::iterator SCCIdx = CurSCC.begin(), E = CurSCC.end();
206 SCCIdx != E; ++SCCIdx, ++FunctionNo) {
207 CallGraphNode *CGN = *SCCIdx;
Chris Lattnereedcd842009-08-31 07:23:46 +0000208 Function *F = CGN->getFunction();
Craig Topper353eda42014-04-24 06:44:33 +0000209 if (!F || F->isDeclaration()) continue;
Chris Lattnereedcd842009-08-31 07:23:46 +0000210
211 // Walk the function body looking for call sites. Sync up the call sites in
212 // CGN with those actually in the function.
Chris Lattner532112b2010-05-01 06:38:43 +0000213
214 // Keep track of the number of direct and indirect calls that were
215 // invalidated and removed.
216 unsigned NumDirectRemoved = 0, NumIndirectRemoved = 0;
Chris Lattner3f7b3d12009-09-01 18:13:40 +0000217
Chris Lattnereedcd842009-08-31 07:23:46 +0000218 // Get the set of call sites currently in the function.
Duncan Sands5632d962009-09-02 03:48:41 +0000219 for (CallGraphNode::iterator I = CGN->begin(), E = CGN->end(); I != E; ) {
Chris Lattner063d0652009-09-01 06:31:31 +0000220 // If this call site is null, then the function pass deleted the call
Sanjoy Dase6bca0e2017-05-01 17:07:49 +0000221 // entirely and the WeakTrackingVH nulled it out.
Craig Topper353eda42014-04-24 06:44:33 +0000222 if (!I->first ||
Chris Lattner063d0652009-09-01 06:31:31 +0000223 // If we've already seen this call site, then the FunctionPass RAUW'd
224 // one call with another, which resulted in two "uses" in the edge
225 // list of the same call.
226 CallSites.count(I->first) ||
227
Chad Rosier7a20ed72015-04-14 15:52:57 +0000228 // If the call edge is not from a call or invoke, or it is a
229 // instrinsic call, then the function pass RAUW'd a call with
230 // another value. This can happen when constant folding happens
231 // of well known functions etc.
232 !CallSite(I->first) ||
Sanjoy Dasc65d43e2015-06-18 19:28:26 +0000233 (CallSite(I->first).getCalledFunction() &&
234 CallSite(I->first).getCalledFunction()->isIntrinsic() &&
235 Intrinsic::isLeaf(
236 CallSite(I->first).getCalledFunction()->getIntrinsicID()))) {
Chris Lattnere33167a2009-09-01 18:32:03 +0000237 assert(!CheckingMode &&
238 "CallGraphSCCPass did not update the CallGraph correctly!");
239
Chris Lattner532112b2010-05-01 06:38:43 +0000240 // If this was an indirect call site, count it.
Craig Topper353eda42014-04-24 06:44:33 +0000241 if (!I->second->getFunction())
Chris Lattner532112b2010-05-01 06:38:43 +0000242 ++NumIndirectRemoved;
243 else
244 ++NumDirectRemoved;
245
Chris Lattner65fb5972009-09-02 04:39:04 +0000246 // Just remove the edge from the set of callees, keep track of whether
247 // I points to the last element of the vector.
248 bool WasLast = I + 1 == E;
Chris Lattner063d0652009-09-01 06:31:31 +0000249 CGN->removeCallEdge(I);
Chris Lattner8f232762009-09-02 04:34:06 +0000250
Chris Lattner65fb5972009-09-02 04:39:04 +0000251 // If I pointed to the last element of the vector, we have to bail out:
252 // iterator checking rejects comparisons of the resultant pointer with
253 // end.
254 if (WasLast)
255 break;
Chris Lattner063d0652009-09-01 06:31:31 +0000256 E = CGN->end();
Chris Lattner063d0652009-09-01 06:31:31 +0000257 continue;
258 }
Chris Lattner3f7b3d12009-09-01 18:13:40 +0000259
Chris Lattner063d0652009-09-01 06:31:31 +0000260 assert(!CallSites.count(I->first) &&
Chris Lattnereedcd842009-08-31 07:23:46 +0000261 "Call site occurs in node multiple times");
Sanjay Patel4c219fd2014-11-12 18:25:47 +0000262
263 CallSite CS(I->first);
264 if (CS) {
265 Function *Callee = CS.getCalledFunction();
266 // Ignore intrinsics because they're not really function calls.
267 if (!Callee || !(Callee->isIntrinsic()))
268 CallSites.insert(std::make_pair(I->first, I->second));
269 }
Chris Lattner3f7b3d12009-09-01 18:13:40 +0000270 ++I;
Chris Lattnereedcd842009-08-31 07:23:46 +0000271 }
Chris Lattner3f7b3d12009-09-01 18:13:40 +0000272
Chris Lattnereedcd842009-08-31 07:23:46 +0000273 // Loop over all of the instructions in the function, getting the callsites.
Chris Lattner532112b2010-05-01 06:38:43 +0000274 // Keep track of the number of direct/indirect calls added.
275 unsigned NumDirectAdded = 0, NumIndirectAdded = 0;
Benjamin Krameraa209152016-06-26 17:27:42 +0000276
277 for (BasicBlock &BB : *F)
278 for (Instruction &I : BB) {
279 CallSite CS(&I);
Nuno Lopes674acc12012-06-29 17:49:32 +0000280 if (!CS) continue;
281 Function *Callee = CS.getCalledFunction();
282 if (Callee && Callee->isIntrinsic()) continue;
Chris Lattnereedcd842009-08-31 07:23:46 +0000283
284 // If this call site already existed in the callgraph, just verify it
285 // matches up to expectations and remove it from CallSites.
Chris Lattner063d0652009-09-01 06:31:31 +0000286 DenseMap<Value*, CallGraphNode*>::iterator ExistingIt =
Chris Lattnereedcd842009-08-31 07:23:46 +0000287 CallSites.find(CS.getInstruction());
288 if (ExistingIt != CallSites.end()) {
289 CallGraphNode *ExistingNode = ExistingIt->second;
290
291 // Remove from CallSites since we have now seen it.
292 CallSites.erase(ExistingIt);
293
294 // Verify that the callee is right.
295 if (ExistingNode->getFunction() == CS.getCalledFunction())
296 continue;
297
Chris Lattnere33167a2009-09-01 18:32:03 +0000298 // If we are in checking mode, we are not allowed to actually mutate
299 // the callgraph. If this is a case where we can infer that the
300 // callgraph is less precise than it could be (e.g. an indirect call
301 // site could be turned direct), don't reject it in checking mode, and
302 // don't tweak it to be more precise.
303 if (CheckingMode && CS.getCalledFunction() &&
Craig Topper353eda42014-04-24 06:44:33 +0000304 ExistingNode->getFunction() == nullptr)
Chris Lattnere33167a2009-09-01 18:32:03 +0000305 continue;
306
307 assert(!CheckingMode &&
308 "CallGraphSCCPass did not update the CallGraph correctly!");
309
Chris Lattnereedcd842009-08-31 07:23:46 +0000310 // If not, we either went from a direct call to indirect, indirect to
311 // direct, or direct to different direct.
312 CallGraphNode *CalleeNode;
Chris Lattner6fbe7042010-04-21 00:47:40 +0000313 if (Function *Callee = CS.getCalledFunction()) {
Chris Lattnereedcd842009-08-31 07:23:46 +0000314 CalleeNode = CG.getOrInsertFunction(Callee);
Chris Lattner6fbe7042010-04-21 00:47:40 +0000315 // Keep track of whether we turned an indirect call into a direct
316 // one.
Craig Topper353eda42014-04-24 06:44:33 +0000317 if (!ExistingNode->getFunction()) {
Chris Lattner6fbe7042010-04-21 00:47:40 +0000318 DevirtualizedCall = true;
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000319 LLVM_DEBUG(dbgs() << " CGSCCPASSMGR: Devirtualized call to '"
320 << Callee->getName() << "'\n");
Chris Lattner6fbe7042010-04-21 00:47:40 +0000321 }
322 } else {
Chris Lattnereedcd842009-08-31 07:23:46 +0000323 CalleeNode = CG.getCallsExternalNode();
Chris Lattner6fbe7042010-04-21 00:47:40 +0000324 }
Chris Lattner339c82d2009-09-01 20:33:43 +0000325
326 // Update the edge target in CGN.
Chris Lattner055cf262010-04-22 20:42:33 +0000327 CGN->replaceCallEdge(CS, CS, CalleeNode);
Chris Lattnereedcd842009-08-31 07:23:46 +0000328 MadeChange = true;
329 continue;
330 }
331
Chris Lattnere33167a2009-09-01 18:32:03 +0000332 assert(!CheckingMode &&
333 "CallGraphSCCPass did not update the CallGraph correctly!");
334
Chris Lattner532112b2010-05-01 06:38:43 +0000335 // If the call site didn't exist in the CGN yet, add it.
Chris Lattnereedcd842009-08-31 07:23:46 +0000336 CallGraphNode *CalleeNode;
Chris Lattner532112b2010-05-01 06:38:43 +0000337 if (Function *Callee = CS.getCalledFunction()) {
Chris Lattnereedcd842009-08-31 07:23:46 +0000338 CalleeNode = CG.getOrInsertFunction(Callee);
Chris Lattner532112b2010-05-01 06:38:43 +0000339 ++NumDirectAdded;
340 } else {
Chris Lattnereedcd842009-08-31 07:23:46 +0000341 CalleeNode = CG.getCallsExternalNode();
Chris Lattner532112b2010-05-01 06:38:43 +0000342 ++NumIndirectAdded;
343 }
Chris Lattnereedcd842009-08-31 07:23:46 +0000344
345 CGN->addCalledFunction(CS, CalleeNode);
346 MadeChange = true;
347 }
348
Chris Lattner532112b2010-05-01 06:38:43 +0000349 // We scanned the old callgraph node, removing invalidated call sites and
350 // then added back newly found call sites. One thing that can happen is
351 // that an old indirect call site was deleted and replaced with a new direct
352 // call. In this case, we have devirtualized a call, and CGSCCPM would like
353 // to iteratively optimize the new code. Unfortunately, we don't really
354 // have a great way to detect when this happens. As an approximation, we
355 // just look at whether the number of indirect calls is reduced and the
356 // number of direct calls is increased. There are tons of ways to fool this
357 // (e.g. DCE'ing an indirect call and duplicating an unrelated block with a
358 // direct call) but this is close enough.
359 if (NumIndirectRemoved > NumIndirectAdded &&
360 NumDirectRemoved < NumDirectAdded)
361 DevirtualizedCall = true;
Sanjoy Das2cbeb002017-04-26 16:37:05 +0000362
Chris Lattnereedcd842009-08-31 07:23:46 +0000363 // After scanning this function, if we still have entries in callsites, then
Sanjoy Dase6bca0e2017-05-01 17:07:49 +0000364 // they are dangling pointers. WeakTrackingVH should save us for this, so
365 // abort if
Sanjoy Das2cbeb002017-04-26 16:37:05 +0000366 // this happens.
Chris Lattner063d0652009-09-01 06:31:31 +0000367 assert(CallSites.empty() && "Dangling pointers found in call sites map");
Chris Lattnereedcd842009-08-31 07:23:46 +0000368
Chris Lattner063d0652009-09-01 06:31:31 +0000369 // Periodically do an explicit clear to remove tombstones when processing
370 // large scc's.
Chris Lattner4422d312010-04-16 22:42:17 +0000371 if ((FunctionNo & 15) == 15)
Chris Lattner063d0652009-09-01 06:31:31 +0000372 CallSites.clear();
Chris Lattnereedcd842009-08-31 07:23:46 +0000373 }
374
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000375 LLVM_DEBUG(if (MadeChange) {
376 dbgs() << "CGSCCPASSMGR: Refreshed SCC is now:\n";
377 for (CallGraphNode *CGN : CurSCC)
378 CGN->dump();
379 if (DevirtualizedCall)
380 dbgs() << "CGSCCPASSMGR: Refresh devirtualized a call!\n";
381 } else {
382 dbgs() << "CGSCCPASSMGR: SCC Refresh didn't change call graph.\n";
383 });
Duncan Sandsa41634e2011-08-12 14:54:45 +0000384 (void)MadeChange;
Chris Lattner6fbe7042010-04-21 00:47:40 +0000385
386 return DevirtualizedCall;
387}
388
Sanjay Pateld45a3f12015-03-10 03:48:14 +0000389/// Execute the body of the entire pass manager on the specified SCC.
390/// This keeps track of whether a function pass devirtualizes
Chris Lattner6fbe7042010-04-21 00:47:40 +0000391/// any calls and returns it in DevirtualizedCall.
392bool CGPassManager::RunAllPassesOnSCC(CallGraphSCC &CurSCC, CallGraph &CG,
393 bool &DevirtualizedCall) {
394 bool Changed = false;
395
Sanjay Pateld45a3f12015-03-10 03:48:14 +0000396 // Keep track of whether the callgraph is known to be up-to-date or not.
397 // The CGSSC pass manager runs two types of passes:
Chris Lattner6fbe7042010-04-21 00:47:40 +0000398 // CallGraphSCC Passes and other random function passes. Because other
399 // random function passes are not CallGraph aware, they may clobber the
400 // call graph by introducing new calls or deleting other ones. This flag
401 // is set to false when we run a function pass so that we know to clean up
402 // the callgraph when we need to run a CGSCCPass again.
403 bool CallGraphUpToDate = true;
404
405 // Run all passes on current SCC.
406 for (unsigned PassNo = 0, e = getNumContainedPasses();
407 PassNo != e; ++PassNo) {
408 Pass *P = getContainedPass(PassNo);
409
410 // If we're in -debug-pass=Executions mode, construct the SCC node list,
411 // otherwise avoid constructing this string as it is expensive.
412 if (isPassDebuggingExecutionsOrMore()) {
413 std::string Functions;
414 #ifndef NDEBUG
415 raw_string_ostream OS(Functions);
416 for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end();
417 I != E; ++I) {
418 if (I != CurSCC.begin()) OS << ", ";
419 (*I)->print(OS);
420 }
421 OS.flush();
422 #endif
423 dumpPassInfo(P, EXECUTION_MSG, ON_CG_MSG, Functions);
424 }
425 dumpRequiredSet(P);
426
427 initializeAnalysisImpl(P);
428
429 // Actually run this pass on the current SCC.
430 Changed |= RunPassOnSCC(P, CurSCC, CG,
431 CallGraphUpToDate, DevirtualizedCall);
432
433 if (Changed)
434 dumpPassInfo(P, MODIFICATION_MSG, ON_CG_MSG, "");
435 dumpPreservedSet(P);
436
437 verifyPreservedAnalysis(P);
438 removeNotPreservedAnalysis(P);
439 recordAvailableAnalysis(P);
440 removeDeadPasses(P, "", ON_CG_MSG);
441 }
442
443 // If the callgraph was left out of date (because the last pass run was a
444 // functionpass), refresh it before we move on to the next SCC.
445 if (!CallGraphUpToDate)
446 DevirtualizedCall |= RefreshCallGraph(CurSCC, CG, false);
447 return Changed;
Chris Lattnereedcd842009-08-31 07:23:46 +0000448}
Chris Lattner7e4fbdd2009-08-31 06:01:21 +0000449
Sanjay Pateld45a3f12015-03-10 03:48:14 +0000450/// Execute all of the passes scheduled for execution. Keep track of
Devang Patel48537a02007-01-17 21:45:01 +0000451/// whether any of the passes modifies the module, and if so, return true.
452bool CGPassManager::runOnModule(Module &M) {
Chandler Carruth6378cf52013-11-26 04:19:30 +0000453 CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph();
Bill Wendling5f14a012009-02-11 18:19:24 +0000454 bool Changed = doInitialization(CG);
Evgeniy Stepanovca8c2f72018-07-13 16:32:31 +0000455
456 // Walk the callgraph in bottom-up SCC order.
457 scc_iterator<CallGraph*> CGI = scc_begin(&CG);
Chris Lattner5518b812010-04-16 22:59:24 +0000458
Evgeniy Stepanovca8c2f72018-07-13 16:32:31 +0000459 CallGraphSCC CurSCC(CG, &CGI);
460 while (!CGI.isAtEnd()) {
461 // Copy the current SCC and increment past it so that the pass can hack
462 // on the SCC if it wants to without invalidating our iterator.
463 const std::vector<CallGraphNode *> &NodeVec = *CGI;
464 CurSCC.initialize(NodeVec);
465 ++CGI;
Yaron Kerenafe39832015-07-02 14:17:12 +0000466
Evgeniy Stepanovca8c2f72018-07-13 16:32:31 +0000467 // At the top level, we run all the passes in this pass manager on the
468 // functions in this SCC. However, we support iterative compilation in the
469 // case where a function pass devirtualizes a call to a function. For
470 // example, it is very common for a function pass (often GVN or instcombine)
471 // to eliminate the addressing that feeds into a call. With that improved
472 // information, we would like the call to be an inline candidate, infer
473 // mod-ref information etc.
474 //
475 // Because of this, we allow iteration up to a specified iteration count.
476 // This only happens in the case of a devirtualized call, so we only burn
477 // compile time in the case that we're making progress. We also have a hard
478 // iteration count limit in case there is crazy code.
479 unsigned Iteration = 0;
480 bool DevirtualizedCall = false;
481 do {
482 LLVM_DEBUG(if (Iteration) dbgs()
483 << " SCCPASSMGR: Re-visiting SCC, iteration #" << Iteration
484 << '\n');
485 DevirtualizedCall = false;
486 Changed |= RunAllPassesOnSCC(CurSCC, CG, DevirtualizedCall);
487 } while (Iteration++ < MaxIterations && DevirtualizedCall);
488
489 if (DevirtualizedCall)
490 LLVM_DEBUG(dbgs() << " CGSCCPASSMGR: Stopped iteration after "
491 << Iteration
492 << " times, due to -max-cg-scc-iterations\n");
Craig Topper8a950272017-05-18 00:51:39 +0000493
Evgeniy Stepanovca8c2f72018-07-13 16:32:31 +0000494 MaxSCCIterations.updateMax(Iteration);
Devang Patel48537a02007-01-17 21:45:01 +0000495 }
Bill Wendling5f14a012009-02-11 18:19:24 +0000496 Changed |= doFinalization(CG);
Devang Patel48537a02007-01-17 21:45:01 +0000497 return Changed;
498}
499
500/// Initialize CG
Bill Wendling5f14a012009-02-11 18:19:24 +0000501bool CGPassManager::doInitialization(CallGraph &CG) {
Devang Patel48537a02007-01-17 21:45:01 +0000502 bool Changed = false;
Chris Lattner0b1c7232010-01-22 05:46:59 +0000503 for (unsigned i = 0, e = getNumContainedPasses(); i != e; ++i) {
504 if (PMDataManager *PM = getContainedPass(i)->getAsPMDataManager()) {
505 assert(PM->getPassManagerType() == PMT_FunctionPassManager &&
506 "Invalid CGPassManager member");
507 Changed |= ((FPPassManager*)PM)->doInitialization(CG.getModule());
Nick Lewyckycdccffe2009-02-13 07:15:53 +0000508 } else {
Chris Lattner0b1c7232010-01-22 05:46:59 +0000509 Changed |= ((CallGraphSCCPass*)getContainedPass(i))->doInitialization(CG);
Nick Lewyckycdccffe2009-02-13 07:15:53 +0000510 }
Devang Patel48537a02007-01-17 21:45:01 +0000511 }
512 return Changed;
513}
514
515/// Finalize CG
Bill Wendling5f14a012009-02-11 18:19:24 +0000516bool CGPassManager::doFinalization(CallGraph &CG) {
Devang Patel48537a02007-01-17 21:45:01 +0000517 bool Changed = false;
Chris Lattner0b1c7232010-01-22 05:46:59 +0000518 for (unsigned i = 0, e = getNumContainedPasses(); i != e; ++i) {
519 if (PMDataManager *PM = getContainedPass(i)->getAsPMDataManager()) {
520 assert(PM->getPassManagerType() == PMT_FunctionPassManager &&
521 "Invalid CGPassManager member");
522 Changed |= ((FPPassManager*)PM)->doFinalization(CG.getModule());
Nick Lewyckycdccffe2009-02-13 07:15:53 +0000523 } else {
Chris Lattner0b1c7232010-01-22 05:46:59 +0000524 Changed |= ((CallGraphSCCPass*)getContainedPass(i))->doFinalization(CG);
Nick Lewyckycdccffe2009-02-13 07:15:53 +0000525 }
Devang Patel48537a02007-01-17 21:45:01 +0000526 }
527 return Changed;
528}
529
Chris Lattner6d1208f2010-04-16 21:43:55 +0000530//===----------------------------------------------------------------------===//
Chris Lattner4422d312010-04-16 22:42:17 +0000531// CallGraphSCC Implementation
532//===----------------------------------------------------------------------===//
533
Sanjay Pateld45a3f12015-03-10 03:48:14 +0000534/// This informs the SCC and the pass manager that the specified
Chris Lattner5518b812010-04-16 22:59:24 +0000535/// Old node has been deleted, and New is to be used in its place.
536void CallGraphSCC::ReplaceNode(CallGraphNode *Old, CallGraphNode *New) {
537 assert(Old != New && "Should not replace node with self");
538 for (unsigned i = 0; ; ++i) {
539 assert(i != Nodes.size() && "Node not in SCC");
540 if (Nodes[i] != Old) continue;
541 Nodes[i] = New;
542 break;
543 }
Chris Lattnerde023a32010-04-16 23:04:30 +0000544
545 // Update the active scc_iterator so that it doesn't contain dangling
546 // pointers to the old CallGraphNode.
547 scc_iterator<CallGraph*> *CGI = (scc_iterator<CallGraph*>*)Context;
548 CGI->ReplaceNode(Old, New);
Chris Lattner5518b812010-04-16 22:59:24 +0000549}
Chris Lattner4422d312010-04-16 22:42:17 +0000550
Chris Lattner4422d312010-04-16 22:42:17 +0000551//===----------------------------------------------------------------------===//
Chris Lattner6d1208f2010-04-16 21:43:55 +0000552// CallGraphSCCPass Implementation
553//===----------------------------------------------------------------------===//
David Greene9b063df2010-04-02 23:17:14 +0000554
Devang Patel020f4f22007-01-23 21:55:17 +0000555/// Assign pass manager to manage this pass.
Devang Patel1f8200b2007-01-23 21:52:35 +0000556void CallGraphSCCPass::assignPassManager(PMStack &PMS,
Anton Korobeynikovfb801512007-04-16 18:10:23 +0000557 PassManagerType PreferredType) {
Devang Patel1f8200b2007-01-23 21:52:35 +0000558 // Find CGPassManager
Duncan Sands60f28bf2007-07-19 09:42:01 +0000559 while (!PMS.empty() &&
560 PMS.top()->getPassManagerType() > PMT_CallGraphPassManager)
561 PMS.pop();
Devang Patel1f8200b2007-01-23 21:52:35 +0000562
Chris Lattner9efd4fc2010-01-22 05:37:10 +0000563 assert(!PMS.empty() && "Unable to handle Call Graph Pass");
564 CGPassManager *CGP;
565
566 if (PMS.top()->getPassManagerType() == PMT_CallGraphPassManager)
567 CGP = (CGPassManager*)PMS.top();
568 else {
569 // Create new Call Graph SCC Pass Manager if it does not exist.
570 assert(!PMS.empty() && "Unable to create Call Graph Pass Manager");
Devang Patel1f8200b2007-01-23 21:52:35 +0000571 PMDataManager *PMD = PMS.top();
572
573 // [1] Create new Call Graph Pass Manager
Andrew Trick08966212011-08-29 17:07:00 +0000574 CGP = new CGPassManager();
Devang Patel1f8200b2007-01-23 21:52:35 +0000575
576 // [2] Set up new manager's top level manager
577 PMTopLevelManager *TPM = PMD->getTopLevelManager();
578 TPM->addIndirectPassManager(CGP);
579
580 // [3] Assign manager to manage this new manager. This may create
581 // and push new managers into PMS
Chris Lattner9efd4fc2010-01-22 05:37:10 +0000582 Pass *P = CGP;
Devang Patel703de8f2007-06-21 22:29:02 +0000583 TPM->schedulePass(P);
Devang Patel1f8200b2007-01-23 21:52:35 +0000584
585 // [4] Push new manager into PMS
586 PMS.push(CGP);
587 }
588
589 CGP->add(this);
590}
591
Sanjay Pateld45a3f12015-03-10 03:48:14 +0000592/// For this class, we declare that we require and preserve the call graph.
593/// If the derived class implements this method, it should
Chris Lattnerf7e95942003-08-31 01:54:59 +0000594/// always explicitly call the implementation here.
595void CallGraphSCCPass::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruth6378cf52013-11-26 04:19:30 +0000596 AU.addRequired<CallGraphWrapperPass>();
597 AU.addPreserved<CallGraphWrapperPass>();
Chris Lattnerf7e95942003-08-31 01:54:59 +0000598}
Chris Lattner6d1208f2010-04-16 21:43:55 +0000599
Chris Lattner6d1208f2010-04-16 21:43:55 +0000600//===----------------------------------------------------------------------===//
601// PrintCallGraphPass Implementation
602//===----------------------------------------------------------------------===//
603
604namespace {
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000605
Chris Lattner6d1208f2010-04-16 21:43:55 +0000606 /// PrintCallGraphPass - Print a Module corresponding to a call graph.
607 ///
608 class PrintCallGraphPass : public CallGraphSCCPass {
609 std::string Banner;
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000610 raw_ostream &OS; // raw_ostream to print on.
Chris Lattner6d1208f2010-04-16 21:43:55 +0000611
612 public:
613 static char ID;
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000614
615 PrintCallGraphPass(const std::string &B, raw_ostream &OS)
616 : CallGraphSCCPass(ID), Banner(B), OS(OS) {}
Craig Toppere9ba7592014-03-05 07:30:04 +0000617
618 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chris Lattner6d1208f2010-04-16 21:43:55 +0000619 AU.setPreservesAll();
620 }
Craig Toppere9ba7592014-03-05 07:30:04 +0000621
622 bool runOnSCC(CallGraphSCC &SCC) override {
Yaron Keren7d463922017-06-12 02:18:50 +0000623 bool BannerPrinted = false;
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000624 auto PrintBannerOnce = [&] () {
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000625 if (BannerPrinted)
626 return;
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000627 OS << Banner;
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000628 BannerPrinted = true;
629 };
Sanjay Patelc6012542015-03-10 03:26:39 +0000630 for (CallGraphNode *CGN : SCC) {
Yaron Keren7d463922017-06-12 02:18:50 +0000631 if (Function *F = CGN->getFunction()) {
632 if (!F->isDeclaration() && isFunctionInPrintList(F->getName())) {
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000633 PrintBannerOnce();
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000634 F->print(OS);
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000635 }
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000636 } else if (isFunctionInPrintList("*")) {
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000637 PrintBannerOnce();
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000638 OS << "\nPrinting <null> Function\n";
Mehdi Amini062b3fe2017-01-18 21:37:11 +0000639 }
Richard Trieua23043c2014-06-09 22:53:16 +0000640 }
Chris Lattner6d1208f2010-04-16 21:43:55 +0000641 return false;
642 }
Yaron Keren1de47922017-03-10 07:09:20 +0000643
644 StringRef getPassName() const override { return "Print CallGraph IR"; }
Chris Lattner6d1208f2010-04-16 21:43:55 +0000645 };
646
647} // end anonymous namespace.
648
649char PrintCallGraphPass::ID = 0;
650
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000651Pass *CallGraphSCCPass::createPrinterPass(raw_ostream &OS,
Chris Lattner6d1208f2010-04-16 21:43:55 +0000652 const std::string &Banner) const {
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000653 return new PrintCallGraphPass(Banner, OS);
Chris Lattner6d1208f2010-04-16 21:43:55 +0000654}
655
Andrew Kayloraa641a52016-04-22 22:06:11 +0000656bool CallGraphSCCPass::skipSCC(CallGraphSCC &SCC) const {
657 return !SCC.getCallGraph().getModule()
658 .getContext()
Fedor Sergeev98014e42018-03-27 16:57:20 +0000659 .getOptPassGate()
Andrew Kayloraa641a52016-04-22 22:06:11 +0000660 .shouldRunPass(this, SCC);
661}
Mehdi Aminibbacddf2016-06-10 16:19:46 +0000662
663char DummyCGSCCPass::ID = 0;
Eugene Zelenkofa6434b2017-08-31 21:56:16 +0000664
Mehdi Aminibbacddf2016-06-10 16:19:46 +0000665INITIALIZE_PASS(DummyCGSCCPass, "DummyCGSCCPass", "DummyCGSCCPass", false,
666 false)