1 //===- Cloning.h - Clone various parts of LLVM programs ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
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
37 /// CloneModule - Return an exact copy of the specified module
39 Module *CloneModule(const Module *M);
41 /// ClonedCodeInfo - This struct can be used to capture information about code
42 /// being cloned, while it is being cloned.
43 struct ClonedCodeInfo {
44 /// ContainsCalls - This is set to true if the cloned code contains a normal
48 /// ContainsUnwinds - This is set to true if the cloned code contains an
49 /// unwind instruction.
52 /// ContainsDynamicAllocas - This is set to true if the cloned code contains
53 /// a 'dynamic' alloca. Dynamic allocas are allocas that are either not in
54 /// the entry block or they are in the entry block but are not a constant
56 bool ContainsDynamicAllocas;
59 ContainsCalls = false;
60 ContainsUnwinds = false;
61 ContainsDynamicAllocas = false;
66 /// CloneBasicBlock - Return a copy of the specified basic block, but without
67 /// embedding the block into a particular function. The block returned is an
68 /// exact copy of the specified basic block, without any remapping having been
69 /// performed. Because of this, this is only suitable for applications where
70 /// the basic block will be inserted into the same function that it was cloned
71 /// from (loop unrolling would use this, for example).
73 /// Also, note that this function makes a direct copy of the basic block, and
74 /// can thus produce illegal LLVM code. In particular, it will copy any PHI
75 /// nodes from the original block, even though there are no predecessors for the
76 /// newly cloned block (thus, phi nodes will have to be updated). Also, this
77 /// block will branch to the old successors of the original block: these
78 /// successors will have to have any PHI nodes updated to account for the new
81 /// The correlation between instructions in the source and result basic blocks
82 /// is recorded in the ValueMap map.
84 /// If you have a particular suffix you'd like to use to add to any cloned
85 /// names, specify it as the optional third parameter.
87 /// If you would like the basic block to be auto-inserted into the end of a
88 /// function, you can specify it as the optional fourth parameter.
90 /// If you would like to collect additional information about the cloned
91 /// function, you can specify a ClonedCodeInfo object with the optional fifth
94 BasicBlock *CloneBasicBlock(const BasicBlock *BB,
95 std::map<const Value*, Value*> &ValueMap,
96 const char *NameSuffix = "", Function *F = 0,
97 ClonedCodeInfo *CodeInfo = 0);
100 /// CloneFunction - Return a copy of the specified function, but without
101 /// embedding the function into another module. Also, any references specified
102 /// in the ValueMap are changed to refer to their mapped value instead of the
103 /// original one. If any of the arguments to the function are in the ValueMap,
104 /// the arguments are deleted from the resultant function. The ValueMap is
105 /// updated to include mappings from all of the instructions and basicblocks in
106 /// the function from their old to new values. The final argument captures
107 /// information about the cloned code if non-null.
109 Function *CloneFunction(const Function *F,
110 std::map<const Value*, Value*> &ValueMap,
111 ClonedCodeInfo *CodeInfo = 0);
113 /// CloneFunction - Version of the function that doesn't need the ValueMap.
115 inline Function *CloneFunction(const Function *F, ClonedCodeInfo *CodeInfo = 0){
116 std::map<const Value*, Value*> ValueMap;
117 return CloneFunction(F, ValueMap, CodeInfo);
120 /// Clone OldFunc into NewFunc, transforming the old arguments into references
121 /// to ArgMap values. Note that if NewFunc already has basic blocks, the ones
122 /// cloned into it will be added to the end of the function. This function
123 /// fills in a list of return instructions, and can optionally append the
124 /// specified suffix to all values cloned.
126 void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
127 std::map<const Value*, Value*> &ValueMap,
128 std::vector<ReturnInst*> &Returns,
129 const char *NameSuffix = "",
130 ClonedCodeInfo *CodeInfo = 0);
133 /// CloneTraceInto - Clone T into NewFunc. Original<->clone mapping is
134 /// saved in ValueMap.
136 void CloneTraceInto(Function *NewFunc, Trace &T,
137 std::map<const Value*, Value*> &ValueMap,
138 const char *NameSuffix);
140 /// CloneTrace - Returns a copy of the specified trace.
141 /// It takes a vector of basic blocks clones the basic blocks, removes internal
142 /// phi nodes, adds it to the same function as the original (although there is
143 /// no jump to it) and returns the new vector of basic blocks.
144 std::vector<BasicBlock *> CloneTrace(const std::vector<BasicBlock*> &origTrace);
146 /// InlineFunction - This function inlines the called function into the basic
147 /// block of the caller. This returns false if it is not possible to inline
148 /// this call. The program is still in a well defined state if this occurs
151 /// Note that this only does one level of inlining. For example, if the
152 /// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
153 /// exists in the instruction stream. Similiarly this will inline a recursive
154 /// function by one level.
156 /// If a non-null callgraph pointer is provided, these functions update the
157 /// CallGraph to represent the program after inlining.
159 bool InlineFunction(CallInst *C, CallGraph *CG = 0);
160 bool InlineFunction(InvokeInst *II, CallGraph *CG = 0);
161 bool InlineFunction(CallSite CS, CallGraph *CG = 0);
163 } // End llvm namespace