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/SmallVector.h"
  22 #include "llvm/ADT/Twine.h"
  23 #include "llvm/IR/ValueHandle.h"
  24 #include "llvm/IR/ValueMap.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 DataLayout;
  43 class Loop;
  44 class LoopInfo;
  45 class AllocaInst;
  46 class AliasAnalysis;
  47 class AssumptionCacheTracker;
  48
  49 /// CloneModule - Return an exact copy of the specified module
  50 ///
  51 Module *CloneModule(const Module *M);
  52 Module *CloneModule(const Module *M, ValueToValueMapTy &VMap);
  53
  54 /// ClonedCodeInfo - This struct can be used to capture information about code
  55 /// being cloned, while it is being cloned.
  56 struct ClonedCodeInfo {
  57   /// ContainsCalls - This is set to true if the cloned code contains a normal
  58   /// call instruction.
  59   bool ContainsCalls;
  60
  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
  64   /// size.
  65   bool ContainsDynamicAllocas;
  66
  67   ClonedCodeInfo() : ContainsCalls(false), ContainsDynamicAllocas(false) {}
  68 };
  69
  70 /// CloneBasicBlock - Return a copy of the specified basic block, but without
  71 /// embedding the block into a particular function.  The block returned is an
  72 /// exact copy of the specified basic block, without any remapping having been
  73 /// performed.  Because of this, this is only suitable for applications where
  74 /// the basic block will be inserted into the same function that it was cloned
  75 /// from (loop unrolling would use this, for example).
  76 ///
  77 /// Also, note that this function makes a direct copy of the basic block, and
  78 /// can thus produce illegal LLVM code.  In particular, it will copy any PHI
  79 /// nodes from the original block, even though there are no predecessors for the
  80 /// newly cloned block (thus, phi nodes will have to be updated).  Also, this
  81 /// block will branch to the old successors of the original block: these
  82 /// successors will have to have any PHI nodes updated to account for the new
  83 /// incoming edges.
  84 ///
  85 /// The correlation between instructions in the source and result basic blocks
  86 /// is recorded in the VMap map.
  87 ///
  88 /// If you have a particular suffix you'd like to use to add to any cloned
  89 /// names, specify it as the optional third parameter.
  90 ///
  91 /// If you would like the basic block to be auto-inserted into the end of a
  92 /// function, you can specify it as the optional fourth parameter.
  93 ///
  94 /// If you would like to collect additional information about the cloned
  95 /// function, you can specify a ClonedCodeInfo object with the optional fifth
  96 /// parameter.
  97 ///
  98 BasicBlock *CloneBasicBlock(const BasicBlock *BB, ValueToValueMapTy &VMap,
  99                             const Twine &NameSuffix = "", Function *F = nullptr,
 100                             ClonedCodeInfo *CodeInfo = nullptr);
 101
 102 /// CloneFunction - Return a copy of the specified function, but without
 103 /// embedding the function into another module.  Also, any references specified
 104 /// in the VMap are changed to refer to their mapped value instead of the
 105 /// original one.  If any of the arguments to the function are in the VMap,
 106 /// the arguments are deleted from the resultant function.  The VMap is
 107 /// updated to include mappings from all of the instructions and basicblocks in
 108 /// the function from their old to new values.  The final argument captures
 109 /// information about the cloned code if non-null.
 110 ///
 111 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 112 /// mappings, and debug info metadata will not be cloned.
 113 ///
 114 Function *CloneFunction(const Function *F, ValueToValueMapTy &VMap,
 115                         bool ModuleLevelChanges,
 116                         ClonedCodeInfo *CodeInfo = nullptr);
 117
 118 /// Clone OldFunc into NewFunc, transforming the old arguments into references
 119 /// to VMap values.  Note that if NewFunc already has basic blocks, the ones
 120 /// cloned into it will be added to the end of the function.  This function
 121 /// fills in a list of return instructions, and can optionally remap types
 122 /// and/or append the specified suffix to all values cloned.
 123 ///
 124 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 125 /// mappings.
 126 ///
 127 void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
 128                        ValueToValueMapTy &VMap, bool ModuleLevelChanges,
 129                        SmallVectorImpl<ReturnInst*> &Returns,
 130                        const char *NameSuffix = "",
 131                        ClonedCodeInfo *CodeInfo = nullptr,
 132                        ValueMapTypeRemapper *TypeMapper = nullptr,
 133                        ValueMaterializer *Materializer = nullptr);
 134
 135 /// A helper class used with CloneAndPruneIntoFromInst to change the default
 136 /// behavior while instructions are being cloned.
 137 class CloningDirector {
 138 public:
 139   /// This enumeration describes the way CloneAndPruneIntoFromInst should
 140   /// proceed after the CloningDirector has examined an instruction.
 141   enum CloningAction {
 142     ///< Continue cloning the instruction (default behavior).
 143     CloneInstruction,
 144     ///< Skip this instruction but continue cloning the current basic block.
 145     SkipInstruction,
 146     ///< Skip this instruction and stop cloning the current basic block.
 147     StopCloningBB
 148   };
 149
 150   virtual ~CloningDirector() = default;
 151
 152   /// Subclasses must override this function to customize cloning behavior.
 153   virtual CloningAction handleInstruction(ValueToValueMapTy &VMap,
 154                                           const Instruction *Inst,
 155                                           BasicBlock *NewBB) = 0;
 156 };
 157
 158 void CloneAndPruneIntoFromInst(Function *NewFunc, const Function *OldFunc,
 159                                const Instruction *StartingInst,
 160                                ValueToValueMapTy &VMap, bool ModuleLevelChanges,
 161                                SmallVectorImpl<ReturnInst*> &Returns,
 162                                const char *NameSuffix = "",
 163                                ClonedCodeInfo *CodeInfo = nullptr,
 164                                const DataLayout *DL = nullptr,
 165                                CloningDirector *Director = nullptr);
 166
 167
 168 /// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto,
 169 /// except that it does some simple constant prop and DCE on the fly.  The
 170 /// effect of this is to copy significantly less code in cases where (for
 171 /// example) a function call with constant arguments is inlined, and those
 172 /// constant arguments cause a significant amount of code in the callee to be
 173 /// dead.  Since this doesn't produce an exactly copy of the input, it can't be
 174 /// used for things like CloneFunction or CloneModule.
 175 ///
 176 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 177 /// mappings.
 178 ///
 179 void CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc,
 180                                ValueToValueMapTy &VMap, bool ModuleLevelChanges,
 181                                SmallVectorImpl<ReturnInst*> &Returns,
 182                                const char *NameSuffix = "",
 183                                ClonedCodeInfo *CodeInfo = nullptr,
 184                                const DataLayout *DL = nullptr,
 185                                Instruction *TheCall = nullptr);
 186
 187 /// InlineFunctionInfo - This class captures the data input to the
 188 /// InlineFunction call, and records the auxiliary results produced by it.
 189 class InlineFunctionInfo {
 190 public:
 191   explicit InlineFunctionInfo(CallGraph *cg = nullptr,
 192                               const DataLayout *DL = nullptr,
 193                               AliasAnalysis *AA = nullptr,
 194                               AssumptionCacheTracker *ACT = nullptr)
 195       : CG(cg), DL(DL), AA(AA), ACT(ACT) {}
 196
 197   /// CG - If non-null, InlineFunction will update the callgraph to reflect the
 198   /// changes it makes.
 199   CallGraph *CG;
 200   const DataLayout *DL;
 201   AliasAnalysis *AA;
 202   AssumptionCacheTracker *ACT;
 203
 204   /// StaticAllocas - InlineFunction fills this in with all static allocas that
 205   /// get copied into the caller.
 206   SmallVector<AllocaInst *, 4> StaticAllocas;
 207
 208   /// InlinedCalls - InlineFunction fills this in with callsites that were
 209   /// inlined from the callee.  This is only filled in if CG is non-null.
 210   SmallVector<WeakVH, 8> InlinedCalls;
 211
 212   void reset() {
 213     StaticAllocas.clear();
 214     InlinedCalls.clear();
 215   }
 216 };
 217
 218 /// InlineFunction - This function inlines the called function into the basic
 219 /// block of the caller.  This returns false if it is not possible to inline
 220 /// this call.  The program is still in a well defined state if this occurs
 221 /// though.
 222 ///
 223 /// Note that this only does one level of inlining.  For example, if the
 224 /// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
 225 /// exists in the instruction stream.  Similarly this will inline a recursive
 226 /// function by one level.
 227 ///
 228 bool InlineFunction(CallInst *C, InlineFunctionInfo &IFI,
 229                     bool InsertLifetime = true);
 230 bool InlineFunction(InvokeInst *II, InlineFunctionInfo &IFI,
 231                     bool InsertLifetime = true);
 232 bool InlineFunction(CallSite CS, InlineFunctionInfo &IFI,
 233                     bool InsertLifetime = true);
 234
 235 } // End llvm namespace
 236
 237 #endif