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
21
#include "llvm/ADT/DenseMap.h"
22
#include "llvm/ADT/Twine.h"
43
template <typename T> class SmallVectorImpl;
45
/// CloneModule - Return an exact copy of the specified module
47
Module *CloneModule(const Module *M);
48
Module *CloneModule(const Module *M, DenseMap<const Value*, Value*> &ValueMap);
50
/// ClonedCodeInfo - This struct can be used to capture information about code
51
/// being cloned, while it is being cloned.
52
struct ClonedCodeInfo {
53
/// ContainsCalls - This is set to true if the cloned code contains a normal
57
/// ContainsUnwinds - This is set to true if the cloned code contains an
58
/// unwind instruction.
61
/// ContainsDynamicAllocas - This is set to true if the cloned code contains
62
/// a 'dynamic' alloca. Dynamic allocas are allocas that are either not in
63
/// the entry block or they are in the entry block but are not a constant
65
bool ContainsDynamicAllocas;
68
ContainsCalls = false;
69
ContainsUnwinds = false;
70
ContainsDynamicAllocas = false;
75
/// CloneBasicBlock - Return a copy of the specified basic block, but without
76
/// embedding the block into a particular function. The block returned is an
77
/// exact copy of the specified basic block, without any remapping having been
78
/// performed. Because of this, this is only suitable for applications where
79
/// the basic block will be inserted into the same function that it was cloned
80
/// from (loop unrolling would use this, for example).
82
/// Also, note that this function makes a direct copy of the basic block, and
83
/// can thus produce illegal LLVM code. In particular, it will copy any PHI
84
/// nodes from the original block, even though there are no predecessors for the
85
/// newly cloned block (thus, phi nodes will have to be updated). Also, this
86
/// block will branch to the old successors of the original block: these
87
/// successors will have to have any PHI nodes updated to account for the new
90
/// The correlation between instructions in the source and result basic blocks
91
/// is recorded in the ValueMap map.
93
/// If you have a particular suffix you'd like to use to add to any cloned
94
/// names, specify it as the optional third parameter.
96
/// If you would like the basic block to be auto-inserted into the end of a
97
/// function, you can specify it as the optional fourth parameter.
99
/// If you would like to collect additional information about the cloned
100
/// function, you can specify a ClonedCodeInfo object with the optional fifth
103
BasicBlock *CloneBasicBlock(const BasicBlock *BB,
104
DenseMap<const Value*, Value*> &ValueMap,
105
const Twine &NameSuffix = "", Function *F = 0,
106
ClonedCodeInfo *CodeInfo = 0);
109
/// CloneLoop - Clone Loop. Clone dominator info for loop insiders. Populate
110
/// ValueMap using old blocks to new blocks mapping.
111
Loop *CloneLoop(Loop *L, LPPassManager *LPM, LoopInfo *LI,
112
DenseMap<const Value *, Value *> &ValueMap, Pass *P);
114
/// CloneFunction - Return a copy of the specified function, but without
115
/// embedding the function into another module. Also, any references specified
116
/// in the ValueMap are changed to refer to their mapped value instead of the
117
/// original one. If any of the arguments to the function are in the ValueMap,
118
/// the arguments are deleted from the resultant function. The ValueMap is
119
/// updated to include mappings from all of the instructions and basicblocks in
120
/// the function from their old to new values. The final argument captures
121
/// information about the cloned code if non-null.
123
Function *CloneFunction(const Function *F,
124
DenseMap<const Value*, Value*> &ValueMap,
125
ClonedCodeInfo *CodeInfo = 0);
127
/// CloneFunction - Version of the function that doesn't need the ValueMap.
129
inline Function *CloneFunction(const Function *F, ClonedCodeInfo *CodeInfo = 0){
130
DenseMap<const Value*, Value*> ValueMap;
131
return CloneFunction(F, ValueMap, CodeInfo);
134
/// Clone OldFunc into NewFunc, transforming the old arguments into references
135
/// to ArgMap values. Note that if NewFunc already has basic blocks, the ones
136
/// cloned into it will be added to the end of the function. This function
137
/// fills in a list of return instructions, and can optionally append the
138
/// specified suffix to all values cloned.
140
void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
141
DenseMap<const Value*, Value*> &ValueMap,
142
SmallVectorImpl<ReturnInst*> &Returns,
143
const char *NameSuffix = "",
144
ClonedCodeInfo *CodeInfo = 0);
146
/// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto,
147
/// except that it does some simple constant prop and DCE on the fly. The
148
/// effect of this is to copy significantly less code in cases where (for
149
/// example) a function call with constant arguments is inlined, and those
150
/// constant arguments cause a significant amount of code in the callee to be
151
/// dead. Since this doesn't produce an exactly copy of the input, it can't be
152
/// used for things like CloneFunction or CloneModule.
153
void CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc,
154
DenseMap<const Value*, Value*> &ValueMap,
155
SmallVectorImpl<ReturnInst*> &Returns,
156
const char *NameSuffix = "",
157
ClonedCodeInfo *CodeInfo = 0,
158
const TargetData *TD = 0,
159
Instruction *TheCall = 0);
161
/// InlineFunction - This function inlines the called function into the basic
162
/// block of the caller. This returns false if it is not possible to inline
163
/// this call. The program is still in a well defined state if this occurs
166
/// Note that this only does one level of inlining. For example, if the
167
/// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
168
/// exists in the instruction stream. Similiarly this will inline a recursive
169
/// function by one level.
171
/// If a non-null callgraph pointer is provided, these functions update the
172
/// CallGraph to represent the program after inlining.
174
/// If StaticAllocas is non-null, InlineFunction populates it with all of the
175
/// static allocas that it inlines into the caller.
177
bool InlineFunction(CallInst *C, CallGraph *CG = 0, const TargetData *TD = 0,
178
SmallVectorImpl<AllocaInst*> *StaticAllocas = 0);
179
bool InlineFunction(InvokeInst *II, CallGraph *CG = 0, const TargetData *TD = 0,
180
SmallVectorImpl<AllocaInst*> *StaticAllocas = 0);
181
bool InlineFunction(CallSite CS, CallGraph *CG = 0, const TargetData *TD = 0,
182
SmallVectorImpl<AllocaInst*> *StaticAllocas = 0);
184
} // End llvm namespace