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