Fix an infinite loop bug that Vladimir Prus identified.
[oota-llvm.git] / include / llvm / Transforms / Utils / UnifyFunctionExitNodes.h
1 //===-- UnifyFunctionExitNodes.h - Ensure fn's have one return --*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This pass is used to ensure that functions have at most one return and one
11 // unwind instruction in them.  Additionally, it keeps track of which node is
12 // the new exit node of the CFG.  If there are no return or unwind instructions
13 // in the function, the getReturnBlock/getUnwindBlock methods will return a null
14 // pointer.
15 //
16 //===----------------------------------------------------------------------===//
17
18 #ifndef LLVM_TRANSFORMS_UNIFYFUNCTIONEXITNODES_H
19 #define LLVM_TRANSFORMS_UNIFYFUNCTIONEXITNODES_H
20
21 #include "llvm/Pass.h"
22
23 namespace llvm {
24
25 struct UnifyFunctionExitNodes : public FunctionPass {
26   BasicBlock *ReturnBlock, *UnwindBlock, *UnreachableBlock;
27 public:
28   UnifyFunctionExitNodes() : ReturnBlock(0), UnwindBlock(0) {}
29
30   // We can preserve non-critical-edgeness when we unify function exit nodes
31   virtual void getAnalysisUsage(AnalysisUsage &AU) const;
32
33   // getReturn|Unwind|UnreachableBlock - Return the new single (or nonexistant)
34   // return, unwind, or unreachable  basic blocks in the CFG.
35   //
36   BasicBlock *getReturnBlock() const { return ReturnBlock; }
37   BasicBlock *getUnwindBlock() const { return UnwindBlock; }
38   BasicBlock *getUnreachableBlock() const { return UnreachableBlock; }
39
40   virtual bool runOnFunction(Function &F);
41 };
42
43 Pass *createUnifyFunctionExitNodesPass();
44
45 } // End llvm namespace
46
47 #endif