1 //===- PruneEH.cpp - Pass which deletes unused exception handlers ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a simple interprocedural pass which walks the
11 // call-graph, turning invoke instructions into calls, iff the callee cannot
12 // throw an exception, and marking functions 'nounwind' if they cannot throw.
13 // It implements this as a bottom-up traversal of the call-graph.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Transforms/IPO.h"
18 #include "llvm/ADT/SmallPtrSet.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/Statistic.h"
21 #include "llvm/Support/raw_ostream.h"
22 #include "llvm/Analysis/CallGraph.h"
23 #include "llvm/Analysis/CallGraphSCCPass.h"
24 #include "llvm/Analysis/EHPersonalities.h"
25 #include "llvm/IR/CFG.h"
26 #include "llvm/IR/Constants.h"
27 #include "llvm/IR/Function.h"
28 #include "llvm/IR/InlineAsm.h"
29 #include "llvm/IR/Instructions.h"
30 #include "llvm/IR/IntrinsicInst.h"
31 #include "llvm/IR/LLVMContext.h"
35 #define DEBUG_TYPE "prune-eh"
37 STATISTIC(NumRemoved, "Number of invokes removed");
38 STATISTIC(NumUnreach, "Number of noreturn calls optimized");
41 struct PruneEH : public CallGraphSCCPass {
42 static char ID; // Pass identification, replacement for typeid
43 PruneEH() : CallGraphSCCPass(ID) {
44 initializePruneEHPass(*PassRegistry::getPassRegistry());
47 // runOnSCC - Analyze the SCC, performing the transformation if possible.
48 bool runOnSCC(CallGraphSCC &SCC) override;
50 bool SimplifyFunction(Function *F);
51 void DeleteBasicBlock(BasicBlock *BB);
56 INITIALIZE_PASS_BEGIN(PruneEH, "prune-eh",
57 "Remove unused exception handling info", false, false)
58 INITIALIZE_PASS_DEPENDENCY(CallGraphWrapperPass)
59 INITIALIZE_PASS_END(PruneEH, "prune-eh",
60 "Remove unused exception handling info", false, false)
62 Pass *llvm::createPruneEHPass() { return new PruneEH(); }
65 bool PruneEH::runOnSCC(CallGraphSCC &SCC) {
66 SmallPtrSet<CallGraphNode *, 8> SCCNodes;
67 CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph();
68 bool MadeChange = false;
70 // Fill SCCNodes with the elements of the SCC. Used for quickly
71 // looking up whether a given CallGraphNode is in this SCC.
72 for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I)
75 // First pass, scan all of the functions in the SCC, simplifying them
76 // according to what we know.
77 for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I)
78 if (Function *F = (*I)->getFunction())
79 MadeChange |= SimplifyFunction(F);
81 // Next, check to see if any callees might throw or if there are any external
82 // functions in this SCC: if so, we cannot prune any functions in this SCC.
83 // Definitions that are weak and not declared non-throwing might be
84 // overridden at linktime with something that throws, so assume that.
85 // If this SCC includes the unwind instruction, we KNOW it throws, so
86 // obviously the SCC might throw.
88 bool SCCMightUnwind = false, SCCMightReturn = false;
89 for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end();
90 (!SCCMightUnwind || !SCCMightReturn) && I != E; ++I) {
91 Function *F = (*I)->getFunction();
93 SCCMightUnwind = true;
94 SCCMightReturn = true;
95 } else if (F->isDeclaration() || F->mayBeOverridden()) {
96 SCCMightUnwind |= !F->doesNotThrow();
97 SCCMightReturn |= !F->doesNotReturn();
99 bool CheckUnwind = !SCCMightUnwind && !F->doesNotThrow();
100 bool CheckReturn = !SCCMightReturn && !F->doesNotReturn();
101 // Determine if we should scan for InlineAsm in a naked function as it
102 // is the only way to return without a ReturnInst. Only do this for
103 // no-inline functions as functions which may be inlined cannot
104 // meaningfully return via assembly.
105 bool CheckReturnViaAsm = CheckReturn &&
106 F->hasFnAttribute(Attribute::Naked) &&
107 F->hasFnAttribute(Attribute::NoInline);
109 if (!CheckUnwind && !CheckReturn)
112 for (const BasicBlock &BB : *F) {
113 const TerminatorInst *TI = BB.getTerminator();
114 if (CheckUnwind && TI->mayThrow()) {
115 SCCMightUnwind = true;
116 } else if (CheckReturn && isa<ReturnInst>(TI)) {
117 SCCMightReturn = true;
120 for (const Instruction &I : BB) {
121 if ((!CheckUnwind || SCCMightUnwind) &&
122 (!CheckReturnViaAsm || SCCMightReturn))
125 // Check to see if this function performs an unwind or calls an
126 // unwinding function.
127 if (CheckUnwind && !SCCMightUnwind && I.mayThrow()) {
128 bool InstMightUnwind = true;
129 if (const auto *CI = dyn_cast<CallInst>(&I)) {
130 if (Function *Callee = CI->getCalledFunction()) {
131 CallGraphNode *CalleeNode = CG[Callee];
132 // If the callee is outside our current SCC then we may throw
133 // because it might. If it is inside, do nothing.
134 if (SCCNodes.count(CalleeNode) > 0)
135 InstMightUnwind = false;
138 SCCMightUnwind |= InstMightUnwind;
140 if (CheckReturnViaAsm && !SCCMightReturn)
141 if (auto ICS = ImmutableCallSite(&I))
142 if (const auto *IA = dyn_cast<InlineAsm>(ICS.getCalledValue()))
143 if (IA->hasSideEffects())
144 SCCMightReturn = true;
147 if (SCCMightUnwind && SCCMightReturn)
153 // If the SCC doesn't unwind or doesn't throw, note this fact.
154 if (!SCCMightUnwind || !SCCMightReturn)
155 for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
156 AttrBuilder NewAttributes;
159 NewAttributes.addAttribute(Attribute::NoUnwind);
161 NewAttributes.addAttribute(Attribute::NoReturn);
163 Function *F = (*I)->getFunction();
164 const AttributeSet &PAL = F->getAttributes().getFnAttributes();
165 const AttributeSet &NPAL = AttributeSet::get(
166 F->getContext(), AttributeSet::FunctionIndex, NewAttributes);
170 F->addAttributes(AttributeSet::FunctionIndex, NPAL);
174 for (CallGraphSCC::iterator I = SCC.begin(), E = SCC.end(); I != E; ++I) {
175 // Convert any invoke instructions to non-throwing functions in this node
176 // into call instructions with a branch. This makes the exception blocks
178 if (Function *F = (*I)->getFunction())
179 MadeChange |= SimplifyFunction(F);
186 // SimplifyFunction - Given information about callees, simplify the specified
187 // function if we have invokes to non-unwinding functions or code after calls to
188 // no-return functions.
189 bool PruneEH::SimplifyFunction(Function *F) {
190 bool MadeChange = false;
191 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
192 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator()))
193 if (II->doesNotThrow() && canSimplifyInvokeNoUnwind(F)) {
195 SmallVector<Value*, 8> Args(CS.arg_begin(), CS.arg_end());
196 SmallVector<OperandBundleDef, 1> OpBundles;
197 II->getOperandBundlesAsDefs(OpBundles);
199 // Insert a call instruction before the invoke.
200 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, OpBundles,
203 Call->setCallingConv(II->getCallingConv());
204 Call->setAttributes(II->getAttributes());
205 Call->setDebugLoc(II->getDebugLoc());
207 // Anything that used the value produced by the invoke instruction
208 // now uses the value produced by the call instruction. Note that we
209 // do this even for void functions and calls with no uses so that the
210 // callgraph edge is updated.
211 II->replaceAllUsesWith(Call);
212 BasicBlock *UnwindBlock = II->getUnwindDest();
213 UnwindBlock->removePredecessor(II->getParent());
215 // Insert a branch to the normal destination right before the
217 BranchInst::Create(II->getNormalDest(), II);
219 // Finally, delete the invoke instruction!
220 BB->getInstList().pop_back();
222 // If the unwind block is now dead, nuke it.
223 if (pred_empty(UnwindBlock))
224 DeleteBasicBlock(UnwindBlock); // Delete the new BB.
230 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; )
231 if (CallInst *CI = dyn_cast<CallInst>(I++))
232 if (CI->doesNotReturn() && !isa<UnreachableInst>(I)) {
233 // This call calls a function that cannot return. Insert an
234 // unreachable instruction after it and simplify the code. Do this
235 // by splitting the BB, adding the unreachable, then deleting the
237 BasicBlock *New = BB->splitBasicBlock(I);
239 // Remove the uncond branch and add an unreachable.
240 BB->getInstList().pop_back();
241 new UnreachableInst(BB->getContext(), &*BB);
243 DeleteBasicBlock(New); // Delete the new BB.
253 /// DeleteBasicBlock - remove the specified basic block from the program,
254 /// updating the callgraph to reflect any now-obsolete edges due to calls that
256 void PruneEH::DeleteBasicBlock(BasicBlock *BB) {
257 assert(pred_empty(BB) && "BB is not dead!");
258 CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph();
260 CallGraphNode *CGN = CG[BB->getParent()];
261 for (BasicBlock::iterator I = BB->end(), E = BB->begin(); I != E; ) {
263 if (CallInst *CI = dyn_cast<CallInst>(I)) {
264 if (!isa<IntrinsicInst>(I))
265 CGN->removeCallEdgeFor(CI);
266 } else if (InvokeInst *II = dyn_cast<InvokeInst>(I))
267 CGN->removeCallEdgeFor(II);
269 I->replaceAllUsesWith(UndefValue::get(I->getType()));
272 // Get the list of successors of this block.
273 std::vector<BasicBlock*> Succs(succ_begin(BB), succ_end(BB));
275 for (unsigned i = 0, e = Succs.size(); i != e; ++i)
276 Succs[i]->removePredecessor(BB);
278 BB->eraseFromParent();