14a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner//===- CallGraphSCCPass.cpp - Pass that operates BU on call graph ---------===// 22b37d7cf28b1382420b5e4007042feeb66d21ac8Misha Brukman// 3b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// The LLVM Compiler Infrastructure 4b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// 54ee451de366474b9c228b4e5fa573795a715216dChris Lattner// This file is distributed under the University of Illinois Open Source 64ee451de366474b9c228b4e5fa573795a715216dChris Lattner// License. See LICENSE.TXT for details. 72b37d7cf28b1382420b5e4007042feeb66d21ac8Misha Brukman// 8b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell//===----------------------------------------------------------------------===// 94a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// 104a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// This file implements the CallGraphSCCPass class, which is used for passes 114a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// which are implemented as bottom-up traversals on the call graph. Because 124a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// there may be cycles in the call graph, passes of this type operate on the 134a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// call-graph in SCC order: that is, they process function bottom-up, except for 144a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// recursive functions, which they process all at once. 154a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner// 164a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner//===----------------------------------------------------------------------===// 174a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner 183251e81d793a293b78f4914be6093b405c24fc2aChandler Carruth#include "llvm/Analysis/CallGraphSCCPass.h" 19551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/ADT/SCCIterator.h" 2008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner#include "llvm/ADT/Statistic.h" 21d04a8d4b33ff316ca4cf961e06c9e312eff8e64fChandler Carruth#include "llvm/Analysis/CallGraph.h" 220b8c9a80f20772c3793201ab5b251d3520b9cea3Chandler Carruth#include "llvm/IR/Function.h" 230b8c9a80f20772c3793201ab5b251d3520b9cea3Chandler Carruth#include "llvm/IR/IntrinsicInst.h" 2449837ef8111fbeace7ae6379ca733c8f8fa94cfeChandler Carruth#include "llvm/IR/LegacyPassManagers.h" 25dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#include "llvm/IR/LLVMContext.h" 2608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner#include "llvm/Support/CommandLine.h" 27be577659d3c1222cc58c33628c0baddb94d241abChris Lattner#include "llvm/Support/Debug.h" 28a782e75d487006cafffdc256b3c623307fee4dcfChris Lattner#include "llvm/Support/Timer.h" 2945cfe545ec8177262dabc70580ce05feaa1c3880Chris Lattner#include "llvm/Support/raw_ostream.h" 30a10df5028211fc897751d23e91d035db47d23facChris Lattnerusing namespace llvm; 31d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 32dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#define DEBUG_TYPE "cgscc-passmgr" 33dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 3408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattnerstatic cl::opt<unsigned> 356da12e6767100d3f874c2e05aae74e4fe24357b1Chris LattnerMaxIterations("max-cg-scc-iterations", cl::ReallyHidden, cl::init(4)); 3608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 3708e322db8a544d100f7518cfbd39ef8c13067698Chris LattnerSTATISTIC(MaxSCCIterations, "Maximum CGSCCPassMgr iterations on one SCC"); 3808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 3975f9abf51706242a745e05841598f68e64143494Devang Patel//===----------------------------------------------------------------------===// 4075f9abf51706242a745e05841598f68e64143494Devang Patel// CGPassManager 4175f9abf51706242a745e05841598f68e64143494Devang Patel// 42db2659be58a5d9a820eeb5884f284143f6676f86Dale Johannesen/// CGPassManager manages FPPassManagers and CallGraphSCCPasses. 4375f9abf51706242a745e05841598f68e64143494Devang Patel 44844731a7f1909f55935e3514c9e713a62d67662eDan Gohmannamespace { 45844731a7f1909f55935e3514c9e713a62d67662eDan Gohman 4675f9abf51706242a745e05841598f68e64143494Devang Patelclass CGPassManager : public ModulePass, public PMDataManager { 4775f9abf51706242a745e05841598f68e64143494Devang Patelpublic: 481997473cf72957d0e70322e2fe6fe2ab141c58a6Devang Patel static char ID; 490e122d1c2422285c872f68fc0ae1f7e5d2739572Andrew Trick explicit CGPassManager() 500e122d1c2422285c872f68fc0ae1f7e5d2739572Andrew Trick : ModulePass(ID), PMDataManager() { } 5175f9abf51706242a745e05841598f68e64143494Devang Patel 5275f9abf51706242a745e05841598f68e64143494Devang Patel /// run - Execute all of the passes scheduled for execution. Keep track of 5375f9abf51706242a745e05841598f68e64143494Devang Patel /// whether any of the passes modifies the module, and if so, return true. 5436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines bool runOnModule(Module &M) override; 5575f9abf51706242a745e05841598f68e64143494Devang Patel 5640b6fdb81e12b40dd41c9f9f07befb60ec7291c3Owen Anderson using ModulePass::doInitialization; 5740b6fdb81e12b40dd41c9f9f07befb60ec7291c3Owen Anderson using ModulePass::doFinalization; 5840b6fdb81e12b40dd41c9f9f07befb60ec7291c3Owen Anderson 59905c7e9a0459ffdffbee3e6fffe0dbf5e5c9583cBill Wendling bool doInitialization(CallGraph &CG); 60905c7e9a0459ffdffbee3e6fffe0dbf5e5c9583cBill Wendling bool doFinalization(CallGraph &CG); 6175f9abf51706242a745e05841598f68e64143494Devang Patel 6275f9abf51706242a745e05841598f68e64143494Devang Patel /// Pass Manager itself does not invalidate any analysis info. 6336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void getAnalysisUsage(AnalysisUsage &Info) const override { 6475f9abf51706242a745e05841598f68e64143494Devang Patel // CGPassManager walks SCC and it needs CallGraph. 6536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines Info.addRequired<CallGraphWrapperPass>(); 6675f9abf51706242a745e05841598f68e64143494Devang Patel Info.setPreservesAll(); 6775f9abf51706242a745e05841598f68e64143494Devang Patel } 6875f9abf51706242a745e05841598f68e64143494Devang Patel 6936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines const char *getPassName() const override { 70505f36aedec873d99bdaabb8836eac704185f086Devang Patel return "CallGraph Pass Manager"; 71505f36aedec873d99bdaabb8836eac704185f086Devang Patel } 72505f36aedec873d99bdaabb8836eac704185f086Devang Patel 7336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines PMDataManager *getAsPMDataManager() override { return this; } 7436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines Pass *getAsPass() override { return this; } 753660ecabbb85b31308f38938ce3f56f0a330a84bChris Lattner 7675f9abf51706242a745e05841598f68e64143494Devang Patel // Print passes managed by this manager 7736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void dumpPassStructure(unsigned Offset) override { 782e48e53d980ee9af1bc96d8ffd9d089cb8d3b5efDavid Greene errs().indent(Offset*2) << "Call Graph SCC Pass Manager\n"; 7975f9abf51706242a745e05841598f68e64143494Devang Patel for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) { 8075f9abf51706242a745e05841598f68e64143494Devang Patel Pass *P = getContainedPass(Index); 818a757aeac436ecd27e28a39b10032fd6fda33780Dan Gohman P->dumpPassStructure(Offset + 1); 8275f9abf51706242a745e05841598f68e64143494Devang Patel dumpLastUses(P, Offset+1); 8375f9abf51706242a745e05841598f68e64143494Devang Patel } 8475f9abf51706242a745e05841598f68e64143494Devang Patel } 8575f9abf51706242a745e05841598f68e64143494Devang Patel 8675f9abf51706242a745e05841598f68e64143494Devang Patel Pass *getContainedPass(unsigned N) { 8745cfe545ec8177262dabc70580ce05feaa1c3880Chris Lattner assert(N < PassVector.size() && "Pass number out of range!"); 8845cfe545ec8177262dabc70580ce05feaa1c3880Chris Lattner return static_cast<Pass *>(PassVector[N]); 8975f9abf51706242a745e05841598f68e64143494Devang Patel } 9075f9abf51706242a745e05841598f68e64143494Devang Patel 9136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines PassManagerType getPassManagerType() const override { 9275f9abf51706242a745e05841598f68e64143494Devang Patel return PMT_CallGraphPassManager; 9375f9abf51706242a745e05841598f68e64143494Devang Patel } 94f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 95f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattnerprivate: 9608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool RunAllPassesOnSCC(CallGraphSCC &CurSCC, CallGraph &CG, 9708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool &DevirtualizedCall); 9808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 992decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner bool RunPassOnSCC(Pass *P, CallGraphSCC &CurSCC, 10008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner CallGraph &CG, bool &CallGraphUpToDate, 10108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool &DevirtualizedCall); 10208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool RefreshCallGraph(CallGraphSCC &CurSCC, CallGraph &CG, 1035a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner bool IsCheckingMode); 10475f9abf51706242a745e05841598f68e64143494Devang Patel}; 10575f9abf51706242a745e05841598f68e64143494Devang Patel 106f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner} // end anonymous namespace. 107844731a7f1909f55935e3514c9e713a62d67662eDan Gohman 1081997473cf72957d0e70322e2fe6fe2ab141c58a6Devang Patelchar CGPassManager::ID = 0; 109f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 1105c8aa950fe3484b6e115647328c196f8be64f9edDavid Greene 1112decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattnerbool CGPassManager::RunPassOnSCC(Pass *P, CallGraphSCC &CurSCC, 11208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner CallGraph &CG, bool &CallGraphUpToDate, 11308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool &DevirtualizedCall) { 114f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner bool Changed = false; 1155a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner PMDataManager *PM = P->getAsPMDataManager(); 1165a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner 117dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (!PM) { 1185a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner CallGraphSCCPass *CGSP = (CallGraphSCCPass*)P; 119be577659d3c1222cc58c33628c0baddb94d241abChris Lattner if (!CallGraphUpToDate) { 12008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner DevirtualizedCall |= RefreshCallGraph(CurSCC, CG, false); 121be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallGraphUpToDate = true; 122be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 12344a18370e0fe77a1b31698e945a9ce9f691364fbChris Lattner 124a782e75d487006cafffdc256b3c623307fee4dcfChris Lattner { 125a782e75d487006cafffdc256b3c623307fee4dcfChris Lattner TimeRegion PassTimer(getPassTimer(CGSP)); 126a782e75d487006cafffdc256b3c623307fee4dcfChris Lattner Changed = CGSP->runOnSCC(CurSCC); 127a782e75d487006cafffdc256b3c623307fee4dcfChris Lattner } 1285a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 1295a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // After the CGSCCPass is done, when assertions are enabled, use 1305a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // RefreshCallGraph to verify that the callgraph was correctly updated. 1315a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner#ifndef NDEBUG 1325a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner if (Changed) 1335a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner RefreshCallGraph(CurSCC, CG, true); 1345a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner#endif 1355a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 136f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner return Changed; 137f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner } 138f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 1395a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner 1405a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner assert(PM->getPassManagerType() == PMT_FunctionPassManager && 1415a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner "Invalid CGPassManager member"); 1425a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner FPPassManager *FPP = (FPPassManager*)P; 143f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 144f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner // Run pass P on all functions in the current SCC. 1452decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end(); 1462decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner I != E; ++I) { 1472decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner if (Function *F = (*I)->getFunction()) { 148f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner dumpPassInfo(P, EXECUTION_MSG, ON_FUNCTION_MSG, F->getName()); 149dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines { 150dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines TimeRegion PassTimer(getPassTimer(FPP)); 151dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Changed |= FPP->runOnFunction(*F); 152dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines } 153dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines F->getContext().yield(); 154f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner } 155f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner } 156f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 1572038cf31684089fe745a3971e32f4d208b68a0a4Chris Lattner // The function pass(es) modified the IR, they may have clobbered the 158be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // callgraph. 159be577659d3c1222cc58c33628c0baddb94d241abChris Lattner if (Changed && CallGraphUpToDate) { 160c81ce58306ce8d087ed3f5accd3212d2d08eb0a9David Greene DEBUG(dbgs() << "CGSCCPASSMGR: Pass Dirtied SCC: " 161be577659d3c1222cc58c33628c0baddb94d241abChris Lattner << P->getPassName() << '\n'); 162be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallGraphUpToDate = false; 163be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 164f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner return Changed; 165f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner} 166f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 1675a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 1685a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner/// RefreshCallGraph - Scan the functions in the specified CFG and resync the 1695a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner/// callgraph with the call sites found in it. This is used after 1705a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner/// FunctionPasses have potentially munged the callgraph, and can be used after 1715a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner/// CallGraphSCC passes to verify that they correctly updated the callgraph. 1725a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner/// 17308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// This function returns true if it devirtualized an existing function call, 17408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// meaning it turned an indirect call into a direct call. This happens when 17508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// a function pass like GVN optimizes away stuff feeding the indirect call. 17608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// This never happens in checking mode. 17708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// 17808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattnerbool CGPassManager::RefreshCallGraph(CallGraphSCC &CurSCC, 1795a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner CallGraph &CG, bool CheckingMode) { 180a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner DenseMap<Value*, CallGraphNode*> CallSites; 181be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 182c81ce58306ce8d087ed3f5accd3212d2d08eb0a9David Greene DEBUG(dbgs() << "CGSCCPASSMGR: Refreshing SCC with " << CurSCC.size() 183be577659d3c1222cc58c33628c0baddb94d241abChris Lattner << " nodes:\n"; 1842decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end(); 1852decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner I != E; ++I) 1862decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner (*I)->dump(); 187be577659d3c1222cc58c33628c0baddb94d241abChris Lattner ); 188be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 189be577659d3c1222cc58c33628c0baddb94d241abChris Lattner bool MadeChange = false; 19008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool DevirtualizedCall = false; 191be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 192be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // Scan all functions in the SCC. 1932decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner unsigned FunctionNo = 0; 1942decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner for (CallGraphSCC::iterator SCCIdx = CurSCC.begin(), E = CurSCC.end(); 1952decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner SCCIdx != E; ++SCCIdx, ++FunctionNo) { 1962decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner CallGraphNode *CGN = *SCCIdx; 197be577659d3c1222cc58c33628c0baddb94d241abChris Lattner Function *F = CGN->getFunction(); 198dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (!F || F->isDeclaration()) continue; 199be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 200be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // Walk the function body looking for call sites. Sync up the call sites in 201be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // CGN with those actually in the function. 202bccb41afc8542f01358341451cac85a7115d8763Chris Lattner 203bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // Keep track of the number of direct and indirect calls that were 204bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // invalidated and removed. 205bccb41afc8542f01358341451cac85a7115d8763Chris Lattner unsigned NumDirectRemoved = 0, NumIndirectRemoved = 0; 20617146b867f72c2ca020e2ba8b0b6cbba93a1f7c8Chris Lattner 207be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // Get the set of call sites currently in the function. 208b3020d7a08b951adff8d102b27aaa0bc2a7156daDuncan Sands for (CallGraphNode::iterator I = CGN->begin(), E = CGN->end(); I != E; ) { 209a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // If this call site is null, then the function pass deleted the call 21017146b867f72c2ca020e2ba8b0b6cbba93a1f7c8Chris Lattner // entirely and the WeakVH nulled it out. 211dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (!I->first || 212a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // If we've already seen this call site, then the FunctionPass RAUW'd 213a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // one call with another, which resulted in two "uses" in the edge 214a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // list of the same call. 215a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner CallSites.count(I->first) || 216a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner 217a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // If the call edge is not from a call or invoke, then the function 218a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // pass RAUW'd a call with another value. This can happen when 219a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // constant folding happens of well known functions etc. 220ce4a62639f64d2f24577ad4e872f01cd7d6bc82fGabor Greif !CallSite(I->first)) { 2215a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner assert(!CheckingMode && 2225a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner "CallGraphSCCPass did not update the CallGraph correctly!"); 2235a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 224bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // If this was an indirect call site, count it. 225dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (!I->second->getFunction()) 226bccb41afc8542f01358341451cac85a7115d8763Chris Lattner ++NumIndirectRemoved; 227bccb41afc8542f01358341451cac85a7115d8763Chris Lattner else 228bccb41afc8542f01358341451cac85a7115d8763Chris Lattner ++NumDirectRemoved; 229bccb41afc8542f01358341451cac85a7115d8763Chris Lattner 230d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner // Just remove the edge from the set of callees, keep track of whether 231d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner // I points to the last element of the vector. 232d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner bool WasLast = I + 1 == E; 233a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner CGN->removeCallEdge(I); 234b8bcbd61a8a8ea3960da47734579150f514abfbbChris Lattner 235d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner // If I pointed to the last element of the vector, we have to bail out: 236d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner // iterator checking rejects comparisons of the resultant pointer with 237d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner // end. 238d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner if (WasLast) 239d3bd0821b00f1100ab98454264c8775ace826f0dChris Lattner break; 240a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner E = CGN->end(); 241a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner continue; 242a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner } 24317146b867f72c2ca020e2ba8b0b6cbba93a1f7c8Chris Lattner 244a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner assert(!CallSites.count(I->first) && 245be577659d3c1222cc58c33628c0baddb94d241abChris Lattner "Call site occurs in node multiple times"); 246a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner CallSites.insert(std::make_pair(I->first, I->second)); 24717146b867f72c2ca020e2ba8b0b6cbba93a1f7c8Chris Lattner ++I; 248be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 24917146b867f72c2ca020e2ba8b0b6cbba93a1f7c8Chris Lattner 250be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // Loop over all of the instructions in the function, getting the callsites. 251bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // Keep track of the number of direct/indirect calls added. 252bccb41afc8542f01358341451cac85a7115d8763Chris Lattner unsigned NumDirectAdded = 0, NumIndirectAdded = 0; 253bccb41afc8542f01358341451cac85a7115d8763Chris Lattner 254be577659d3c1222cc58c33628c0baddb94d241abChris Lattner for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) 255be577659d3c1222cc58c33628c0baddb94d241abChris Lattner for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) { 256e669d83a21d7ebf01d3c9e37a20c7348b5a77c11John McCall CallSite CS(cast<Value>(I)); 2577d539716e2ef6c953bed51cfab5edba98b557657Nuno Lopes if (!CS) continue; 2587d539716e2ef6c953bed51cfab5edba98b557657Nuno Lopes Function *Callee = CS.getCalledFunction(); 2597d539716e2ef6c953bed51cfab5edba98b557657Nuno Lopes if (Callee && Callee->isIntrinsic()) continue; 260be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 261be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // If this call site already existed in the callgraph, just verify it 262be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // matches up to expectations and remove it from CallSites. 263a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner DenseMap<Value*, CallGraphNode*>::iterator ExistingIt = 264be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallSites.find(CS.getInstruction()); 265be577659d3c1222cc58c33628c0baddb94d241abChris Lattner if (ExistingIt != CallSites.end()) { 266be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallGraphNode *ExistingNode = ExistingIt->second; 267be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 268be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // Remove from CallSites since we have now seen it. 269be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallSites.erase(ExistingIt); 270be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 271be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // Verify that the callee is right. 272be577659d3c1222cc58c33628c0baddb94d241abChris Lattner if (ExistingNode->getFunction() == CS.getCalledFunction()) 273be577659d3c1222cc58c33628c0baddb94d241abChris Lattner continue; 274be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 2755a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // If we are in checking mode, we are not allowed to actually mutate 2765a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // the callgraph. If this is a case where we can infer that the 2775a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // callgraph is less precise than it could be (e.g. an indirect call 2785a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // site could be turned direct), don't reject it in checking mode, and 2795a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner // don't tweak it to be more precise. 2805a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner if (CheckingMode && CS.getCalledFunction() && 281dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines ExistingNode->getFunction() == nullptr) 2825a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner continue; 2835a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 2845a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner assert(!CheckingMode && 2855a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner "CallGraphSCCPass did not update the CallGraph correctly!"); 2865a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 287be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // If not, we either went from a direct call to indirect, indirect to 288be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // direct, or direct to different direct. 289be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallGraphNode *CalleeNode; 29008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (Function *Callee = CS.getCalledFunction()) { 291be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CalleeNode = CG.getOrInsertFunction(Callee); 29208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // Keep track of whether we turned an indirect call into a direct 29308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // one. 294dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (!ExistingNode->getFunction()) { 29508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner DevirtualizedCall = true; 29608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner DEBUG(dbgs() << " CGSCCPASSMGR: Devirtualized call to '" 29708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner << Callee->getName() << "'\n"); 29808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } 29908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } else { 300be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CalleeNode = CG.getCallsExternalNode(); 30108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } 30244a18370e0fe77a1b31698e945a9ce9f691364fbChris Lattner 30344a18370e0fe77a1b31698e945a9ce9f691364fbChris Lattner // Update the edge target in CGN. 304b61789d4dd851c2481d0ad95c7a710d567fb86f7Chris Lattner CGN->replaceCallEdge(CS, CS, CalleeNode); 305be577659d3c1222cc58c33628c0baddb94d241abChris Lattner MadeChange = true; 306be577659d3c1222cc58c33628c0baddb94d241abChris Lattner continue; 307be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 308be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 3095a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner assert(!CheckingMode && 3105a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner "CallGraphSCCPass did not update the CallGraph correctly!"); 3115a6a363527f9f66ff23f2d281f4fdc6c2084f2d3Chris Lattner 312bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // If the call site didn't exist in the CGN yet, add it. 313be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CallGraphNode *CalleeNode; 314bccb41afc8542f01358341451cac85a7115d8763Chris Lattner if (Function *Callee = CS.getCalledFunction()) { 315be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CalleeNode = CG.getOrInsertFunction(Callee); 316bccb41afc8542f01358341451cac85a7115d8763Chris Lattner ++NumDirectAdded; 317bccb41afc8542f01358341451cac85a7115d8763Chris Lattner } else { 318be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CalleeNode = CG.getCallsExternalNode(); 319bccb41afc8542f01358341451cac85a7115d8763Chris Lattner ++NumIndirectAdded; 320bccb41afc8542f01358341451cac85a7115d8763Chris Lattner } 321be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 322be577659d3c1222cc58c33628c0baddb94d241abChris Lattner CGN->addCalledFunction(CS, CalleeNode); 323be577659d3c1222cc58c33628c0baddb94d241abChris Lattner MadeChange = true; 324be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 325be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 326bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // We scanned the old callgraph node, removing invalidated call sites and 327bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // then added back newly found call sites. One thing that can happen is 328bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // that an old indirect call site was deleted and replaced with a new direct 329bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // call. In this case, we have devirtualized a call, and CGSCCPM would like 330bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // to iteratively optimize the new code. Unfortunately, we don't really 331bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // have a great way to detect when this happens. As an approximation, we 332bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // just look at whether the number of indirect calls is reduced and the 333bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // number of direct calls is increased. There are tons of ways to fool this 334bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // (e.g. DCE'ing an indirect call and duplicating an unrelated block with a 335bccb41afc8542f01358341451cac85a7115d8763Chris Lattner // direct call) but this is close enough. 336bccb41afc8542f01358341451cac85a7115d8763Chris Lattner if (NumIndirectRemoved > NumIndirectAdded && 337bccb41afc8542f01358341451cac85a7115d8763Chris Lattner NumDirectRemoved < NumDirectAdded) 338bccb41afc8542f01358341451cac85a7115d8763Chris Lattner DevirtualizedCall = true; 339bccb41afc8542f01358341451cac85a7115d8763Chris Lattner 340be577659d3c1222cc58c33628c0baddb94d241abChris Lattner // After scanning this function, if we still have entries in callsites, then 341a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // they are dangling pointers. WeakVH should save us for this, so abort if 342a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // this happens. 343a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner assert(CallSites.empty() && "Dangling pointers found in call sites map"); 344be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 345a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // Periodically do an explicit clear to remove tombstones when processing 346a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner // large scc's. 3472decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner if ((FunctionNo & 15) == 15) 348a541b0fde2ab6b8b037edf113d42da41a2c5aae9Chris Lattner CallSites.clear(); 349be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 350be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 351be577659d3c1222cc58c33628c0baddb94d241abChris Lattner DEBUG(if (MadeChange) { 352c81ce58306ce8d087ed3f5accd3212d2d08eb0a9David Greene dbgs() << "CGSCCPASSMGR: Refreshed SCC is now:\n"; 3532decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end(); 3542decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner I != E; ++I) 3552decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner (*I)->dump(); 356bccb41afc8542f01358341451cac85a7115d8763Chris Lattner if (DevirtualizedCall) 357bccb41afc8542f01358341451cac85a7115d8763Chris Lattner dbgs() << "CGSCCPASSMGR: Refresh devirtualized a call!\n"; 358bccb41afc8542f01358341451cac85a7115d8763Chris Lattner 359be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } else { 360c81ce58306ce8d087ed3f5accd3212d2d08eb0a9David Greene dbgs() << "CGSCCPASSMGR: SCC Refresh didn't change call graph.\n"; 361be577659d3c1222cc58c33628c0baddb94d241abChris Lattner } 362be577659d3c1222cc58c33628c0baddb94d241abChris Lattner ); 3631f6a329f79b3568d379142f921f59c4143ddaa14Duncan Sands (void)MadeChange; 36408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 36508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner return DevirtualizedCall; 36608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner} 36708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 36808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// RunAllPassesOnSCC - Execute the body of the entire pass manager on the 36908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// specified SCC. This keeps track of whether a function pass devirtualizes 37008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner/// any calls and returns it in DevirtualizedCall. 37108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattnerbool CGPassManager::RunAllPassesOnSCC(CallGraphSCC &CurSCC, CallGraph &CG, 37208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool &DevirtualizedCall) { 37308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool Changed = false; 37408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 37508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // CallGraphUpToDate - Keep track of whether the callgraph is known to be 37608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // up-to-date or not. The CGSSC pass manager runs two types of passes: 37708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // CallGraphSCC Passes and other random function passes. Because other 37808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // random function passes are not CallGraph aware, they may clobber the 37908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // call graph by introducing new calls or deleting other ones. This flag 38008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // is set to false when we run a function pass so that we know to clean up 38108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // the callgraph when we need to run a CGSCCPass again. 38208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool CallGraphUpToDate = true; 38308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 38408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // Run all passes on current SCC. 38508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner for (unsigned PassNo = 0, e = getNumContainedPasses(); 38608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner PassNo != e; ++PassNo) { 38708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner Pass *P = getContainedPass(PassNo); 38808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 38908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // If we're in -debug-pass=Executions mode, construct the SCC node list, 39008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // otherwise avoid constructing this string as it is expensive. 39108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (isPassDebuggingExecutionsOrMore()) { 39208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner std::string Functions; 39308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner #ifndef NDEBUG 39408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner raw_string_ostream OS(Functions); 39508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner for (CallGraphSCC::iterator I = CurSCC.begin(), E = CurSCC.end(); 39608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner I != E; ++I) { 39708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (I != CurSCC.begin()) OS << ", "; 39808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner (*I)->print(OS); 39908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } 40008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner OS.flush(); 40108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner #endif 40208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner dumpPassInfo(P, EXECUTION_MSG, ON_CG_MSG, Functions); 40308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } 40408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner dumpRequiredSet(P); 40508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 40608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner initializeAnalysisImpl(P); 40708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 40808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // Actually run this pass on the current SCC. 40908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner Changed |= RunPassOnSCC(P, CurSCC, CG, 41008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner CallGraphUpToDate, DevirtualizedCall); 41108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 41208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (Changed) 41308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner dumpPassInfo(P, MODIFICATION_MSG, ON_CG_MSG, ""); 41408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner dumpPreservedSet(P); 41508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 41608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner verifyPreservedAnalysis(P); 41708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner removeNotPreservedAnalysis(P); 41808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner recordAvailableAnalysis(P); 41908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner removeDeadPasses(P, "", ON_CG_MSG); 42008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } 42108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 42208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // If the callgraph was left out of date (because the last pass run was a 42308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // functionpass), refresh it before we move on to the next SCC. 42408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (!CallGraphUpToDate) 42508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner DevirtualizedCall |= RefreshCallGraph(CurSCC, CG, false); 42608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner return Changed; 427be577659d3c1222cc58c33628c0baddb94d241abChris Lattner} 428f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner 42975f9abf51706242a745e05841598f68e64143494Devang Patel/// run - Execute all of the passes scheduled for execution. Keep track of 43075f9abf51706242a745e05841598f68e64143494Devang Patel/// whether any of the passes modifies the module, and if so, return true. 43175f9abf51706242a745e05841598f68e64143494Devang Patelbool CGPassManager::runOnModule(Module &M) { 43236b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph(); 433905c7e9a0459ffdffbee3e6fffe0dbf5e5c9583cBill Wendling bool Changed = doInitialization(CG); 43408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 435f3a1c15b750c63accd3597b42d73792458b247a9Chris Lattner // Walk the callgraph in bottom-up SCC order. 436a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner scc_iterator<CallGraph*> CGI = scc_begin(&CG); 437a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner 438a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner CallGraphSCC CurSCC(&CGI); 439a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner while (!CGI.isAtEnd()) { 4405095e3d1d1caef8d573534d369e37277c623064cChris Lattner // Copy the current SCC and increment past it so that the pass can hack 4415095e3d1d1caef8d573534d369e37277c623064cChris Lattner // on the SCC if it wants to without invalidating our iterator. 442dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines const std::vector<CallGraphNode *> &NodeVec = *CGI; 443dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines CurSCC.initialize(NodeVec.data(), NodeVec.data() + NodeVec.size()); 4445095e3d1d1caef8d573534d369e37277c623064cChris Lattner ++CGI; 4455095e3d1d1caef8d573534d369e37277c623064cChris Lattner 44608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // At the top level, we run all the passes in this pass manager on the 44708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // functions in this SCC. However, we support iterative compilation in the 44808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // case where a function pass devirtualizes a call to a function. For 44908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // example, it is very common for a function pass (often GVN or instcombine) 45008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // to eliminate the addressing that feeds into a call. With that improved 45108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // information, we would like the call to be an inline candidate, infer 45208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // mod-ref information etc. 45308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // 45408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // Because of this, we allow iteration up to a specified iteration count. 45508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // This only happens in the case of a devirtualized call, so we only burn 45608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // compile time in the case that we're making progress. We also have a hard 45708e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner // iteration count limit in case there is crazy code. 45808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner unsigned Iteration = 0; 45908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner bool DevirtualizedCall = false; 46008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner do { 461b61789d4dd851c2481d0ad95c7a710d567fb86f7Chris Lattner DEBUG(if (Iteration) 462b61789d4dd851c2481d0ad95c7a710d567fb86f7Chris Lattner dbgs() << " SCCPASSMGR: Re-visiting SCC, iteration #" 463b61789d4dd851c2481d0ad95c7a710d567fb86f7Chris Lattner << Iteration << '\n'); 46408e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner DevirtualizedCall = false; 46508e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner Changed |= RunAllPassesOnSCC(CurSCC, CG, DevirtualizedCall); 46608e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner } while (Iteration++ < MaxIterations && DevirtualizedCall); 467be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 46808e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (DevirtualizedCall) 46908e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner DEBUG(dbgs() << " CGSCCPASSMGR: Stopped iteration after " << Iteration 47008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner << " times, due to -max-cg-scc-iterations\n"); 47108e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 47208e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner if (Iteration > MaxSCCIterations) 47308e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner MaxSCCIterations = Iteration; 474be577659d3c1222cc58c33628c0baddb94d241abChris Lattner 47575f9abf51706242a745e05841598f68e64143494Devang Patel } 476905c7e9a0459ffdffbee3e6fffe0dbf5e5c9583cBill Wendling Changed |= doFinalization(CG); 47775f9abf51706242a745e05841598f68e64143494Devang Patel return Changed; 47875f9abf51706242a745e05841598f68e64143494Devang Patel} 47975f9abf51706242a745e05841598f68e64143494Devang Patel 48008e322db8a544d100f7518cfbd39ef8c13067698Chris Lattner 48175f9abf51706242a745e05841598f68e64143494Devang Patel/// Initialize CG 482905c7e9a0459ffdffbee3e6fffe0dbf5e5c9583cBill Wendlingbool CGPassManager::doInitialization(CallGraph &CG) { 48375f9abf51706242a745e05841598f68e64143494Devang Patel bool Changed = false; 4845a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner for (unsigned i = 0, e = getNumContainedPasses(); i != e; ++i) { 4855a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner if (PMDataManager *PM = getContainedPass(i)->getAsPMDataManager()) { 4865a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner assert(PM->getPassManagerType() == PMT_FunctionPassManager && 4875a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner "Invalid CGPassManager member"); 4885a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner Changed |= ((FPPassManager*)PM)->doInitialization(CG.getModule()); 4898968a0776801c5662863b3a461550aa361f69ba3Nick Lewycky } else { 4905a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner Changed |= ((CallGraphSCCPass*)getContainedPass(i))->doInitialization(CG); 4918968a0776801c5662863b3a461550aa361f69ba3Nick Lewycky } 49275f9abf51706242a745e05841598f68e64143494Devang Patel } 49375f9abf51706242a745e05841598f68e64143494Devang Patel return Changed; 49475f9abf51706242a745e05841598f68e64143494Devang Patel} 49575f9abf51706242a745e05841598f68e64143494Devang Patel 49675f9abf51706242a745e05841598f68e64143494Devang Patel/// Finalize CG 497905c7e9a0459ffdffbee3e6fffe0dbf5e5c9583cBill Wendlingbool CGPassManager::doFinalization(CallGraph &CG) { 49875f9abf51706242a745e05841598f68e64143494Devang Patel bool Changed = false; 4995a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner for (unsigned i = 0, e = getNumContainedPasses(); i != e; ++i) { 5005a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner if (PMDataManager *PM = getContainedPass(i)->getAsPMDataManager()) { 5015a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner assert(PM->getPassManagerType() == PMT_FunctionPassManager && 5025a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner "Invalid CGPassManager member"); 5035a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner Changed |= ((FPPassManager*)PM)->doFinalization(CG.getModule()); 5048968a0776801c5662863b3a461550aa361f69ba3Nick Lewycky } else { 5055a66cb9a4450e5b7b0f5f586ab47a529c478223bChris Lattner Changed |= ((CallGraphSCCPass*)getContainedPass(i))->doFinalization(CG); 5068968a0776801c5662863b3a461550aa361f69ba3Nick Lewycky } 50775f9abf51706242a745e05841598f68e64143494Devang Patel } 50875f9abf51706242a745e05841598f68e64143494Devang Patel return Changed; 50975f9abf51706242a745e05841598f68e64143494Devang Patel} 51075f9abf51706242a745e05841598f68e64143494Devang Patel 511c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner//===----------------------------------------------------------------------===// 5122decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner// CallGraphSCC Implementation 5132decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner//===----------------------------------------------------------------------===// 5142decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner 515a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner/// ReplaceNode - This informs the SCC and the pass manager that the specified 516a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner/// Old node has been deleted, and New is to be used in its place. 517a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattnervoid CallGraphSCC::ReplaceNode(CallGraphNode *Old, CallGraphNode *New) { 518a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner assert(Old != New && "Should not replace node with self"); 519a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner for (unsigned i = 0; ; ++i) { 520a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner assert(i != Nodes.size() && "Node not in SCC"); 521a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner if (Nodes[i] != Old) continue; 522a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner Nodes[i] = New; 523a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner break; 524a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner } 525bde0bb5f882ae708ca70a42bdd3a9805e63f6fb7Chris Lattner 526bde0bb5f882ae708ca70a42bdd3a9805e63f6fb7Chris Lattner // Update the active scc_iterator so that it doesn't contain dangling 527bde0bb5f882ae708ca70a42bdd3a9805e63f6fb7Chris Lattner // pointers to the old CallGraphNode. 528bde0bb5f882ae708ca70a42bdd3a9805e63f6fb7Chris Lattner scc_iterator<CallGraph*> *CGI = (scc_iterator<CallGraph*>*)Context; 529bde0bb5f882ae708ca70a42bdd3a9805e63f6fb7Chris Lattner CGI->ReplaceNode(Old, New); 530a3dfc646b4d772979f8994c07eeee6af57480d34Chris Lattner} 5312decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner 5322decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner 5332decb22222cac46bb1d9163e7b89d7e5be8ef65fChris Lattner//===----------------------------------------------------------------------===// 534c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner// CallGraphSCCPass Implementation 535c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner//===----------------------------------------------------------------------===// 5365c8aa950fe3484b6e115647328c196f8be64f9edDavid Greene 537d9f10c3d11997bc7e3d1b3da3baabae47445d5c6Devang Patel/// Assign pass manager to manage this pass. 53897fd2439f2b30b575cdd67eef52e03937d483680Devang Patelvoid CallGraphSCCPass::assignPassManager(PMStack &PMS, 539bed2946a96ecb15b0b636fa74cb26ce61b1c648eAnton Korobeynikov PassManagerType PreferredType) { 54097fd2439f2b30b575cdd67eef52e03937d483680Devang Patel // Find CGPassManager 54120d824b7dfea987775586d9de56c7448cc2cc44dDuncan Sands while (!PMS.empty() && 54220d824b7dfea987775586d9de56c7448cc2cc44dDuncan Sands PMS.top()->getPassManagerType() > PMT_CallGraphPassManager) 54320d824b7dfea987775586d9de56c7448cc2cc44dDuncan Sands PMS.pop(); 54497fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 54577c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner assert(!PMS.empty() && "Unable to handle Call Graph Pass"); 54677c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner CGPassManager *CGP; 54777c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner 54877c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner if (PMS.top()->getPassManagerType() == PMT_CallGraphPassManager) 54977c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner CGP = (CGPassManager*)PMS.top(); 55077c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner else { 55177c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner // Create new Call Graph SCC Pass Manager if it does not exist. 55277c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner assert(!PMS.empty() && "Unable to create Call Graph Pass Manager"); 55397fd2439f2b30b575cdd67eef52e03937d483680Devang Patel PMDataManager *PMD = PMS.top(); 55497fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 55597fd2439f2b30b575cdd67eef52e03937d483680Devang Patel // [1] Create new Call Graph Pass Manager 5560e122d1c2422285c872f68fc0ae1f7e5d2739572Andrew Trick CGP = new CGPassManager(); 55797fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 55897fd2439f2b30b575cdd67eef52e03937d483680Devang Patel // [2] Set up new manager's top level manager 55997fd2439f2b30b575cdd67eef52e03937d483680Devang Patel PMTopLevelManager *TPM = PMD->getTopLevelManager(); 56097fd2439f2b30b575cdd67eef52e03937d483680Devang Patel TPM->addIndirectPassManager(CGP); 56197fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 56297fd2439f2b30b575cdd67eef52e03937d483680Devang Patel // [3] Assign manager to manage this new manager. This may create 56397fd2439f2b30b575cdd67eef52e03937d483680Devang Patel // and push new managers into PMS 56477c95ed74a4d5f122b3c9810209a0190dbf17504Chris Lattner Pass *P = CGP; 56525e681ac221e83a7ebead99b4d3d88f1b3ab49bdDevang Patel TPM->schedulePass(P); 56697fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 56797fd2439f2b30b575cdd67eef52e03937d483680Devang Patel // [4] Push new manager into PMS 56897fd2439f2b30b575cdd67eef52e03937d483680Devang Patel PMS.push(CGP); 56997fd2439f2b30b575cdd67eef52e03937d483680Devang Patel } 57097fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 57197fd2439f2b30b575cdd67eef52e03937d483680Devang Patel CGP->add(this); 57297fd2439f2b30b575cdd67eef52e03937d483680Devang Patel} 57397fd2439f2b30b575cdd67eef52e03937d483680Devang Patel 5744a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner/// getAnalysisUsage - For this class, we declare that we require and preserve 5754a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner/// the call graph. If the derived class implements this method, it should 5764a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner/// always explicitly call the implementation here. 5774a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattnervoid CallGraphSCCPass::getAnalysisUsage(AnalysisUsage &AU) const { 57836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines AU.addRequired<CallGraphWrapperPass>(); 57936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines AU.addPreserved<CallGraphWrapperPass>(); 5804a81067a84e18c44898149f5afdbaa3e18b3e821Chris Lattner} 581c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 582c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 583c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner//===----------------------------------------------------------------------===// 584c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner// PrintCallGraphPass Implementation 585c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner//===----------------------------------------------------------------------===// 586c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 587c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattnernamespace { 588c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner /// PrintCallGraphPass - Print a Module corresponding to a call graph. 589c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner /// 590c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner class PrintCallGraphPass : public CallGraphSCCPass { 591c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner std::string Banner; 592c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner raw_ostream &Out; // raw_ostream to print on. 593c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 594c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner public: 595c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner static char ID; 596c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner PrintCallGraphPass(const std::string &B, raw_ostream &o) 59790c579de5a383cee278acc3f7e7b9d0a656e6a35Owen Anderson : CallGraphSCCPass(ID), Banner(B), Out(o) {} 59836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines 59936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void getAnalysisUsage(AnalysisUsage &AU) const override { 600c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner AU.setPreservesAll(); 601c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner } 60236b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines 60336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines bool runOnSCC(CallGraphSCC &SCC) override { 604c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner Out << Banner; 605cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) { 606cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines if ((*I)->getFunction()) 607cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines (*I)->getFunction()->print(Out); 608cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines else 609cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines Out << "\nPrinting <null> Function\n"; 610cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines } 611c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner return false; 612c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner } 613c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner }; 614c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 615c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner} // end anonymous namespace. 616c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 617c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattnerchar PrintCallGraphPass::ID = 0; 618c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 619c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris LattnerPass *CallGraphSCCPass::createPrinterPass(raw_ostream &O, 620c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner const std::string &Banner) const { 621c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner return new PrintCallGraphPass(Banner, O); 622c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner} 623c93760c3e55db7e5fadbbf0f75fa3587cd8bb9dcChris Lattner 624