1 //===- Cloning.h - Clone various parts of LLVM programs ---------*- C++ -*-===//
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 defines various functions that are used to clone chunks of LLVM
11 // code for various purposes. This varies from copying whole modules into new
12 // modules, to cloning functions with different arguments, to inlining
13 // functions, to copying basic blocks to support loop unrolling or superblock
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_TRANSFORMS_UTILS_CLONING_H
19 #define LLVM_TRANSFORMS_UTILS_CLONING_H
22 #include "llvm/ADT/DenseMap.h"
40 template<class N> class LoopBase;
41 typedef LoopBase<BasicBlock> Loop;
43 /// CloneModule - Return an exact copy of the specified module
45 Module *CloneModule(const Module *M);
46 Module *CloneModule(const Module *M, DenseMap<const Value*, Value*> &ValueMap);
48 /// ClonedCodeInfo - This struct can be used to capture information about code
49 /// being cloned, while it is being cloned.
50 struct ClonedCodeInfo {
51 /// ContainsCalls - This is set to true if the cloned code contains a normal
55 /// ContainsUnwinds - This is set to true if the cloned code contains an
56 /// unwind instruction.
59 /// ContainsDynamicAllocas - This is set to true if the cloned code contains
60 /// a 'dynamic' alloca. Dynamic allocas are allocas that are either not in
61 /// the entry block or they are in the entry block but are not a constant
63 bool ContainsDynamicAllocas;
66 ContainsCalls = false;
67 ContainsUnwinds = false;
68 ContainsDynamicAllocas = false;
73 /// CloneBasicBlock - Return a copy of the specified basic block, but without
74 /// embedding the block into a particular function. The block returned is an
75 /// exact copy of the specified basic block, without any remapping having been
76 /// performed. Because of this, this is only suitable for applications where
77 /// the basic block will be inserted into the same function that it was cloned
78 /// from (loop unrolling would use this, for example).
80 /// Also, note that this function makes a direct copy of the basic block, and
81 /// can thus produce illegal LLVM code. In particular, it will copy any PHI
82 /// nodes from the original block, even though there are no predecessors for the
83 /// newly cloned block (thus, phi nodes will have to be updated). Also, this
84 /// block will branch to the old successors of the original block: these
85 /// successors will have to have any PHI nodes updated to account for the new
88 /// The correlation between instructions in the source and result basic blocks
89 /// is recorded in the ValueMap map.
91 /// If you have a particular suffix you'd like to use to add to any cloned
92 /// names, specify it as the optional third parameter.
94 /// If you would like the basic block to be auto-inserted into the end of a
95 /// function, you can specify it as the optional fourth parameter.
97 /// If you would like to collect additional information about the cloned
98 /// function, you can specify a ClonedCodeInfo object with the optional fifth
101 BasicBlock *CloneBasicBlock(const BasicBlock *BB,
102 DenseMap<const Value*, Value*> &ValueMap,
103 const char *NameSuffix = "", Function *F = 0,
104 ClonedCodeInfo *CodeInfo = 0);
107 /// CloneLoop - Clone Loop. Clone dominator info for loop insiders. Populate ValueMap
108 /// using old blocks to new blocks mapping.
109 Loop *CloneLoop(Loop *L, LPPassManager *LPM, LoopInfo *LI,
110 DenseMap<const Value *, Value *> &ValueMap, Pass *P);
112 /// CloneFunction - Return a copy of the specified function, but without
113 /// embedding the function into another module. Also, any references specified
114 /// in the ValueMap are changed to refer to their mapped value instead of the
115 /// original one. If any of the arguments to the function are in the ValueMap,
116 /// the arguments are deleted from the resultant function. The ValueMap is
117 /// updated to include mappings from all of the instructions and basicblocks in
118 /// the function from their old to new values. The final argument captures
119 /// information about the cloned code if non-null.
121 Function *CloneFunction(const Function *F,
122 DenseMap<const Value*, Value*> &ValueMap,
123 ClonedCodeInfo *CodeInfo = 0);
125 /// CloneFunction - Version of the function that doesn't need the ValueMap.
127 inline Function *CloneFunction(const Function *F, ClonedCodeInfo *CodeInfo = 0){
128 DenseMap<const Value*, Value*> ValueMap;
129 return CloneFunction(F, ValueMap, CodeInfo);
132 /// Clone OldFunc into NewFunc, transforming the old arguments into references
133 /// to ArgMap values. Note that if NewFunc already has basic blocks, the ones
134 /// cloned into it will be added to the end of the function. This function
135 /// fills in a list of return instructions, and can optionally append the
136 /// specified suffix to all values cloned.
138 void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
139 DenseMap<const Value*, Value*> &ValueMap,
140 std::vector<ReturnInst*> &Returns,
141 const char *NameSuffix = "",
142 ClonedCodeInfo *CodeInfo = 0);
144 /// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto,
145 /// except that it does some simple constant prop and DCE on the fly. The
146 /// effect of this is to copy significantly less code in cases where (for
147 /// example) a function call with constant arguments is inlined, and those
148 /// constant arguments cause a significant amount of code in the callee to be
149 /// dead. Since this doesn't produce an exactly copy of the input, it can't be
150 /// used for things like CloneFunction or CloneModule.
151 void CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc,
152 DenseMap<const Value*, Value*> &ValueMap,
153 std::vector<ReturnInst*> &Returns,
154 const char *NameSuffix = "",
155 ClonedCodeInfo *CodeInfo = 0,
156 const TargetData *TD = 0);
159 /// CloneTraceInto - Clone T into NewFunc. Original<->clone mapping is
160 /// saved in ValueMap.
162 void CloneTraceInto(Function *NewFunc, Trace &T,
163 DenseMap<const Value*, Value*> &ValueMap,
164 const char *NameSuffix);
166 /// CloneTrace - Returns a copy of the specified trace.
167 /// It takes a vector of basic blocks clones the basic blocks, removes internal
168 /// phi nodes, adds it to the same function as the original (although there is
169 /// no jump to it) and returns the new vector of basic blocks.
170 std::vector<BasicBlock *> CloneTrace(const std::vector<BasicBlock*> &origTrace);
172 /// InlineFunction - This function inlines the called function into the basic
173 /// block of the caller. This returns false if it is not possible to inline
174 /// this call. The program is still in a well defined state if this occurs
177 /// Note that this only does one level of inlining. For example, if the
178 /// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
179 /// exists in the instruction stream. Similiarly this will inline a recursive
180 /// function by one level.
182 /// If a non-null callgraph pointer is provided, these functions update the
183 /// CallGraph to represent the program after inlining.
185 bool InlineFunction(CallInst *C, CallGraph *CG = 0, const TargetData *TD = 0);
186 bool InlineFunction(InvokeInst *II, CallGraph *CG = 0, const TargetData *TD =0);
187 bool InlineFunction(CallSite CS, CallGraph *CG = 0, const TargetData *TD = 0);
189 } // End llvm namespace