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