lib/Target/X86/X86Subtarget.h

   1 //=====---- X86Subtarget.h - Define Subtarget for the X86 -----*- 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 file declares the X86 specific subclass of TargetSubtarget.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef X86SUBTARGET_H
  15 #define X86SUBTARGET_H
  16
  17 #include "llvm/ADT/Triple.h"
  18 #include "llvm/Target/TargetSubtarget.h"
  19 #include "llvm/CallingConv.h"
  20 #include <string>
  21
  22 #define GET_SUBTARGETINFO_HEADER
  23 #include "X86GenSubtarget.inc"
  24
  25 namespace llvm {
  26 class GlobalValue;
  27 class TargetMachine;
  28
  29 /// PICStyles - The X86 backend supports a number of different styles of PIC.
  30 ///
  31 namespace PICStyles {
  32 enum Style {
  33   StubPIC,          // Used on i386-darwin in -fPIC mode.
  34   StubDynamicNoPIC, // Used on i386-darwin in -mdynamic-no-pic mode.
  35   GOT,              // Used on many 32-bit unices in -fPIC mode.
  36   RIPRel,           // Used on X86-64 when not in -static mode.
  37   None              // Set when in -static mode (not PIC or DynamicNoPIC mode).
  38 };
  39 }
  40
  41 class X86Subtarget : public X86GenSubtargetInfo {
  42 protected:
  43   enum X86SSEEnum {
  44     NoMMXSSE, MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42
  45   };
  46
  47   enum X863DNowEnum {
  48     NoThreeDNow, ThreeDNow, ThreeDNowA
  49   };
  50
  51   /// PICStyle - Which PIC style to use
  52   ///
  53   PICStyles::Style PICStyle;
  54
  55   /// X86SSELevel - MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42, or
  56   /// none supported.
  57   X86SSEEnum X86SSELevel;
  58
  59   /// X863DNowLevel - 3DNow or 3DNow Athlon, or none supported.
  60   ///
  61   X863DNowEnum X863DNowLevel;
  62
  63   /// HasCMov - True if this processor has conditional move instructions
  64   /// (generally pentium pro+).
  65   bool HasCMov;
  66
  67   /// HasX86_64 - True if the processor supports X86-64 instructions.
  68   ///
  69   bool HasX86_64;
  70
  71   /// HasPOPCNT - True if the processor supports POPCNT.
  72   bool HasPOPCNT;
  73
  74   /// HasSSE4A - True if the processor supports SSE4A instructions.
  75   bool HasSSE4A;
  76
  77   /// HasAVX - Target has AVX instructions
  78   bool HasAVX;
  79
  80   /// HasAES - Target has AES instructions
  81   bool HasAES;
  82
  83   /// HasCLMUL - Target has carry-less multiplication
  84   bool HasCLMUL;
  85
  86   /// HasFMA3 - Target has 3-operand fused multiply-add
  87   bool HasFMA3;
  88
  89   /// HasFMA4 - Target has 4-operand fused multiply-add
  90   bool HasFMA4;
  91
  92   /// IsBTMemSlow - True if BT (bit test) of memory instructions are slow.
  93   bool IsBTMemSlow;
  94
  95   /// IsUAMemFast - True if unaligned memory access is fast.
  96   bool IsUAMemFast;
  97
  98   /// HasVectorUAMem - True if SIMD operations can have unaligned memory
  99   /// operands. This may require setting a feature bit in the processor.
 100   bool HasVectorUAMem;
 101
 102   /// stackAlignment - The minimum alignment known to hold of the stack frame on
 103   /// entry to the function and which must be maintained by every function.
 104   unsigned stackAlignment;
 105
 106   /// Max. memset / memcpy size that is turned into rep/movs, rep/stos ops.
 107   ///
 108   unsigned MaxInlineSizeThreshold;
 109
 110   /// TargetTriple - What processor and OS we're targeting.
 111   Triple TargetTriple;
 112
 113 private:
 114   /// Is64Bit - True if the processor supports 64-bit instructions and
 115   /// pointer size is 64 bit.
 116   bool Is64Bit;
 117
 118 public:
 119
 120   /// This constructor initializes the data members to match that
 121   /// of the specified triple.
 122   ///
 123   X86Subtarget(const std::string &TT, const std::string &CPU,
 124                const std::string &FS, bool is64Bit,
 125                unsigned StackAlignOverride);
 126
 127   /// getStackAlignment - Returns the minimum alignment known to hold of the
 128   /// stack frame on entry to the function and which must be maintained by every
 129   /// function for this subtarget.
 130   unsigned getStackAlignment() const { return stackAlignment; }
 131
 132   /// getMaxInlineSizeThreshold - Returns the maximum memset / memcpy size
 133   /// that still makes it profitable to inline the call.
 134   unsigned getMaxInlineSizeThreshold() const { return MaxInlineSizeThreshold; }
 135
 136   /// ParseSubtargetFeatures - Parses features string setting specified
 137   /// subtarget options.  Definition of function is auto generated by tblgen.
 138   void ParseSubtargetFeatures(const std::string &FS, const std::string &CPU);
 139
 140   /// AutoDetectSubtargetFeatures - Auto-detect CPU features using CPUID
 141   /// instruction.
 142   void AutoDetectSubtargetFeatures();
 143
 144   bool is64Bit() const { return Is64Bit; }
 145
 146   PICStyles::Style getPICStyle() const { return PICStyle; }
 147   void setPICStyle(PICStyles::Style Style)  { PICStyle = Style; }
 148
 149   bool hasCMov() const { return HasCMov; }
 150   bool hasMMX() const { return X86SSELevel >= MMX; }
 151   bool hasSSE1() const { return X86SSELevel >= SSE1; }
 152   bool hasSSE2() const { return X86SSELevel >= SSE2; }
 153   bool hasSSE3() const { return X86SSELevel >= SSE3; }
 154   bool hasSSSE3() const { return X86SSELevel >= SSSE3; }
 155   bool hasSSE41() const { return X86SSELevel >= SSE41; }
 156   bool hasSSE42() const { return X86SSELevel >= SSE42; }
 157   bool hasSSE4A() const { return HasSSE4A; }
 158   bool has3DNow() const { return X863DNowLevel >= ThreeDNow; }
 159   bool has3DNowA() const { return X863DNowLevel >= ThreeDNowA; }
 160   bool hasPOPCNT() const { return HasPOPCNT; }
 161   bool hasAVX() const { return HasAVX; }
 162   bool hasXMM() const { return hasSSE1() || hasAVX(); }
 163   bool hasXMMInt() const { return hasSSE2() || hasAVX(); }
 164   bool hasAES() const { return HasAES; }
 165   bool hasCLMUL() const { return HasCLMUL; }
 166   bool hasFMA3() const { return HasFMA3; }
 167   bool hasFMA4() const { return HasFMA4; }
 168   bool isBTMemSlow() const { return IsBTMemSlow; }
 169   bool isUnalignedMemAccessFast() const { return IsUAMemFast; }
 170   bool hasVectorUAMem() const { return HasVectorUAMem; }
 171
 172   const Triple &getTargetTriple() const { return TargetTriple; }
 173
 174   bool isTargetDarwin() const { return TargetTriple.isOSDarwin(); }
 175   bool isTargetFreeBSD() const {
 176     return TargetTriple.getOS() == Triple::FreeBSD;
 177   }
 178   bool isTargetSolaris() const {
 179     return TargetTriple.getOS() == Triple::Solaris;
 180   }
 181
 182   // ELF is a reasonably sane default and the only other X86 targets we
 183   // support are Darwin and Windows. Just use "not those".
 184   bool isTargetELF() const {
 185     return !isTargetDarwin() && !isTargetWindows() && !isTargetCygMing();
 186   }
 187   bool isTargetLinux() const { return TargetTriple.getOS() == Triple::Linux; }
 188
 189   bool isTargetWindows() const { return TargetTriple.getOS() == Triple::Win32; }
 190   bool isTargetMingw() const { return TargetTriple.getOS() == Triple::MinGW32; }
 191   bool isTargetCygwin() const { return TargetTriple.getOS() == Triple::Cygwin; }
 192   bool isTargetCygMing() const {
 193     return isTargetMingw() || isTargetCygwin();
 194   }
 195
 196   /// isTargetCOFF - Return true if this is any COFF/Windows target variant.
 197   bool isTargetCOFF() const {
 198     return isTargetMingw() || isTargetCygwin() || isTargetWindows();
 199   }
 200
 201   bool isTargetWin64() const {
 202     return Is64Bit && (isTargetMingw() || isTargetWindows());
 203   }
 204
 205   bool isTargetEnvMacho() const {
 206     return isTargetDarwin() || (TargetTriple.getEnvironment() == Triple::MachO);
 207   }
 208
 209   bool isTargetWin32() const {
 210     return !Is64Bit && (isTargetMingw() || isTargetWindows());
 211   }
 212
 213   bool isPICStyleSet() const { return PICStyle != PICStyles::None; }
 214   bool isPICStyleGOT() const { return PICStyle == PICStyles::GOT; }
 215   bool isPICStyleRIPRel() const { return PICStyle == PICStyles::RIPRel; }
 216
 217   bool isPICStyleStubPIC() const {
 218     return PICStyle == PICStyles::StubPIC;
 219   }
 220
 221   bool isPICStyleStubNoDynamic() const {
 222     return PICStyle == PICStyles::StubDynamicNoPIC;
 223   }
 224   bool isPICStyleStubAny() const {
 225     return PICStyle == PICStyles::StubDynamicNoPIC ||
 226            PICStyle == PICStyles::StubPIC; }
 227
 228   /// ClassifyGlobalReference - Classify a global variable reference for the
 229   /// current subtarget according to how we should reference it in a non-pcrel
 230   /// context.
 231   unsigned char ClassifyGlobalReference(const GlobalValue *GV,
 232                                         const TargetMachine &TM)const;
 233
 234   /// ClassifyBlockAddressReference - Classify a blockaddress reference for the
 235   /// current subtarget according to how we should reference it in a non-pcrel
 236   /// context.
 237   unsigned char ClassifyBlockAddressReference() const;
 238
 239   /// IsLegalToCallImmediateAddr - Return true if the subtarget allows calls
 240   /// to immediate address.
 241   bool IsLegalToCallImmediateAddr(const TargetMachine &TM) const;
 242
 243   /// This function returns the name of a function which has an interface
 244   /// like the non-standard bzero function, if such a function exists on
 245   /// the current subtarget and it is considered prefereable over
 246   /// memset with zero passed as the second argument. Otherwise it
 247   /// returns null.
 248   const char *getBZeroEntry() const;
 249
 250   /// getSpecialAddressLatency - For targets where it is beneficial to
 251   /// backschedule instructions that compute addresses, return a value
 252   /// indicating the number of scheduling cycles of backscheduling that
 253   /// should be attempted.
 254   unsigned getSpecialAddressLatency() const;
 255 };
 256
 257 } // End llvm namespace
 258
 259 #endif