include/llvm/TargetTransformInfo.h

   1 //===- llvm/Transforms/TargetTransformInfo.h --------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass exposes codegen information to IR-level passes. Every
  11 // transformation that uses codegen information is broken into three parts:
  12 // 1. The IR-level analysis pass.
  13 // 2. The IR-level transformation interface which provides the needed
  14 //    information.
  15 // 3. Codegen-level implementation which uses target-specific hooks.
  16 //
  17 // This file defines #2, which is the interface that IR-level transformations
  18 // use for querying the codegen.
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #ifndef LLVM_TRANSFORMS_TARGET_TRANSFORM_INTERFACE
  23 #define LLVM_TRANSFORMS_TARGET_TRANSFORM_INTERFACE
  24
  25 #include "llvm/Pass.h"
  26 #include "llvm/AddressingMode.h"
  27 #include "llvm/Support/DataTypes.h"
  28 #include "llvm/Type.h"
  29
  30 namespace llvm {
  31
  32 class ScalarTargetTransformInfo;
  33 class VectorTargetTransformInfo;
  34
  35 /// TargetTransformInfo - This pass provides access to the codegen
  36 /// interfaces that are needed for IR-level transformations.
  37 class TargetTransformInfo : public ImmutablePass {
  38 private:
  39   const ScalarTargetTransformInfo *STTI;
  40   const VectorTargetTransformInfo *VTTI;
  41 public:
  42   /// Default ctor.
  43   ///
  44   /// @note This has to exist, because this is a pass, but it should never be
  45   /// used.
  46   TargetTransformInfo();
  47
  48   TargetTransformInfo(const ScalarTargetTransformInfo* S,
  49                       const VectorTargetTransformInfo *V)
  50       : ImmutablePass(ID), STTI(S), VTTI(V) {
  51     initializeTargetTransformInfoPass(*PassRegistry::getPassRegistry());
  52   }
  53
  54   TargetTransformInfo(const TargetTransformInfo &T) :
  55     ImmutablePass(ID), STTI(T.STTI), VTTI(T.VTTI) { }
  56
  57   const ScalarTargetTransformInfo* getScalarTargetTransformInfo() const {
  58     return STTI;
  59   }
  60   const VectorTargetTransformInfo* getVectorTargetTransformInfo() const {
  61     return VTTI;
  62   }
  63
  64   /// Pass identification, replacement for typeid.
  65   static char ID;
  66 };
  67
  68 // ---------------------------------------------------------------------------//
  69 //  The classes below are inherited and implemented by target-specific classes
  70 //  in the codegen.
  71 // ---------------------------------------------------------------------------//
  72
  73 /// ScalarTargetTransformInfo - This interface is used by IR-level passes
  74 /// that need target-dependent information for generic scalar transformations.
  75 /// LSR, and LowerInvoke use this interface.
  76 class ScalarTargetTransformInfo {
  77 public:
  78   virtual ~ScalarTargetTransformInfo() {}
  79
  80   /// isLegalAddImmediate - Return true if the specified immediate is legal
  81   /// add immediate, that is the target has add instructions which can add
  82   /// a register with the immediate without having to materialize the
  83   /// immediate into a register.
  84   virtual bool isLegalAddImmediate(int64_t) const {
  85     return false;
  86   }
  87   /// isLegalICmpImmediate - Return true if the specified immediate is legal
  88   /// icmp immediate, that is the target has icmp instructions which can compare
  89   /// a register against the immediate without having to materialize the
  90   /// immediate into a register.
  91   virtual bool isLegalICmpImmediate(int64_t) const {
  92     return false;
  93   }
  94   /// isLegalAddressingMode - Return true if the addressing mode represented by
  95   /// AM is legal for this target, for a load/store of the specified type.
  96   /// The type may be VoidTy, in which case only return true if the addressing
  97   /// mode is legal for a load/store of any legal type.
  98   /// TODO: Handle pre/postinc as well.
  99   virtual bool isLegalAddressingMode(const AddrMode &AM, Type *Ty) const {
 100     return false;
 101   }
 102   /// isTruncateFree - Return true if it's free to truncate a value of
 103   /// type Ty1 to type Ty2. e.g. On x86 it's free to truncate a i32 value in
 104   /// register EAX to i16 by referencing its sub-register AX.
 105   virtual bool isTruncateFree(Type *Ty1, Type *Ty2) const {
 106     return false;
 107   }
 108   /// Is this type legal.
 109   virtual bool isTypeLegal(Type *Ty) const {
 110     return false;
 111   }
 112   /// getJumpBufAlignment - returns the target's jmp_buf alignment in bytes
 113   virtual unsigned getJumpBufAlignment() const {
 114     return 0;
 115   }
 116   /// getJumpBufSize - returns the target's jmp_buf size in bytes.
 117   virtual unsigned getJumpBufSize() const {
 118     return 0;
 119   }
 120 };
 121
 122 /// VectorTargetTransformInfo - This interface is used by the vectorizers
 123 /// to estimate the profitability of vectorization for different instructions.
 124 class VectorTargetTransformInfo {
 125 public:
 126   virtual ~VectorTargetTransformInfo() {}
 127
 128   /// Returns the expected cost of the instruction opcode. The opcode is one of
 129   /// the enums like Instruction::Add. The type arguments are the type of the
 130   /// operation.
 131   /// Most instructions only use the first type and in that case the second
 132   /// operand is ignored.
 133   ///
 134   /// Exceptions:
 135   /// * Br instructions do not use any of the types.
 136   /// * Select instructions pass the return type as Ty1 and the selector as Ty2.
 137   /// * Cast instructions pass the destination as Ty1 and the source as Ty2.
 138   /// * Insert/Extract element pass only the vector type as Ty1.
 139   /// * ShuffleVector, Load, Store do not use this call.
 140   virtual unsigned getInstrCost(unsigned Opcode,
 141                                 Type *Ty1 = 0,
 142                                 Type *Ty2 = 0) const {
 143     return 1;
 144   }
 145
 146   /// Returns the expected cost of arithmetic ops, such as mul, xor, fsub, etc.
 147   virtual unsigned getArithmeticInstrCost(unsigned Opcode, Type *Ty) const {
 148     return 1;
 149   }
 150
 151   /// Returns the cost of a vector broadcast of a scalar at place zero to a
 152   /// vector of type 'Tp'.
 153   virtual unsigned getBroadcastCost(Type *Tp) const {
 154     return 1;
 155   }
 156
 157   /// Returns the expected cost of cast instructions, such as bitcast, trunc,
 158   /// zext, etc.
 159   virtual unsigned getCastInstrCost(unsigned Opcode, Type *Dst,
 160                                     Type *Src) const {
 161     return 1;
 162   }
 163
 164   /// Returns the expected cost of control-flow related instrutctions such as
 165   /// Phi, Ret, Br.
 166   virtual unsigned getCFInstrCost(unsigned Opcode) const {
 167     return 1;
 168   }
 169
 170   /// Returns the expected cost of compare and select instructions.
 171   virtual unsigned getCmpSelInstrCost(unsigned Opcode, Type *ValTy,
 172                                       Type *CondTy = 0) const {
 173     return 1;
 174   }
 175
 176   /// Returns the expected cost of vector Insert and Extract.
 177   virtual unsigned getVectorInstrCost(unsigned Opcode, Type *Val,
 178                                       unsigned Index = 0) const {
 179     return 1;
 180   }
 181
 182   /// Returns the cost of Load and Store instructions.
 183   virtual unsigned getMemoryOpCost(unsigned Opcode, Type *Src,
 184                                    unsigned Alignment,
 185                                    unsigned AddressSpace) const {
 186     return 1;
 187   }
 188
 189   /// Returns the number of pieces into which the provided type must be
 190   /// split during legalization. Zero is returned when the answer is unknown.
 191   virtual unsigned getNumberOfParts(Type *Tp) const {
 192     return 0;
 193   }
 194 };
 195
 196 } // End llvm namespace
 197
 198 #endif