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/Target/TargetData.h"
  13 #include "llvm/DerivedTypes.h"
  14 #include "llvm/Constants.h"
  15 #include <map>
  16 #include <set>
  17
  18 static inline int64_t getConstantValue(const ConstantInt *CPI) {
  19   return (int64_t)cast<ConstantInt>(CPI)->getRawValue();
  20 }
  21
  22
  23 // getPointedToComposite - If the argument is a pointer type, and the pointed to
  24 // value is a composite type, return the composite type, else return null.
  25 //
  26 static inline const CompositeType *getPointedToComposite(const Type *Ty) {
  27   const PointerType *PT = dyn_cast<PointerType>(Ty);
  28   return PT ? dyn_cast<CompositeType>(PT->getElementType()) : 0;
  29 }
  30
  31 // ConvertibleToGEP - This function returns true if the specified value V is
  32 // a valid index into a pointer of type Ty.  If it is valid, Idx is filled in
  33 // with the values that would be appropriate to make this a getelementptr
  34 // instruction.  The type returned is the root type that the GEP would point
  35 // to if it were synthesized with this operands.
  36 //
  37 // If BI is nonnull, cast instructions are inserted as appropriate for the
  38 // arguments of the getelementptr.
  39 //
  40 const Type *ConvertibleToGEP(const Type *Ty, Value *V,
  41                              std::vector<Value*> &Indices,
  42                              const TargetData &TD,
  43                              BasicBlock::iterator *BI = 0);
  44
  45
  46 //===----------------------------------------------------------------------===//
  47 //  ValueHandle Class - Smart pointer that occupies a slot on the users USE list
  48 //  that prevents it from being destroyed.  This "looks" like an Instruction
  49 //  with Opcode UserOp1.
  50 //
  51 class ValueMapCache;
  52 class ValueHandle : public Instruction {
  53   ValueMapCache &Cache;
  54 public:
  55   ValueHandle(ValueMapCache &VMC, Value *V);
  56   ValueHandle(const ValueHandle &);
  57   ~ValueHandle();
  58
  59   virtual Instruction *clone() const { abort(); return 0; }
  60
  61   virtual const char *getOpcodeName() const {
  62     return "ValueHandle";
  63   }
  64
  65   inline bool operator<(const ValueHandle &VH) const {
  66     return getOperand(0) < VH.getOperand(0);
  67   }
  68
  69   // Methods for support type inquiry through isa, cast, and dyn_cast:
  70   static inline bool classof(const ValueHandle *) { return true; }
  71   static inline bool classof(const Instruction *I) {
  72     return (I->getOpcode() == Instruction::UserOp1);
  73   }
  74   static inline bool classof(const Value *V) {
  75     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  76   }
  77 };
  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   // Cast Map - Cast instructions can have their source and destination values
  97   // changed independantly for each part.  Because of this, our old naive
  98   // implementation would create a TWO new cast instructions, which would cause
  99   // all kinds of problems.  Here we keep track of the newly allocated casts, so
 100   // that we only create one for a particular instruction.
 101   //
 102   std::set<ValueHandle> NewCasts;
 103 };
 104
 105
 106 bool ExpressionConvertibleToType(Value *V, const Type *Ty, ValueTypeCache &Map,
 107                                  const TargetData &TD);
 108 Value *ConvertExpressionToType(Value *V, const Type *Ty, ValueMapCache &VMC,
 109                                const TargetData &TD);
 110
 111 // ValueConvertibleToType - Return true if it is possible
 112 bool ValueConvertibleToType(Value *V, const Type *Ty,
 113                             ValueTypeCache &ConvertedTypes,
 114                             const TargetData &TD);
 115
 116 void ConvertValueToNewType(Value *V, Value *NewVal, ValueMapCache &VMC,
 117                            const TargetData &TD);
 118
 119
 120 // getStructOffsetType - Return a vector of offsets that are to be used to index
 121 // into the specified struct type to get as close as possible to index as we
 122 // can.  Note that it is possible that we cannot get exactly to Offset, in which
 123 // case we update offset to be the offset we actually obtained.  The resultant
 124 // leaf type is returned.
 125 //
 126 // If StopEarly is set to true (the default), the first object with the
 127 // specified type is returned, even if it is a struct type itself.  In this
 128 // case, this routine will not drill down to the leaf type.  Set StopEarly to
 129 // false if you want a leaf
 130 //
 131 const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
 132                                 std::vector<Value*> &Offsets,
 133                                 const TargetData &TD, bool StopEarly = true);
 134
 135 #endif