lib/Transforms/TransformInternals.h

   1 //===-- TransformInternals.h - Shared functions for Transforms --*- 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 header file declares shared functions used by the different components
  11 //  of the Transforms library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef TRANSFORM_INTERNALS_H
  16 #define TRANSFORM_INTERNALS_H
  17
  18 #include "llvm/BasicBlock.h"
  19 #include "llvm/Target/TargetData.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/Constants.h"
  22 #include <map>
  23 #include <set>
  24
  25 namespace llvm {
  26
  27 static inline int64_t getConstantValue(const ConstantInt *CPI) {
  28   return (int64_t)cast<ConstantInt>(CPI)->getZExtValue();
  29 }
  30
  31
  32 // getPointedToComposite - If the argument is a pointer type, and the pointed to
  33 // value is a composite type, return the composite type, else return null.
  34 //
  35 static inline const CompositeType *getPointedToComposite(const Type *Ty) {
  36   const PointerType *PT = dyn_cast<PointerType>(Ty);
  37   return PT ? dyn_cast<CompositeType>(PT->getElementType()) : 0;
  38 }
  39
  40
  41 //===----------------------------------------------------------------------===//
  42 //  ValueHandle Class - Smart pointer that occupies a slot on the users USE list
  43 //  that prevents it from being destroyed.  This "looks" like an Instruction
  44 //  with Opcode UserOp1.
  45 //
  46 class ValueMapCache;
  47 class ValueHandle : public Instruction {
  48   Use Op;
  49   ValueMapCache &Cache;
  50 public:
  51   ValueHandle(ValueMapCache &VMC, Value *V);
  52   ValueHandle(const ValueHandle &);
  53   ~ValueHandle();
  54
  55   virtual Instruction *clone() const { abort(); return 0; }
  56
  57   virtual const char *getOpcodeName() const {
  58     return "ValueHandle";
  59   }
  60
  61   inline bool operator<(const ValueHandle &VH) const {
  62     return getOperand(0) < VH.getOperand(0);
  63   }
  64
  65   // Methods for support type inquiry through isa, cast, and dyn_cast:
  66   static inline bool classof(const ValueHandle *) { return true; }
  67   static inline bool classof(const Instruction *I) {
  68     return (I->getOpcode() == Instruction::UserOp1);
  69   }
  70   static inline bool classof(const Value *V) {
  71     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  72   }
  73 };
  74
  75
  76 // ------------- Expression Conversion ---------------------
  77
  78 typedef std::map<const Value*, const Type*> ValueTypeCache;
  79
  80 class ValueMapCache {
  81 public:
  82   // Operands mapped - Contains an entry if the first value (the user) has had
  83   // the second value (the operand) mapped already.
  84   //
  85   std::set<const User*> OperandsMapped;
  86
  87   // Expression Map - Contains an entry from the old value to the new value of
  88   // an expression that has been converted over.
  89   //
  90   std::map<const Value *, Value *> ExprMap;
  91   typedef std::map<const Value *, Value *> ExprMapTy;
  92
  93   // Cast Map - Cast instructions can have their source and destination values
  94   // changed independently for each part.  Because of this, our old naive
  95   // implementation would create a TWO new cast instructions, which would cause
  96   // all kinds of problems.  Here we keep track of the newly allocated casts, so
  97   // that we only create one for a particular instruction.
  98   //
  99   std::set<ValueHandle> NewCasts;
 100 };
 101
 102
 103 bool ExpressionConvertibleToType(Value *V, const Type *Ty, ValueTypeCache &Map,
 104                                  const TargetData &TD);
 105 Value *ConvertExpressionToType(Value *V, const Type *Ty, ValueMapCache &VMC,
 106                                const TargetData &TD);
 107
 108 // ValueConvertibleToType - Return true if it is possible
 109 bool ValueConvertibleToType(Value *V, const Type *Ty,
 110                             ValueTypeCache &ConvertedTypes,
 111                             const TargetData &TD);
 112
 113 void ConvertValueToNewType(Value *V, Value *NewVal, ValueMapCache &VMC,
 114                            const TargetData &TD);
 115
 116
 117 // getStructOffsetType - Return a vector of offsets that are to be used to index
 118 // into the specified struct type to get as close as possible to index as we
 119 // can.  Note that it is possible that we cannot get exactly to Offset, in which
 120 // case we update offset to be the offset we actually obtained.  The resultant
 121 // leaf type is returned.
 122 //
 123 // If StopEarly is set to true (the default), the first object with the
 124 // specified type is returned, even if it is a struct type itself.  In this
 125 // case, this routine will not drill down to the leaf type.  Set StopEarly to
 126 // false if you want a leaf
 127 //
 128 const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
 129                                 std::vector<Value*> &Offsets,
 130                                 const TargetData &TD, bool StopEarly = true);
 131
 132 } // End llvm namespace
 133
 134 #endif