a01cd06a8d8fce19a1850557ed380d802cee0584
[oota-llvm.git] / include / llvm / Transforms / Utils / Local.h
1 //===-- Local.h - Functions to perform local transformations -----*- C++ -*--=//
2 //
3 // This family of functions perform various local transformations to the
4 // program.
5 //
6 //===----------------------------------------------------------------------===//
7
8 #ifndef LLVM_TRANSFORMS_UTILS_LOCAL_H
9 #define LLVM_TRANSFORMS_UTILS_LOCAL_H
10
11 #include "llvm/Function.h"
12 #include "llvm/BasicBlock.h"
13
14 //===----------------------------------------------------------------------===//
15 //  Local constant propogation...
16 //
17
18 // doConstantPropogation - Constant prop a specific instruction.  Returns true
19 // and potentially moves the iterator if constant propogation was performed.
20 //
21 bool doConstantPropogation(BasicBlock *BB, BasicBlock::iterator &I);
22
23 // ConstantFoldTerminator - If a terminator instruction is predicated on a
24 // constant value, convert it into an unconditional branch to the constant
25 // destination.  This is a nontrivial operation because the successors of this
26 // basic block must have their PHI nodes updated.
27 //
28 bool ConstantFoldTerminator(BasicBlock *BB, BasicBlock::iterator &I,
29                             TerminatorInst *T);
30
31
32 //===----------------------------------------------------------------------===//
33 //  Local dead code elimination...
34 //
35
36 // isInstructionTriviallyDead - Return true if the result produced by the
37 // instruction is not used, and the instruction has no side effects.
38 //
39 bool isInstructionTriviallyDead(Instruction *I);
40
41
42 // dceInstruction - Inspect the instruction at *BBI and figure out if it
43 // isTriviallyDead.  If so, remove the instruction and update the iterator to
44 // point to the instruction that immediately succeeded the original instruction.
45 //
46 bool dceInstruction(BasicBlock::InstListType &BBIL, BasicBlock::iterator &BBI);
47
48
49 //===----------------------------------------------------------------------===//
50 //  Control Flow Graph Restructuring...
51 //
52
53 // SimplifyCFG - This function is used to do simplification of a CFG.  For
54 // example, it adjusts branches to branches to eliminate the extra hop, it
55 // eliminates unreachable basic blocks, and does other "peephole" optimization
56 // of the CFG.  It returns true if a modification was made, and returns an 
57 // iterator that designates the first element remaining after the block that
58 // was deleted.
59 //
60 // WARNING:  The entry node of a method may not be simplified.
61 //
62 bool SimplifyCFG(Function::iterator &BBIt);
63
64 #endif