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