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 LLVM_LIB_TARGET_X86_X86SUBTARGET_H
  15 #define LLVM_LIB_TARGET_X86_X86SUBTARGET_H
  16
  17 #include "X86FrameLowering.h"
  18 #include "X86ISelLowering.h"
  19 #include "X86InstrInfo.h"
  20 #include "X86JITInfo.h"
  21 #include "X86SelectionDAGInfo.h"
  22 #include "llvm/ADT/Triple.h"
  23 #include "llvm/IR/CallingConv.h"
  24 #include "llvm/Target/TargetSubtargetInfo.h"
  25 #include <string>
  26
  27 #define GET_SUBTARGETINFO_HEADER
  28 #include "X86GenSubtargetInfo.inc"
  29
  30 namespace llvm {
  31 class GlobalValue;
  32 class StringRef;
  33 class TargetMachine;
  34
  35 /// PICStyles - The X86 backend supports a number of different styles of PIC.
  36 ///
  37 namespace PICStyles {
  38 enum Style {
  39   StubPIC,          // Used on i386-darwin in -fPIC mode.
  40   StubDynamicNoPIC, // Used on i386-darwin in -mdynamic-no-pic mode.
  41   GOT,              // Used on many 32-bit unices in -fPIC mode.
  42   RIPRel,           // Used on X86-64 when not in -static mode.
  43   None              // Set when in -static mode (not PIC or DynamicNoPIC mode).
  44 };
  45 }
  46
  47 class X86Subtarget final : public X86GenSubtargetInfo {
  48
  49 protected:
  50   enum X86SSEEnum {
  51     NoMMXSSE, MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42, AVX, AVX2, AVX512F
  52   };
  53
  54   enum X863DNowEnum {
  55     NoThreeDNow, ThreeDNow, ThreeDNowA
  56   };
  57
  58   enum X86ProcFamilyEnum {
  59     Others, IntelAtom, IntelSLM
  60   };
  61
  62   /// X86ProcFamily - X86 processor family: Intel Atom, and others
  63   X86ProcFamilyEnum X86ProcFamily;
  64
  65   /// PICStyle - Which PIC style to use
  66   ///
  67   PICStyles::Style PICStyle;
  68
  69   /// X86SSELevel - MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42, or
  70   /// none supported.
  71   X86SSEEnum X86SSELevel;
  72
  73   /// X863DNowLevel - 3DNow or 3DNow Athlon, or none supported.
  74   ///
  75   X863DNowEnum X863DNowLevel;
  76
  77   /// HasCMov - True if this processor has conditional move instructions
  78   /// (generally pentium pro+).
  79   bool HasCMov;
  80
  81   /// HasX86_64 - True if the processor supports X86-64 instructions.
  82   ///
  83   bool HasX86_64;
  84
  85   /// HasPOPCNT - True if the processor supports POPCNT.
  86   bool HasPOPCNT;
  87
  88   /// HasSSE4A - True if the processor supports SSE4A instructions.
  89   bool HasSSE4A;
  90
  91   /// HasAES - Target has AES instructions
  92   bool HasAES;
  93
  94   /// HasPCLMUL - Target has carry-less multiplication
  95   bool HasPCLMUL;
  96
  97   /// HasFMA - Target has 3-operand fused multiply-add
  98   bool HasFMA;
  99
 100   /// HasFMA4 - Target has 4-operand fused multiply-add
 101   bool HasFMA4;
 102
 103   /// HasXOP - Target has XOP instructions
 104   bool HasXOP;
 105
 106   /// HasTBM - Target has TBM instructions.
 107   bool HasTBM;
 108
 109   /// HasMOVBE - True if the processor has the MOVBE instruction.
 110   bool HasMOVBE;
 111
 112   /// HasRDRAND - True if the processor has the RDRAND instruction.
 113   bool HasRDRAND;
 114
 115   /// HasF16C - Processor has 16-bit floating point conversion instructions.
 116   bool HasF16C;
 117
 118   /// HasFSGSBase - Processor has FS/GS base insturctions.
 119   bool HasFSGSBase;
 120
 121   /// HasLZCNT - Processor has LZCNT instruction.
 122   bool HasLZCNT;
 123
 124   /// HasBMI - Processor has BMI1 instructions.
 125   bool HasBMI;
 126
 127   /// HasBMI2 - Processor has BMI2 instructions.
 128   bool HasBMI2;
 129
 130   /// HasRTM - Processor has RTM instructions.
 131   bool HasRTM;
 132
 133   /// HasHLE - Processor has HLE.
 134   bool HasHLE;
 135
 136   /// HasADX - Processor has ADX instructions.
 137   bool HasADX;
 138
 139   /// HasSHA - Processor has SHA instructions.
 140   bool HasSHA;
 141
 142   /// HasSGX - Processor has SGX instructions.
 143   bool HasSGX;
 144
 145   /// HasPRFCHW - Processor has PRFCHW instructions.
 146   bool HasPRFCHW;
 147
 148   /// HasRDSEED - Processor has RDSEED instructions.
 149   bool HasRDSEED;
 150
 151   /// IsBTMemSlow - True if BT (bit test) of memory instructions are slow.
 152   bool IsBTMemSlow;
 153
 154   /// IsSHLDSlow - True if SHLD instructions are slow.
 155   bool IsSHLDSlow;
 156
 157   /// IsUAMemFast - True if unaligned memory access is fast.
 158   bool IsUAMemFast;
 159
 160   /// HasVectorUAMem - True if SIMD operations can have unaligned memory
 161   /// operands. This may require setting a feature bit in the processor.
 162   bool HasVectorUAMem;
 163
 164   /// HasCmpxchg16b - True if this processor has the CMPXCHG16B instruction;
 165   /// this is true for most x86-64 chips, but not the first AMD chips.
 166   bool HasCmpxchg16b;
 167
 168   /// UseLeaForSP - True if the LEA instruction should be used for adjusting
 169   /// the stack pointer. This is an optimization for Intel Atom processors.
 170   bool UseLeaForSP;
 171
 172   /// HasSlowDivide - True if smaller divides are significantly faster than
 173   /// full divides and should be used when possible.
 174   bool HasSlowDivide;
 175
 176   /// PadShortFunctions - True if the short functions should be padded to prevent
 177   /// a stall when returning too early.
 178   bool PadShortFunctions;
 179
 180   /// CallRegIndirect - True if the Calls with memory reference should be converted
 181   /// to a register-based indirect call.
 182   bool CallRegIndirect;
 183   /// LEAUsesAG - True if the LEA instruction inputs have to be ready at
 184   ///             address generation (AG) time.
 185   bool LEAUsesAG;
 186
 187   /// SlowLEA - True if the LEA instruction with certain arguments is slow
 188   bool SlowLEA;
 189
 190   /// SlowIncDec - True if INC and DEC instructions are slow when writing to flags
 191   bool SlowIncDec;
 192
 193   /// Processor has AVX-512 PreFetch Instructions
 194   bool HasPFI;
 195
 196   /// Processor has AVX-512 Exponential and Reciprocal Instructions
 197   bool HasERI;
 198
 199   /// Processor has AVX-512 Conflict Detection Instructions
 200   bool HasCDI;
 201
 202   /// Processor has AVX-512 Doubleword and Quadword instructions
 203   bool HasDQI;
 204
 205   /// Processor has AVX-512 Byte and Word instructions
 206   bool HasBWI;
 207
 208   /// Processor has AVX-512 Vector Length eXtenstions
 209   bool HasVLX;
 210
 211   /// stackAlignment - The minimum alignment known to hold of the stack frame on
 212   /// entry to the function and which must be maintained by every function.
 213   unsigned stackAlignment;
 214
 215   /// Max. memset / memcpy size that is turned into rep/movs, rep/stos ops.
 216   ///
 217   unsigned MaxInlineSizeThreshold;
 218
 219   /// TargetTriple - What processor and OS we're targeting.
 220   Triple TargetTriple;
 221
 222   /// Instruction itineraries for scheduling
 223   InstrItineraryData InstrItins;
 224
 225 private:
 226   // Calculates type size & alignment
 227   const DataLayout DL;
 228
 229   /// StackAlignOverride - Override the stack alignment.
 230   unsigned StackAlignOverride;
 231
 232   /// In64BitMode - True if compiling for 64-bit, false for 16-bit or 32-bit.
 233   bool In64BitMode;
 234
 235   /// In32BitMode - True if compiling for 32-bit, false for 16-bit or 64-bit.
 236   bool In32BitMode;
 237
 238   /// In16BitMode - True if compiling for 16-bit, false for 32-bit or 64-bit.
 239   bool In16BitMode;
 240
 241   X86SelectionDAGInfo TSInfo;
 242   // Ordering here is important. X86InstrInfo initializes X86RegisterInfo which
 243   // X86TargetLowering needs.
 244   X86InstrInfo InstrInfo;
 245   X86TargetLowering TLInfo;
 246   X86FrameLowering FrameLowering;
 247   X86JITInfo JITInfo;
 248
 249 public:
 250   /// This constructor initializes the data members to match that
 251   /// of the specified triple.
 252   ///
 253   X86Subtarget(const std::string &TT, const std::string &CPU,
 254                const std::string &FS, X86TargetMachine &TM,
 255                unsigned StackAlignOverride);
 256
 257   const X86TargetLowering *getTargetLowering() const override {
 258     return &TLInfo;
 259   }
 260   const X86InstrInfo *getInstrInfo() const override { return &InstrInfo; }
 261   const DataLayout *getDataLayout() const override { return &DL; }
 262   const X86FrameLowering *getFrameLowering() const override {
 263     return &FrameLowering;
 264   }
 265   const X86SelectionDAGInfo *getSelectionDAGInfo() const override {
 266     return &TSInfo;
 267   }
 268   const X86RegisterInfo *getRegisterInfo() const override {
 269     return &getInstrInfo()->getRegisterInfo();
 270   }
 271   X86JITInfo *getJITInfo() override { return &JITInfo; }
 272
 273   /// getStackAlignment - Returns the minimum alignment known to hold of the
 274   /// stack frame on entry to the function and which must be maintained by every
 275   /// function for this subtarget.
 276   unsigned getStackAlignment() const { return stackAlignment; }
 277
 278   /// getMaxInlineSizeThreshold - Returns the maximum memset / memcpy size
 279   /// that still makes it profitable to inline the call.
 280   unsigned getMaxInlineSizeThreshold() const { return MaxInlineSizeThreshold; }
 281
 282   /// ParseSubtargetFeatures - Parses features string setting specified
 283   /// subtarget options.  Definition of function is auto generated by tblgen.
 284   void ParseSubtargetFeatures(StringRef CPU, StringRef FS);
 285
 286   /// \brief Reset the features for the X86 target.
 287   void resetSubtargetFeatures(const MachineFunction *MF) override;
 288 private:
 289   /// \brief Initialize the full set of dependencies so we can use an initializer
 290   /// list for X86Subtarget.
 291   X86Subtarget &initializeSubtargetDependencies(StringRef CPU, StringRef FS);
 292   void initializeEnvironment();
 293   void resetSubtargetFeatures(StringRef CPU, StringRef FS);
 294 public:
 295   /// Is this x86_64? (disregarding specific ABI / programming model)
 296   bool is64Bit() const {
 297     return In64BitMode;
 298   }
 299
 300   bool is32Bit() const {
 301     return In32BitMode;
 302   }
 303
 304   bool is16Bit() const {
 305     return In16BitMode;
 306   }
 307
 308   /// Is this x86_64 with the ILP32 programming model (x32 ABI)?
 309   bool isTarget64BitILP32() const {
 310     return In64BitMode && (TargetTriple.getEnvironment() == Triple::GNUX32 ||
 311                            TargetTriple.getOS() == Triple::NaCl);
 312   }
 313
 314   /// Is this x86_64 with the LP64 programming model (standard AMD64, no x32)?
 315   bool isTarget64BitLP64() const {
 316     return In64BitMode && (TargetTriple.getEnvironment() != Triple::GNUX32 &&
 317                            TargetTriple.getOS() != Triple::NaCl);
 318   }
 319
 320   PICStyles::Style getPICStyle() const { return PICStyle; }
 321   void setPICStyle(PICStyles::Style Style)  { PICStyle = Style; }
 322
 323   bool hasCMov() const { return HasCMov; }
 324   bool hasMMX() const { return X86SSELevel >= MMX; }
 325   bool hasSSE1() const { return X86SSELevel >= SSE1; }
 326   bool hasSSE2() const { return X86SSELevel >= SSE2; }
 327   bool hasSSE3() const { return X86SSELevel >= SSE3; }
 328   bool hasSSSE3() const { return X86SSELevel >= SSSE3; }
 329   bool hasSSE41() const { return X86SSELevel >= SSE41; }
 330   bool hasSSE42() const { return X86SSELevel >= SSE42; }
 331   bool hasAVX() const { return X86SSELevel >= AVX; }
 332   bool hasAVX2() const { return X86SSELevel >= AVX2; }
 333   bool hasAVX512() const { return X86SSELevel >= AVX512F; }
 334   bool hasFp256() const { return hasAVX(); }
 335   bool hasInt256() const { return hasAVX2(); }
 336   bool hasSSE4A() const { return HasSSE4A; }
 337   bool has3DNow() const { return X863DNowLevel >= ThreeDNow; }
 338   bool has3DNowA() const { return X863DNowLevel >= ThreeDNowA; }
 339   bool hasPOPCNT() const { return HasPOPCNT; }
 340   bool hasAES() const { return HasAES; }
 341   bool hasPCLMUL() const { return HasPCLMUL; }
 342   bool hasFMA() const { return HasFMA; }
 343   // FIXME: Favor FMA when both are enabled. Is this the right thing to do?
 344   bool hasFMA4() const { return HasFMA4 && !HasFMA; }
 345   bool hasXOP() const { return HasXOP; }
 346   bool hasTBM() const { return HasTBM; }
 347   bool hasMOVBE() const { return HasMOVBE; }
 348   bool hasRDRAND() const { return HasRDRAND; }
 349   bool hasF16C() const { return HasF16C; }
 350   bool hasFSGSBase() const { return HasFSGSBase; }
 351   bool hasLZCNT() const { return HasLZCNT; }
 352   bool hasBMI() const { return HasBMI; }
 353   bool hasBMI2() const { return HasBMI2; }
 354   bool hasRTM() const { return HasRTM; }
 355   bool hasHLE() const { return HasHLE; }
 356   bool hasADX() const { return HasADX; }
 357   bool hasSHA() const { return HasSHA; }
 358   bool hasSGX() const { return HasSGX; }
 359   bool hasPRFCHW() const { return HasPRFCHW; }
 360   bool hasRDSEED() const { return HasRDSEED; }
 361   bool isBTMemSlow() const { return IsBTMemSlow; }
 362   bool isSHLDSlow() const { return IsSHLDSlow; }
 363   bool isUnalignedMemAccessFast() const { return IsUAMemFast; }
 364   bool hasVectorUAMem() const { return HasVectorUAMem; }
 365   bool hasCmpxchg16b() const { return HasCmpxchg16b; }
 366   bool useLeaForSP() const { return UseLeaForSP; }
 367   bool hasSlowDivide() const { return HasSlowDivide; }
 368   bool padShortFunctions() const { return PadShortFunctions; }
 369   bool callRegIndirect() const { return CallRegIndirect; }
 370   bool LEAusesAG() const { return LEAUsesAG; }
 371   bool slowLEA() const { return SlowLEA; }
 372   bool slowIncDec() const { return SlowIncDec; }
 373   bool hasCDI() const { return HasCDI; }
 374   bool hasPFI() const { return HasPFI; }
 375   bool hasERI() const { return HasERI; }
 376   bool hasDQI() const { return HasDQI; }
 377   bool hasBWI() const { return HasBWI; }
 378   bool hasVLX() const { return HasVLX; }
 379
 380   bool isAtom() const { return X86ProcFamily == IntelAtom; }
 381   bool isSLM() const { return X86ProcFamily == IntelSLM; }
 382
 383   const Triple &getTargetTriple() const { return TargetTriple; }
 384
 385   bool isTargetDarwin() const { return TargetTriple.isOSDarwin(); }
 386   bool isTargetFreeBSD() const {
 387     return TargetTriple.getOS() == Triple::FreeBSD;
 388   }
 389   bool isTargetSolaris() const {
 390     return TargetTriple.getOS() == Triple::Solaris;
 391   }
 392
 393   bool isTargetELF() const { return TargetTriple.isOSBinFormatELF(); }
 394   bool isTargetCOFF() const { return TargetTriple.isOSBinFormatCOFF(); }
 395   bool isTargetMacho() const { return TargetTriple.isOSBinFormatMachO(); }
 396
 397   bool isTargetLinux() const { return TargetTriple.isOSLinux(); }
 398   bool isTargetNaCl() const { return TargetTriple.isOSNaCl(); }
 399   bool isTargetNaCl32() const { return isTargetNaCl() && !is64Bit(); }
 400   bool isTargetNaCl64() const { return isTargetNaCl() && is64Bit(); }
 401
 402   bool isTargetWindowsMSVC() const {
 403     return TargetTriple.isWindowsMSVCEnvironment();
 404   }
 405
 406   bool isTargetKnownWindowsMSVC() const {
 407     return TargetTriple.isKnownWindowsMSVCEnvironment();
 408   }
 409
 410   bool isTargetWindowsCygwin() const {
 411     return TargetTriple.isWindowsCygwinEnvironment();
 412   }
 413
 414   bool isTargetWindowsGNU() const {
 415     return TargetTriple.isWindowsGNUEnvironment();
 416   }
 417
 418   bool isTargetCygMing() const { return TargetTriple.isOSCygMing(); }
 419
 420   bool isOSWindows() const { return TargetTriple.isOSWindows(); }
 421
 422   bool isTargetWin64() const {
 423     return In64BitMode && TargetTriple.isOSWindows();
 424   }
 425
 426   bool isTargetWin32() const {
 427     return !In64BitMode && (isTargetCygMing() || isTargetKnownWindowsMSVC());
 428   }
 429
 430   bool isPICStyleSet() const { return PICStyle != PICStyles::None; }
 431   bool isPICStyleGOT() const { return PICStyle == PICStyles::GOT; }
 432   bool isPICStyleRIPRel() const { return PICStyle == PICStyles::RIPRel; }
 433
 434   bool isPICStyleStubPIC() const {
 435     return PICStyle == PICStyles::StubPIC;
 436   }
 437
 438   bool isPICStyleStubNoDynamic() const {
 439     return PICStyle == PICStyles::StubDynamicNoPIC;
 440   }
 441   bool isPICStyleStubAny() const {
 442     return PICStyle == PICStyles::StubDynamicNoPIC ||
 443            PICStyle == PICStyles::StubPIC;
 444   }
 445
 446   bool isCallingConvWin64(CallingConv::ID CC) const {
 447     return (isTargetWin64() && CC != CallingConv::X86_64_SysV) ||
 448            CC == CallingConv::X86_64_Win64;
 449   }
 450
 451   /// ClassifyGlobalReference - Classify a global variable reference for the
 452   /// current subtarget according to how we should reference it in a non-pcrel
 453   /// context.
 454   unsigned char ClassifyGlobalReference(const GlobalValue *GV,
 455                                         const TargetMachine &TM)const;
 456
 457   /// ClassifyBlockAddressReference - Classify a blockaddress reference for the
 458   /// current subtarget according to how we should reference it in a non-pcrel
 459   /// context.
 460   unsigned char ClassifyBlockAddressReference() const;
 461
 462   /// IsLegalToCallImmediateAddr - Return true if the subtarget allows calls
 463   /// to immediate address.
 464   bool IsLegalToCallImmediateAddr(const TargetMachine &TM) const;
 465
 466   /// This function returns the name of a function which has an interface
 467   /// like the non-standard bzero function, if such a function exists on
 468   /// the current subtarget and it is considered prefereable over
 469   /// memset with zero passed as the second argument. Otherwise it
 470   /// returns null.
 471   const char *getBZeroEntry() const;
 472
 473   /// This function returns true if the target has sincos() routine in its
 474   /// compiler runtime or math libraries.
 475   bool hasSinCos() const;
 476
 477   /// Enable the MachineScheduler pass for all X86 subtargets.
 478   bool enableMachineScheduler() const override { return true; }
 479
 480   bool enableEarlyIfConversion() const override;
 481
 482   /// getInstrItins = Return the instruction itineraries based on the
 483   /// subtarget selection.
 484   const InstrItineraryData *getInstrItineraryData() const override {
 485     return &InstrItins;
 486   }
 487
 488   AntiDepBreakMode getAntiDepBreakMode() const override {
 489     return TargetSubtargetInfo::ANTIDEP_CRITICAL;
 490   }
 491 };
 492
 493 } // End llvm namespace
 494
 495 #endif