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/ConstantVals.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 CSI->getValue();
  30   return 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
  59 // ConvertableToGEP - This function returns true if the specified value V is
  60 // a valid index into a pointer of type Ty.  If it is valid, Idx is filled in
  61 // with the values that would be appropriate to make this a getelementptr
  62 // instruction.  The type returned is the root type that the GEP would point
  63 // to if it were synthesized with this operands.
  64 //
  65 // If BI is nonnull, cast instructions are inserted as appropriate for the
  66 // arguments of the getelementptr.
  67 //
  68 const Type *ConvertableToGEP(const Type *Ty, Value *V,
  69                              std::vector<Value*> &Indices,
  70                              BasicBlock::iterator *BI = 0);
  71
  72
  73 // ------------- Expression Conversion ---------------------
  74
  75 typedef std::map<const Value*, const Type*>         ValueTypeCache;
  76
  77 struct ValueMapCache {
  78   // Operands mapped - Contains an entry if the first value (the user) has had
  79   // the second value (the operand) mapped already.
  80   //
  81   std::set<const User*> OperandsMapped;
  82
  83   // Expression Map - Contains an entry from the old value to the new value of
  84   // an expression that has been converted over.
  85   //
  86   std::map<const Value *, Value *> ExprMap;
  87   typedef std::map<const Value *, Value *> ExprMapTy;
  88 };
  89
  90
  91 bool ExpressionConvertableToType(Value *V, const Type *Ty, ValueTypeCache &Map);
  92 Value *ConvertExpressionToType(Value *V, const Type *Ty, ValueMapCache &VMC);
  93
  94 // ValueConvertableToType - Return true if it is possible
  95 bool ValueConvertableToType(Value *V, const Type *Ty,
  96                             ValueTypeCache &ConvertedTypes);
  97
  98 void ConvertValueToNewType(Value *V, Value *NewVal, ValueMapCache &VMC);
  99
 100
 101 //===----------------------------------------------------------------------===//
 102 //  ValueHandle Class - Smart pointer that occupies a slot on the users USE list
 103 //  that prevents it from being destroyed.  This "looks" like an Instruction
 104 //  with Opcode UserOp1.
 105 //
 106 class ValueHandle : public Instruction {
 107   ValueHandle(const ValueHandle &); // DO NOT IMPLEMENT
 108   ValueMapCache &Cache;
 109 public:
 110   ValueHandle(ValueMapCache &VMC, Value *V);
 111   ~ValueHandle();
 112
 113   virtual Instruction *clone() const { abort(); return 0; }
 114
 115   virtual const char *getOpcodeName() const {
 116     return "ValueHandle";
 117   }
 118
 119   // Methods for support type inquiry through isa, cast, and dyn_cast:
 120   static inline bool classof(const ValueHandle *) { return true; }
 121   static inline bool classof(const Instruction *I) {
 122     return (I->getOpcode() == Instruction::UserOp1);
 123   }
 124   static inline bool classof(const Value *V) {
 125     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 126   }
 127 };
 128
 129 // getStructOffsetType - Return a vector of offsets that are to be used to index
 130 // into the specified struct type to get as close as possible to index as we
 131 // can.  Note that it is possible that we cannot get exactly to Offset, in which
 132 // case we update offset to be the offset we actually obtained.  The resultant
 133 // leaf type is returned.
 134 //
 135 // If StopEarly is set to true (the default), the first object with the
 136 // specified type is returned, even if it is a struct type itself.  In this
 137 // case, this routine will not drill down to the leaf type.  Set StopEarly to
 138 // false if you want a leaf
 139 //
 140 const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
 141                                 std::vector<Value*> &Offsets,
 142                                 bool StopEarly = true);
 143
 144 #endif