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
  35 /// CloneModule - Return an exact copy of the specified module
  36 ///
  37 Module *CloneModule(const Module *M);
  38
  39 /// CloneBasicBlock - Return a copy of the specified basic block, but without
  40 /// embedding the block into a particular function.  The block returned is an
  41 /// exact copy of the specified basic block, without any remapping having been
  42 /// performed.  Because of this, this is only suitable for applications where
  43 /// the basic block will be inserted into the same function that it was cloned
  44 /// from (loop unrolling would use this, for example).
  45 ///
  46 /// Also, note that this function makes a direct copy of the basic block, and
  47 /// can thus produce illegal LLVM code.  In particular, it will copy any PHI
  48 /// nodes from the original block, even though there are no predecessors for the
  49 /// newly cloned block (thus, phi nodes will have to be updated).  Also, this
  50 /// block will branch to the old successors of the original block: these
  51 /// successors will have to have any PHI nodes updated to account for the new
  52 /// incoming edges.
  53 ///
  54 /// The correlation between instructions in the source and result basic blocks
  55 /// is recorded in the ValueMap map.
  56 ///
  57 /// If you have a particular suffix you'd like to use to add to any cloned
  58 /// names, specify it as the optional third parameter.
  59 ///
  60 /// If you would like the basic block to be auto-inserted into the end of a
  61 /// function, you can specify it as the optional fourth parameter.
  62 ///
  63 BasicBlock *CloneBasicBlock(const BasicBlock *BB,
  64                             std::map<const Value*, Value*> &ValueMap,
  65                             const char *NameSuffix = "", Function *F = 0);
  66
  67
  68 /// CloneFunction - Return a copy of the specified function, but without
  69 /// embedding the function into another module.  Also, any references specified
  70 /// in the ValueMap are changed to refer to their mapped value instead of the
  71 /// original one.  If any of the arguments to the function are in the ValueMap,
  72 /// the arguments are deleted from the resultant function.  The ValueMap is
  73 /// updated to include mappings from all of the instructions and basicblocks in
  74 /// the function from their old to new values.
  75 ///
  76 Function *CloneFunction(const Function *F,
  77                         std::map<const Value*, Value*> &ValueMap);
  78
  79 /// CloneFunction - Version of the function that doesn't need the ValueMap.
  80 ///
  81 inline Function *CloneFunction(const Function *F) {
  82   std::map<const Value*, Value*> ValueMap;
  83   return CloneFunction(F, ValueMap);
  84 }
  85
  86 /// Clone OldFunc into NewFunc, transforming the old arguments into references
  87 /// to ArgMap values.  Note that if NewFunc already has basic blocks, the ones
  88 /// cloned into it will be added to the end of the function.  This function
  89 /// fills in a list of return instructions, and can optionally append the
  90 /// specified suffix to all values cloned.
  91 ///
  92 void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
  93                        std::map<const Value*, Value*> &ValueMap,
  94                        std::vector<ReturnInst*> &Returns,
  95                        const char *NameSuffix = "");
  96
  97
  98 /// InlineFunction - This function inlines the called function into the basic
  99 /// block of the caller.  This returns false if it is not possible to inline
 100 /// this call.  The program is still in a well defined state if this occurs
 101 /// though.
 102 ///
 103 /// Note that this only does one level of inlining.  For example, if the
 104 /// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
 105 /// exists in the instruction stream.  Similiarly this will inline a recursive
 106 /// function by one level.
 107 ///
 108 bool InlineFunction(CallInst *C);
 109 bool InlineFunction(InvokeInst *II);
 110 bool InlineFunction(CallSite CS);
 111
 112 /// CloneTrace - Returns a copy of the specified trace.
 113 /// It takes a vector of basic blocks clones the basic blocks, removes internal
 114 /// phi nodes, adds it to the same function as the original (although there is
 115 /// no jump to it) and returns the new vector of basic blocks.
 116 std::vector<BasicBlock *> CloneTrace(const std::vector<BasicBlock*> &origTrace);
 117
 118 } // End llvm namespace
 119
 120 #endif