include/llvm/Transforms/Utils/Cloning.h

   1 //===- Cloning.h - Clone various parts of LLVM programs ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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
  14 // formation, etc.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_TRANSFORMS_UTILS_CLONING_H
  19 #define LLVM_TRANSFORMS_UTILS_CLONING_H
  20
  21 #include "llvm/ADT/ValueMap.h"
  22 #include "llvm/ADT/SmallVector.h"
  23 #include "llvm/ADT/Twine.h"
  24 #include "llvm/Support/ValueHandle.h"
  25 #include "llvm/Transforms/Utils/ValueMapper.h"
  26
  27 namespace llvm {
  28
  29 class Module;
  30 class Function;
  31 class Instruction;
  32 class Pass;
  33 class LPPassManager;
  34 class BasicBlock;
  35 class Value;
  36 class CallInst;
  37 class InvokeInst;
  38 class ReturnInst;
  39 class CallSite;
  40 class Trace;
  41 class CallGraph;
  42 class TargetData;
  43 class Loop;
  44 class LoopInfo;
  45 class AllocaInst;
  46
  47 /// CloneModule - Return an exact copy of the specified module
  48 ///
  49 Module *CloneModule(const Module *M);
  50 Module *CloneModule(const Module *M, ValueToValueMapTy &VMap);
  51
  52 /// ClonedCodeInfo - This struct can be used to capture information about code
  53 /// being cloned, while it is being cloned.
  54 struct ClonedCodeInfo {
  55   /// ContainsCalls - This is set to true if the cloned code contains a normal
  56   /// call instruction.
  57   bool ContainsCalls;
  58
  59   /// ContainsUnwinds - This is set to true if the cloned code contains an
  60   /// unwind instruction.
  61   bool ContainsUnwinds;
  62
  63   /// ContainsDynamicAllocas - This is set to true if the cloned code contains
  64   /// a 'dynamic' alloca.  Dynamic allocas are allocas that are either not in
  65   /// the entry block or they are in the entry block but are not a constant
  66   /// size.
  67   bool ContainsDynamicAllocas;
  68
  69   ClonedCodeInfo() {
  70     ContainsCalls = false;
  71     ContainsUnwinds = false;
  72     ContainsDynamicAllocas = false;
  73   }
  74 };
  75
  76
  77 /// CloneBasicBlock - Return a copy of the specified basic block, but without
  78 /// embedding the block into a particular function.  The block returned is an
  79 /// exact copy of the specified basic block, without any remapping having been
  80 /// performed.  Because of this, this is only suitable for applications where
  81 /// the basic block will be inserted into the same function that it was cloned
  82 /// from (loop unrolling would use this, for example).
  83 ///
  84 /// Also, note that this function makes a direct copy of the basic block, and
  85 /// can thus produce illegal LLVM code.  In particular, it will copy any PHI
  86 /// nodes from the original block, even though there are no predecessors for the
  87 /// newly cloned block (thus, phi nodes will have to be updated).  Also, this
  88 /// block will branch to the old successors of the original block: these
  89 /// successors will have to have any PHI nodes updated to account for the new
  90 /// incoming edges.
  91 ///
  92 /// The correlation between instructions in the source and result basic blocks
  93 /// is recorded in the VMap map.
  94 ///
  95 /// If you have a particular suffix you'd like to use to add to any cloned
  96 /// names, specify it as the optional third parameter.
  97 ///
  98 /// If you would like the basic block to be auto-inserted into the end of a
  99 /// function, you can specify it as the optional fourth parameter.
 100 ///
 101 /// If you would like to collect additional information about the cloned
 102 /// function, you can specify a ClonedCodeInfo object with the optional fifth
 103 /// parameter.
 104 ///
 105 BasicBlock *CloneBasicBlock(const BasicBlock *BB,
 106                             ValueToValueMapTy &VMap,
 107                             const Twine &NameSuffix = "", Function *F = 0,
 108                             ClonedCodeInfo *CodeInfo = 0);
 109
 110
 111 /// CloneLoop - Clone Loop. Clone dominator info for loop insiders. Populate
 112 /// VMap using old blocks to new blocks mapping.
 113 Loop *CloneLoop(Loop *L, LPPassManager *LPM, LoopInfo *LI,
 114                 ValueToValueMapTy &VMap, Pass *P);
 115
 116 /// CloneFunction - Return a copy of the specified function, but without
 117 /// embedding the function into another module.  Also, any references specified
 118 /// in the VMap are changed to refer to their mapped value instead of the
 119 /// original one.  If any of the arguments to the function are in the VMap,
 120 /// the arguments are deleted from the resultant function.  The VMap is
 121 /// updated to include mappings from all of the instructions and basicblocks in
 122 /// the function from their old to new values.  The final argument captures
 123 /// information about the cloned code if non-null.
 124 ///
 125 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 126 /// mappings.
 127 ///
 128 Function *CloneFunction(const Function *F,
 129                         ValueToValueMapTy &VMap,
 130                         bool ModuleLevelChanges,
 131                         ClonedCodeInfo *CodeInfo = 0);
 132
 133 /// CloneFunction - Version of the function that doesn't need the VMap.
 134 ///
 135 inline Function *CloneFunction(const Function *F, ClonedCodeInfo *CodeInfo = 0){
 136   ValueToValueMapTy VMap;
 137   return CloneFunction(F, VMap, CodeInfo);
 138 }
 139
 140 /// Clone OldFunc into NewFunc, transforming the old arguments into references
 141 /// to VMap values.  Note that if NewFunc already has basic blocks, the ones
 142 /// cloned into it will be added to the end of the function.  This function
 143 /// fills in a list of return instructions, and can optionally append the
 144 /// specified suffix to all values cloned.
 145 ///
 146 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 147 /// mappings.
 148 ///
 149 void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
 150                        ValueToValueMapTy &VMap,
 151                        bool ModuleLevelChanges,
 152                        SmallVectorImpl<ReturnInst*> &Returns,
 153                        const char *NameSuffix = "",
 154                        ClonedCodeInfo *CodeInfo = 0);
 155
 156 /// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto,
 157 /// except that it does some simple constant prop and DCE on the fly.  The
 158 /// effect of this is to copy significantly less code in cases where (for
 159 /// example) a function call with constant arguments is inlined, and those
 160 /// constant arguments cause a significant amount of code in the callee to be
 161 /// dead.  Since this doesn't produce an exactly copy of the input, it can't be
 162 /// used for things like CloneFunction or CloneModule.
 163 ///
 164 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 165 /// mappings.
 166 ///
 167 void CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc,
 168                                ValueToValueMapTy &VMap,
 169                                bool ModuleLevelChanges,
 170                                SmallVectorImpl<ReturnInst*> &Returns,
 171                                const char *NameSuffix = "",
 172                                ClonedCodeInfo *CodeInfo = 0,
 173                                const TargetData *TD = 0,
 174                                Instruction *TheCall = 0);
 175
 176
 177 /// InlineFunctionInfo - This class captures the data input to the
 178 /// InlineFunction call, and records the auxiliary results produced by it.
 179 class InlineFunctionInfo {
 180 public:
 181   explicit InlineFunctionInfo(CallGraph *cg = 0, const TargetData *td = 0)
 182     : CG(cg), TD(td) {}
 183
 184   /// CG - If non-null, InlineFunction will update the callgraph to reflect the
 185   /// changes it makes.
 186   CallGraph *CG;
 187   const TargetData *TD;
 188
 189   /// StaticAllocas - InlineFunction fills this in with all static allocas that
 190   /// get copied into the caller.
 191   SmallVector<AllocaInst*, 4> StaticAllocas;
 192
 193   /// InlinedCalls - InlineFunction fills this in with callsites that were
 194   /// inlined from the callee.  This is only filled in if CG is non-null.
 195   SmallVector<WeakVH, 8> InlinedCalls;
 196
 197   void reset() {
 198     StaticAllocas.clear();
 199     InlinedCalls.clear();
 200   }
 201 };
 202
 203 /// InlineFunction - This function inlines the called function into the basic
 204 /// block of the caller.  This returns false if it is not possible to inline
 205 /// this call.  The program is still in a well defined state if this occurs
 206 /// though.
 207 ///
 208 /// Note that this only does one level of inlining.  For example, if the
 209 /// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
 210 /// exists in the instruction stream.  Similarly this will inline a recursive
 211 /// function by one level.
 212 ///
 213 bool InlineFunction(CallInst *C, InlineFunctionInfo &IFI);
 214 bool InlineFunction(InvokeInst *II, InlineFunctionInfo &IFI);
 215 bool InlineFunction(CallSite CS, InlineFunctionInfo &IFI);
 216
 217 } // End llvm namespace
 218
 219 #endif