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/Analysis/AliasAnalysis.h"
  24 #include "llvm/IR/ValueHandle.h"
  25 #include "llvm/IR/ValueMap.h"
  26 #include "llvm/Transforms/Utils/ValueMapper.h"
  27 #include <functional>
  28
  29 namespace llvm {
  30
  31 class Module;
  32 class Function;
  33 class Instruction;
  34 class Pass;
  35 class LPPassManager;
  36 class BasicBlock;
  37 class Value;
  38 class CallInst;
  39 class InvokeInst;
  40 class ReturnInst;
  41 class CallSite;
  42 class Trace;
  43 class CallGraph;
  44 class DataLayout;
  45 class Loop;
  46 class LoopInfo;
  47 class AllocaInst;
  48 class AssumptionCacheTracker;
  49 class DominatorTree;
  50
  51 /// Return an exact copy of the specified module
  52 ///
  53 std::unique_ptr<Module> CloneModule(const Module *M);
  54 std::unique_ptr<Module> CloneModule(const Module *M, ValueToValueMapTy &VMap);
  55
  56 /// Return a copy of the specified module. The ShouldCloneDefinition function
  57 /// controls whether a specific GlobalValue's definition is cloned. If the
  58 /// function returns false, the module copy will contain an external reference
  59 /// in place of the global definition.
  60 std::unique_ptr<Module>
  61 CloneModule(const Module *M, ValueToValueMapTy &VMap,
  62             std::function<bool(const GlobalValue *)> ShouldCloneDefinition);
  63
  64 /// ClonedCodeInfo - This struct can be used to capture information about code
  65 /// being cloned, while it is being cloned.
  66 struct ClonedCodeInfo {
  67   /// ContainsCalls - This is set to true if the cloned code contains a normal
  68   /// call instruction.
  69   bool ContainsCalls;
  70
  71   /// ContainsDynamicAllocas - This is set to true if the cloned code contains
  72   /// a 'dynamic' alloca.  Dynamic allocas are allocas that are either not in
  73   /// the entry block or they are in the entry block but are not a constant
  74   /// size.
  75   bool ContainsDynamicAllocas;
  76
  77   /// All cloned call sites that have operand bundles attached are appended to
  78   /// this vector.
  79   std::vector<AssertingVH<Instruction>> OperandBundleCallSites;
  80
  81   ClonedCodeInfo() : ContainsCalls(false), ContainsDynamicAllocas(false) {}
  82 };
  83
  84 /// CloneBasicBlock - Return a copy of the specified basic block, but without
  85 /// embedding the block into a particular function.  The block returned is an
  86 /// exact copy of the specified basic block, without any remapping having been
  87 /// performed.  Because of this, this is only suitable for applications where
  88 /// the basic block will be inserted into the same function that it was cloned
  89 /// from (loop unrolling would use this, for example).
  90 ///
  91 /// Also, note that this function makes a direct copy of the basic block, and
  92 /// can thus produce illegal LLVM code.  In particular, it will copy any PHI
  93 /// nodes from the original block, even though there are no predecessors for the
  94 /// newly cloned block (thus, phi nodes will have to be updated).  Also, this
  95 /// block will branch to the old successors of the original block: these
  96 /// successors will have to have any PHI nodes updated to account for the new
  97 /// incoming edges.
  98 ///
  99 /// The correlation between instructions in the source and result basic blocks
 100 /// is recorded in the VMap map.
 101 ///
 102 /// If you have a particular suffix you'd like to use to add to any cloned
 103 /// names, specify it as the optional third parameter.
 104 ///
 105 /// If you would like the basic block to be auto-inserted into the end of a
 106 /// function, you can specify it as the optional fourth parameter.
 107 ///
 108 /// If you would like to collect additional information about the cloned
 109 /// function, you can specify a ClonedCodeInfo object with the optional fifth
 110 /// parameter.
 111 ///
 112 BasicBlock *CloneBasicBlock(const BasicBlock *BB, ValueToValueMapTy &VMap,
 113                             const Twine &NameSuffix = "", Function *F = nullptr,
 114                             ClonedCodeInfo *CodeInfo = nullptr);
 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, and debug info metadata will not be cloned.
 127 ///
 128 Function *CloneFunction(const Function *F, ValueToValueMapTy &VMap,
 129                         bool ModuleLevelChanges,
 130                         ClonedCodeInfo *CodeInfo = nullptr);
 131
 132 /// Clone OldFunc into NewFunc, transforming the old arguments into references
 133 /// to VMap 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 remap types
 136 /// and/or append the specified suffix to all values cloned.
 137 ///
 138 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 139 /// mappings.
 140 ///
 141 void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
 142                        ValueToValueMapTy &VMap, bool ModuleLevelChanges,
 143                        SmallVectorImpl<ReturnInst*> &Returns,
 144                        const char *NameSuffix = "",
 145                        ClonedCodeInfo *CodeInfo = nullptr,
 146                        ValueMapTypeRemapper *TypeMapper = nullptr,
 147                        ValueMaterializer *Materializer = nullptr);
 148
 149 /// A helper class used with CloneAndPruneIntoFromInst to change the default
 150 /// behavior while instructions are being cloned.
 151 class CloningDirector {
 152 public:
 153   /// This enumeration describes the way CloneAndPruneIntoFromInst should
 154   /// proceed after the CloningDirector has examined an instruction.
 155   enum CloningAction {
 156     ///< Continue cloning the instruction (default behavior).
 157     CloneInstruction,
 158     ///< Skip this instruction but continue cloning the current basic block.
 159     SkipInstruction,
 160     ///< Skip this instruction and stop cloning the current basic block.
 161     StopCloningBB,
 162     ///< Don't clone the terminator but clone the current block's successors.
 163     CloneSuccessors
 164   };
 165
 166   virtual ~CloningDirector() {}
 167
 168   /// Subclasses must override this function to customize cloning behavior.
 169   virtual CloningAction handleInstruction(ValueToValueMapTy &VMap,
 170                                           const Instruction *Inst,
 171                                           BasicBlock *NewBB) = 0;
 172
 173   virtual ValueMapTypeRemapper *getTypeRemapper() { return nullptr; }
 174   virtual ValueMaterializer *getValueMaterializer() { return nullptr; }
 175 };
 176
 177 void CloneAndPruneIntoFromInst(Function *NewFunc, const Function *OldFunc,
 178                                const Instruction *StartingInst,
 179                                ValueToValueMapTy &VMap, bool ModuleLevelChanges,
 180                                SmallVectorImpl<ReturnInst*> &Returns,
 181                                const char *NameSuffix = "",
 182                                ClonedCodeInfo *CodeInfo = nullptr,
 183                                CloningDirector *Director = nullptr);
 184
 185
 186 /// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto,
 187 /// except that it does some simple constant prop and DCE on the fly.  The
 188 /// effect of this is to copy significantly less code in cases where (for
 189 /// example) a function call with constant arguments is inlined, and those
 190 /// constant arguments cause a significant amount of code in the callee to be
 191 /// dead.  Since this doesn't produce an exactly copy of the input, it can't be
 192 /// used for things like CloneFunction or CloneModule.
 193 ///
 194 /// If ModuleLevelChanges is false, VMap contains no non-identity GlobalValue
 195 /// mappings.
 196 ///
 197 void CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc,
 198                                ValueToValueMapTy &VMap, bool ModuleLevelChanges,
 199                                SmallVectorImpl<ReturnInst*> &Returns,
 200                                const char *NameSuffix = "",
 201                                ClonedCodeInfo *CodeInfo = nullptr,
 202                                Instruction *TheCall = nullptr);
 203
 204 /// InlineFunctionInfo - This class captures the data input to the
 205 /// InlineFunction call, and records the auxiliary results produced by it.
 206 class InlineFunctionInfo {
 207 public:
 208   explicit InlineFunctionInfo(CallGraph *cg = nullptr,
 209                               AssumptionCacheTracker *ACT = nullptr)
 210       : CG(cg), ACT(ACT) {}
 211
 212   /// CG - If non-null, InlineFunction will update the callgraph to reflect the
 213   /// changes it makes.
 214   CallGraph *CG;
 215   AssumptionCacheTracker *ACT;
 216
 217   /// StaticAllocas - InlineFunction fills this in with all static allocas that
 218   /// get copied into the caller.
 219   SmallVector<AllocaInst *, 4> StaticAllocas;
 220
 221   /// InlinedCalls - InlineFunction fills this in with callsites that were
 222   /// inlined from the callee.  This is only filled in if CG is non-null.
 223   SmallVector<WeakVH, 8> InlinedCalls;
 224
 225   void reset() {
 226     StaticAllocas.clear();
 227     InlinedCalls.clear();
 228   }
 229 };
 230
 231 /// InlineFunction - This function inlines the called function into the basic
 232 /// block of the caller.  This returns false if it is not possible to inline
 233 /// this call.  The program is still in a well defined state if this occurs
 234 /// though.
 235 ///
 236 /// Note that this only does one level of inlining.  For example, if the
 237 /// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
 238 /// exists in the instruction stream.  Similarly this will inline a recursive
 239 /// function by one level.
 240 ///
 241 bool InlineFunction(CallInst *C, InlineFunctionInfo &IFI,
 242                     AAResults *CalleeAAR = nullptr, bool InsertLifetime = true);
 243 bool InlineFunction(InvokeInst *II, InlineFunctionInfo &IFI,
 244                     AAResults *CalleeAAR = nullptr, bool InsertLifetime = true);
 245 bool InlineFunction(CallSite CS, InlineFunctionInfo &IFI,
 246                     AAResults *CalleeAAR = nullptr, bool InsertLifetime = true);
 247
 248 /// \brief Clones a loop \p OrigLoop.  Returns the loop and the blocks in \p
 249 /// Blocks.
 250 ///
 251 /// Updates LoopInfo and DominatorTree assuming the loop is dominated by block
 252 /// \p LoopDomBB.  Insert the new blocks before block specified in \p Before.
 253 Loop *cloneLoopWithPreheader(BasicBlock *Before, BasicBlock *LoopDomBB,
 254                              Loop *OrigLoop, ValueToValueMapTy &VMap,
 255                              const Twine &NameSuffix, LoopInfo *LI,
 256                              DominatorTree *DT,
 257                              SmallVectorImpl<BasicBlock *> &Blocks);
 258
 259 /// \brief Remaps instructions in \p Blocks using the mapping in \p VMap.
 260 void remapInstructionsInBlocks(const SmallVectorImpl<BasicBlock *> &Blocks,
 261                                ValueToValueMapTy &VMap);
 262
 263 } // End llvm namespace
 264
 265 #endif