lib/Transforms/TransformInternals.h

   1 //===-- TransformInternals.h - Shared functions for Transforms ---*- C++ -*--=//
   2 //
   3 //  This header file declares shared functions used by the different components
   4 //  of the Transforms library.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #ifndef TRANSFORM_INTERNALS_H
   9 #define TRANSFORM_INTERNALS_H
  10
  11 #include "llvm/BasicBlock.h"
  12 #include "llvm/Instruction.h"
  13 #include "llvm/Target/TargetData.h"
  14 #include "llvm/DerivedTypes.h"
  15 #include "llvm/Constants.h"
  16 #include <map>
  17 #include <set>
  18
  19 // TargetData Hack: Eventually we will have annotations given to us by the
  20 // backend so that we know stuff about type size and alignments.  For now
  21 // though, just use this, because it happens to match the model that GCC uses.
  22 //
  23 // FIXME: This should use annotations
  24 //
  25 extern const TargetData TD;
  26
  27 static inline int getConstantValue(const ConstantInt *CPI) {
  28   if (const ConstantSInt *CSI = dyn_cast<ConstantSInt>(CPI))
  29     return (int)CSI->getValue();
  30   return (int)cast<ConstantUInt>(CPI)->getValue();
  31 }
  32
  33
  34 // getPointedToComposite - If the argument is a pointer type, and the pointed to
  35 // value is a composite type, return the composite type, else return null.
  36 //
  37 static inline const CompositeType *getPointedToComposite(const Type *Ty) {
  38   const PointerType *PT = dyn_cast<PointerType>(Ty);
  39   return PT ? dyn_cast<CompositeType>(PT->getElementType()) : 0;
  40 }
  41
  42
  43 // ReplaceInstWithValue - Replace all uses of an instruction (specified by BI)
  44 // with a value, then remove and delete the original instruction.
  45 //
  46 void ReplaceInstWithValue(BasicBlock::InstListType &BIL,
  47                           BasicBlock::iterator &BI, Value *V);
  48
  49 // ReplaceInstWithInst - Replace the instruction specified by BI with the
  50 // instruction specified by I.  The original instruction is deleted and BI is
  51 // updated to point to the new instruction.
  52 //
  53 void ReplaceInstWithInst(BasicBlock::InstListType &BIL,
  54                          BasicBlock::iterator &BI, Instruction *I);
  55
  56 void ReplaceInstWithInst(Instruction *From, Instruction *To);
  57
  58 // InsertInstBeforeInst - Insert 'NewInst' into the basic block that 'Existing'
  59 // is already in, and put it right before 'Existing'.  This instruction should
  60 // only be used when there is no iterator to Existing already around.  The
  61 // returned iterator points to the new instruction.
  62 //
  63 BasicBlock::iterator InsertInstBeforeInst(Instruction *NewInst,
  64                                           Instruction *Existing);
  65
  66 // ConvertableToGEP - This function returns true if the specified value V is
  67 // a valid index into a pointer of type Ty.  If it is valid, Idx is filled in
  68 // with the values that would be appropriate to make this a getelementptr
  69 // instruction.  The type returned is the root type that the GEP would point
  70 // to if it were synthesized with this operands.
  71 //
  72 // If BI is nonnull, cast instructions are inserted as appropriate for the
  73 // arguments of the getelementptr.
  74 //
  75 const Type *ConvertableToGEP(const Type *Ty, Value *V,
  76                              std::vector<Value*> &Indices,
  77                              BasicBlock::iterator *BI = 0);
  78
  79
  80 // ------------- Expression Conversion ---------------------
  81
  82 typedef std::map<const Value*, const Type*>         ValueTypeCache;
  83
  84 struct ValueMapCache {
  85   // Operands mapped - Contains an entry if the first value (the user) has had
  86   // the second value (the operand) mapped already.
  87   //
  88   std::set<const User*> OperandsMapped;
  89
  90   // Expression Map - Contains an entry from the old value to the new value of
  91   // an expression that has been converted over.
  92   //
  93   std::map<const Value *, Value *> ExprMap;
  94   typedef std::map<const Value *, Value *> ExprMapTy;
  95 };
  96
  97
  98 bool ExpressionConvertableToType(Value *V, const Type *Ty, ValueTypeCache &Map);
  99 Value *ConvertExpressionToType(Value *V, const Type *Ty, ValueMapCache &VMC);
 100
 101 // ValueConvertableToType - Return true if it is possible
 102 bool ValueConvertableToType(Value *V, const Type *Ty,
 103                             ValueTypeCache &ConvertedTypes);
 104
 105 void ConvertValueToNewType(Value *V, Value *NewVal, ValueMapCache &VMC);
 106
 107
 108 //===----------------------------------------------------------------------===//
 109 //  ValueHandle Class - Smart pointer that occupies a slot on the users USE list
 110 //  that prevents it from being destroyed.  This "looks" like an Instruction
 111 //  with Opcode UserOp1.
 112 //
 113 class ValueHandle : public Instruction {
 114   ValueHandle(const ValueHandle &); // DO NOT IMPLEMENT
 115   ValueMapCache &Cache;
 116 public:
 117   ValueHandle(ValueMapCache &VMC, Value *V);
 118   ~ValueHandle();
 119
 120   virtual Instruction *clone() const { abort(); return 0; }
 121
 122   virtual const char *getOpcodeName() const {
 123     return "ValueHandle";
 124   }
 125
 126   // Methods for support type inquiry through isa, cast, and dyn_cast:
 127   static inline bool classof(const ValueHandle *) { return true; }
 128   static inline bool classof(const Instruction *I) {
 129     return (I->getOpcode() == Instruction::UserOp1);
 130   }
 131   static inline bool classof(const Value *V) {
 132     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 133   }
 134 };
 135
 136 // getStructOffsetType - Return a vector of offsets that are to be used to index
 137 // into the specified struct type to get as close as possible to index as we
 138 // can.  Note that it is possible that we cannot get exactly to Offset, in which
 139 // case we update offset to be the offset we actually obtained.  The resultant
 140 // leaf type is returned.
 141 //
 142 // If StopEarly is set to true (the default), the first object with the
 143 // specified type is returned, even if it is a struct type itself.  In this
 144 // case, this routine will not drill down to the leaf type.  Set StopEarly to
 145 // false if you want a leaf
 146 //
 147 const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
 148                                 std::vector<Value*> &Offsets,
 149                                 bool StopEarly = true);
 150
 151 #endif