1 //===-- X86Subtarget.h - Define Subtarget for the X86 ----------*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the X86 specific subclass of TargetSubtargetInfo.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_TARGET_X86_X86SUBTARGET_H
15 #define LLVM_LIB_TARGET_X86_X86SUBTARGET_H
17 #include "X86FrameLowering.h"
18 #include "X86ISelLowering.h"
19 #include "X86InstrInfo.h"
20 #include "X86SelectionDAGInfo.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/CodeGen/GlobalISel/CallLowering.h"
24 #include "llvm/CodeGen/GlobalISel/InstructionSelector.h"
25 #include "llvm/CodeGen/GlobalISel/LegalizerInfo.h"
26 #include "llvm/CodeGen/GlobalISel/RegisterBankInfo.h"
27 #include "llvm/CodeGen/TargetSubtargetInfo.h"
28 #include "llvm/IR/CallingConv.h"
29 #include "llvm/MC/MCInstrItineraries.h"
30 #include "llvm/Target/TargetMachine.h"
33 #define GET_SUBTARGETINFO_HEADER
34 #include "X86GenSubtargetInfo.inc"
40 /// The X86 backend supports a number of different styles of PIC.
45 StubPIC, // Used on i386-darwin in pic mode.
46 GOT, // Used on 32 bit elf on when in pic mode.
47 RIPRel, // Used on X86-64 when in pic mode.
48 None // Set when not in pic mode.
51 } // end namespace PICStyles
53 class X86Subtarget final : public X86GenSubtargetInfo {
55 enum X86ProcFamilyEnum {
71 NoSSE, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42, AVX, AVX2, AVX512F
75 NoThreeDNow, MMX, ThreeDNow, ThreeDNowA
78 /// X86 processor family: Intel Atom, and others
79 X86ProcFamilyEnum X86ProcFamily;
81 /// Which PIC style to use
82 PICStyles::Style PICStyle;
84 const TargetMachine &TM;
86 /// SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42, or none supported.
87 X86SSEEnum X86SSELevel;
89 /// MMX, 3DNow, 3DNow Athlon, or none supported.
90 X863DNowEnum X863DNowLevel;
92 /// True if the processor supports X87 instructions.
95 /// True if this processor has conditional move instructions
96 /// (generally pentium pro+).
99 /// True if the processor supports X86-64 instructions.
102 /// True if the processor supports POPCNT.
105 /// True if the processor supports SSE4A instructions.
108 /// Target has AES instructions
112 /// Target has FXSAVE/FXRESTOR instructions
115 /// Target has XSAVE instructions
118 /// Target has XSAVEOPT instructions
121 /// Target has XSAVEC instructions
124 /// Target has XSAVES instructions
127 /// Target has carry-less multiplication
131 /// Target has Galois Field Arithmetic instructions
134 /// Target has 3-operand fused multiply-add
137 /// Target has 4-operand fused multiply-add
140 /// Target has XOP instructions
143 /// Target has TBM instructions.
146 /// Target has LWP instructions
149 /// True if the processor has the MOVBE instruction.
152 /// True if the processor has the RDRAND instruction.
155 /// Processor has 16-bit floating point conversion instructions.
158 /// Processor has FS/GS base insturctions.
161 /// Processor has LZCNT instruction.
164 /// Processor has BMI1 instructions.
167 /// Processor has BMI2 instructions.
170 /// Processor has VBMI instructions.
173 /// Processor has VBMI2 instructions.
176 /// Processor has Integer Fused Multiply Add
179 /// Processor has RTM instructions.
182 /// Processor has ADX instructions.
185 /// Processor has SHA instructions.
188 /// Processor has PRFCHW instructions.
191 /// Processor has RDSEED instructions.
194 /// Processor has LAHF/SAHF instructions.
197 /// Processor has MONITORX/MWAITX instructions.
200 /// Processor has Cache Line Zero instruction
203 /// Processor has Prefetch with intent to Write instruction
204 bool HasPFPREFETCHWT1;
206 /// True if SHLD instructions are slow.
209 /// True if the PMULLD instruction is slow compared to PMULLW/PMULHW and
213 /// True if unaligned memory accesses of 16-bytes are slow.
216 /// True if unaligned memory accesses of 32-bytes are slow.
219 /// True if SSE operations can have unaligned memory operands.
220 /// This may require setting a configuration bit in the processor.
221 bool HasSSEUnalignedMem;
223 /// True if this processor has the CMPXCHG16B instruction;
224 /// this is true for most x86-64 chips, but not the first AMD chips.
227 /// True if the LEA instruction should be used for adjusting
228 /// the stack pointer. This is an optimization for Intel Atom processors.
231 /// True if there is no performance penalty to writing only the lower parts
232 /// of a YMM or ZMM register without clearing the upper part.
233 bool HasFastPartialYMMorZMMWrite;
235 /// True if gather is reasonably fast. This is true for Skylake client and
236 /// all AVX-512 CPUs.
239 /// True if hardware SQRTSS instruction is at least as fast (latency) as
240 /// RSQRTSS followed by a Newton-Raphson iteration.
241 bool HasFastScalarFSQRT;
243 /// True if hardware SQRTPS/VSQRTPS instructions are at least as fast
244 /// (throughput) as RSQRTPS/VRSQRTPS followed by a Newton-Raphson iteration.
245 bool HasFastVectorFSQRT;
247 /// True if 8-bit divisions are significantly faster than
248 /// 32-bit divisions and should be used when possible.
249 bool HasSlowDivide32;
251 /// True if 32-bit divides are significantly faster than
252 /// 64-bit divisions and should be used when possible.
253 bool HasSlowDivide64;
255 /// True if LZCNT instruction is fast.
258 /// True if SHLD based rotate is fast.
259 bool HasFastSHLDRotate;
261 /// True if the processor supports macrofusion.
264 /// True if the processor has enhanced REP MOVSB/STOSB.
267 /// True if the short functions should be padded to prevent
268 /// a stall when returning too early.
269 bool PadShortFunctions;
271 /// True if two memory operand instructions should use a temporary register
275 /// True if the LEA instruction inputs have to be ready at address generation
279 /// True if the LEA instruction with certain arguments is slow
282 /// True if the LEA instruction has all three source operands: base, index,
283 /// and offset or if the LEA instruction uses base and index registers where
284 /// the base is EBP, RBP,or R13
287 /// True if INC and DEC instructions are slow when writing to flags
290 /// Processor has AVX-512 PreFetch Instructions
293 /// Processor has AVX-512 Exponential and Reciprocal Instructions
296 /// Processor has AVX-512 Conflict Detection Instructions
299 /// Processor has AVX-512 population count Instructions
302 /// Processor has AVX-512 Doubleword and Quadword instructions
305 /// Processor has AVX-512 Byte and Word instructions
308 /// Processor has AVX-512 Vector Length eXtenstions
311 /// Processor has PKU extenstions
314 /// Processor has AVX-512 Vector Neural Network Instructions
317 /// Processor has AVX-512 Bit Algorithms instructions
320 /// Processor supports MPX - Memory Protection Extensions
323 /// Processor supports CET SHSTK - Control-Flow Enforcement Technology
324 /// using Shadow Stack
327 /// Processor supports CET IBT - Control-Flow Enforcement Technology
328 /// using Indirect Branch Tracking
331 /// Processor has Software Guard Extensions
334 /// Processor supports Flush Cache Line instruction
337 /// Processor supports Cache Line Write Back instruction
340 /// Use software floating point for code generation.
343 /// The minimum alignment known to hold of the stack frame on
344 /// entry to the function and which must be maintained by every function.
345 unsigned stackAlignment;
347 /// Max. memset / memcpy size that is turned into rep/movs, rep/stos ops.
349 unsigned MaxInlineSizeThreshold;
351 /// What processor and OS we're targeting.
354 /// Instruction itineraries for scheduling
355 InstrItineraryData InstrItins;
357 /// GlobalISel related APIs.
358 std::unique_ptr<CallLowering> CallLoweringInfo;
359 std::unique_ptr<LegalizerInfo> Legalizer;
360 std::unique_ptr<RegisterBankInfo> RegBankInfo;
361 std::unique_ptr<InstructionSelector> InstSelector;
364 /// Override the stack alignment.
365 unsigned StackAlignOverride;
367 /// True if compiling for 64-bit, false for 16-bit or 32-bit.
370 /// True if compiling for 32-bit, false for 16-bit or 64-bit.
373 /// True if compiling for 16-bit, false for 32-bit or 64-bit.
376 /// Contains the Overhead of gather\scatter instructions
380 X86SelectionDAGInfo TSInfo;
381 // Ordering here is important. X86InstrInfo initializes X86RegisterInfo which
382 // X86TargetLowering needs.
383 X86InstrInfo InstrInfo;
384 X86TargetLowering TLInfo;
385 X86FrameLowering FrameLowering;
388 /// This constructor initializes the data members to match that
389 /// of the specified triple.
391 X86Subtarget(const Triple &TT, StringRef CPU, StringRef FS,
392 const X86TargetMachine &TM, unsigned StackAlignOverride);
394 const X86TargetLowering *getTargetLowering() const override {
398 const X86InstrInfo *getInstrInfo() const override { return &InstrInfo; }
400 const X86FrameLowering *getFrameLowering() const override {
401 return &FrameLowering;
404 const X86SelectionDAGInfo *getSelectionDAGInfo() const override {
408 const X86RegisterInfo *getRegisterInfo() const override {
409 return &getInstrInfo()->getRegisterInfo();
412 /// Returns the minimum alignment known to hold of the
413 /// stack frame on entry to the function and which must be maintained by every
414 /// function for this subtarget.
415 unsigned getStackAlignment() const { return stackAlignment; }
417 /// Returns the maximum memset / memcpy size
418 /// that still makes it profitable to inline the call.
419 unsigned getMaxInlineSizeThreshold() const { return MaxInlineSizeThreshold; }
421 /// ParseSubtargetFeatures - Parses features string setting specified
422 /// subtarget options. Definition of function is auto generated by tblgen.
423 void ParseSubtargetFeatures(StringRef CPU, StringRef FS);
425 /// Methods used by Global ISel
426 const CallLowering *getCallLowering() const override;
427 const InstructionSelector *getInstructionSelector() const override;
428 const LegalizerInfo *getLegalizerInfo() const override;
429 const RegisterBankInfo *getRegBankInfo() const override;
432 /// Initialize the full set of dependencies so we can use an initializer
433 /// list for X86Subtarget.
434 X86Subtarget &initializeSubtargetDependencies(StringRef CPU, StringRef FS);
435 void initializeEnvironment();
436 void initSubtargetFeatures(StringRef CPU, StringRef FS);
439 /// Is this x86_64? (disregarding specific ABI / programming model)
440 bool is64Bit() const {
444 bool is32Bit() const {
448 bool is16Bit() const {
452 /// Is this x86_64 with the ILP32 programming model (x32 ABI)?
453 bool isTarget64BitILP32() const {
454 return In64BitMode && (TargetTriple.getEnvironment() == Triple::GNUX32 ||
455 TargetTriple.isOSNaCl());
458 /// Is this x86_64 with the LP64 programming model (standard AMD64, no x32)?
459 bool isTarget64BitLP64() const {
460 return In64BitMode && (TargetTriple.getEnvironment() != Triple::GNUX32 &&
461 !TargetTriple.isOSNaCl());
464 PICStyles::Style getPICStyle() const { return PICStyle; }
465 void setPICStyle(PICStyles::Style Style) { PICStyle = Style; }
467 bool hasX87() const { return HasX87; }
468 bool hasCMov() const { return HasCMov; }
469 bool hasSSE1() const { return X86SSELevel >= SSE1; }
470 bool hasSSE2() const { return X86SSELevel >= SSE2; }
471 bool hasSSE3() const { return X86SSELevel >= SSE3; }
472 bool hasSSSE3() const { return X86SSELevel >= SSSE3; }
473 bool hasSSE41() const { return X86SSELevel >= SSE41; }
474 bool hasSSE42() const { return X86SSELevel >= SSE42; }
475 bool hasAVX() const { return X86SSELevel >= AVX; }
476 bool hasAVX2() const { return X86SSELevel >= AVX2; }
477 bool hasAVX512() const { return X86SSELevel >= AVX512F; }
478 bool hasFp256() const { return hasAVX(); }
479 bool hasInt256() const { return hasAVX2(); }
480 bool hasSSE4A() const { return HasSSE4A; }
481 bool hasMMX() const { return X863DNowLevel >= MMX; }
482 bool has3DNow() const { return X863DNowLevel >= ThreeDNow; }
483 bool has3DNowA() const { return X863DNowLevel >= ThreeDNowA; }
484 bool hasPOPCNT() const { return HasPOPCNT; }
485 bool hasAES() const { return HasAES; }
486 bool hasVAES() const { return HasVAES; }
487 bool hasFXSR() const { return HasFXSR; }
488 bool hasXSAVE() const { return HasXSAVE; }
489 bool hasXSAVEOPT() const { return HasXSAVEOPT; }
490 bool hasXSAVEC() const { return HasXSAVEC; }
491 bool hasXSAVES() const { return HasXSAVES; }
492 bool hasPCLMUL() const { return HasPCLMUL; }
493 bool hasVPCLMULQDQ() const { return HasVPCLMULQDQ; }
494 bool hasGFNI() const { return HasGFNI; }
495 // Prefer FMA4 to FMA - its better for commutation/memory folding and
496 // has equal or better performance on all supported targets.
497 bool hasFMA() const { return HasFMA; }
498 bool hasFMA4() const { return HasFMA4; }
499 bool hasAnyFMA() const { return hasFMA() || hasFMA4(); }
500 bool hasXOP() const { return HasXOP; }
501 bool hasTBM() const { return HasTBM; }
502 bool hasLWP() const { return HasLWP; }
503 bool hasMOVBE() const { return HasMOVBE; }
504 bool hasRDRAND() const { return HasRDRAND; }
505 bool hasF16C() const { return HasF16C; }
506 bool hasFSGSBase() const { return HasFSGSBase; }
507 bool hasLZCNT() const { return HasLZCNT; }
508 bool hasBMI() const { return HasBMI; }
509 bool hasBMI2() const { return HasBMI2; }
510 bool hasVBMI() const { return HasVBMI; }
511 bool hasVBMI2() const { return HasVBMI2; }
512 bool hasIFMA() const { return HasIFMA; }
513 bool hasRTM() const { return HasRTM; }
514 bool hasADX() const { return HasADX; }
515 bool hasSHA() const { return HasSHA; }
516 bool hasPRFCHW() const { return HasPRFCHW; }
517 bool hasRDSEED() const { return HasRDSEED; }
518 bool hasLAHFSAHF() const { return HasLAHFSAHF; }
519 bool hasMWAITX() const { return HasMWAITX; }
520 bool hasCLZERO() const { return HasCLZERO; }
521 bool isSHLDSlow() const { return IsSHLDSlow; }
522 bool isPMULLDSlow() const { return IsPMULLDSlow; }
523 bool isUnalignedMem16Slow() const { return IsUAMem16Slow; }
524 bool isUnalignedMem32Slow() const { return IsUAMem32Slow; }
525 int getGatherOverhead() const { return GatherOverhead; }
526 int getScatterOverhead() const { return ScatterOverhead; }
527 bool hasSSEUnalignedMem() const { return HasSSEUnalignedMem; }
528 bool hasCmpxchg16b() const { return HasCmpxchg16b; }
529 bool useLeaForSP() const { return UseLeaForSP; }
530 bool hasFastPartialYMMorZMMWrite() const {
531 return HasFastPartialYMMorZMMWrite;
533 bool hasFastGather() const { return HasFastGather; }
534 bool hasFastScalarFSQRT() const { return HasFastScalarFSQRT; }
535 bool hasFastVectorFSQRT() const { return HasFastVectorFSQRT; }
536 bool hasFastLZCNT() const { return HasFastLZCNT; }
537 bool hasFastSHLDRotate() const { return HasFastSHLDRotate; }
538 bool hasMacroFusion() const { return HasMacroFusion; }
539 bool hasERMSB() const { return HasERMSB; }
540 bool hasSlowDivide32() const { return HasSlowDivide32; }
541 bool hasSlowDivide64() const { return HasSlowDivide64; }
542 bool padShortFunctions() const { return PadShortFunctions; }
543 bool slowTwoMemOps() const { return SlowTwoMemOps; }
544 bool LEAusesAG() const { return LEAUsesAG; }
545 bool slowLEA() const { return SlowLEA; }
546 bool slow3OpsLEA() const { return Slow3OpsLEA; }
547 bool slowIncDec() const { return SlowIncDec; }
548 bool hasCDI() const { return HasCDI; }
549 bool hasVPOPCNTDQ() const { return HasVPOPCNTDQ; }
550 bool hasPFI() const { return HasPFI; }
551 bool hasERI() const { return HasERI; }
552 bool hasDQI() const { return HasDQI; }
553 bool hasBWI() const { return HasBWI; }
554 bool hasVLX() const { return HasVLX; }
555 bool hasPKU() const { return HasPKU; }
556 bool hasVNNI() const { return HasVNNI; }
557 bool hasBITALG() const { return HasBITALG; }
558 bool hasMPX() const { return HasMPX; }
559 bool hasSHSTK() const { return HasSHSTK; }
560 bool hasIBT() const { return HasIBT; }
561 bool hasCLFLUSHOPT() const { return HasCLFLUSHOPT; }
562 bool hasCLWB() const { return HasCLWB; }
564 bool isXRaySupported() const override { return is64Bit(); }
566 X86ProcFamilyEnum getProcFamily() const { return X86ProcFamily; }
568 /// TODO: to be removed later and replaced with suitable properties
569 bool isAtom() const { return X86ProcFamily == IntelAtom; }
570 bool isSLM() const { return X86ProcFamily == IntelSLM; }
571 bool useSoftFloat() const { return UseSoftFloat; }
573 /// Use mfence if we have SSE2 or we're on x86-64 (even if we asked for
574 /// no-sse2). There isn't any reason to disable it if the target processor
576 bool hasMFence() const { return hasSSE2() || is64Bit(); }
578 const Triple &getTargetTriple() const { return TargetTriple; }
580 bool isTargetDarwin() const { return TargetTriple.isOSDarwin(); }
581 bool isTargetFreeBSD() const { return TargetTriple.isOSFreeBSD(); }
582 bool isTargetDragonFly() const { return TargetTriple.isOSDragonFly(); }
583 bool isTargetSolaris() const { return TargetTriple.isOSSolaris(); }
584 bool isTargetPS4() const { return TargetTriple.isPS4CPU(); }
586 bool isTargetELF() const { return TargetTriple.isOSBinFormatELF(); }
587 bool isTargetCOFF() const { return TargetTriple.isOSBinFormatCOFF(); }
588 bool isTargetMachO() const { return TargetTriple.isOSBinFormatMachO(); }
590 bool isTargetLinux() const { return TargetTriple.isOSLinux(); }
591 bool isTargetKFreeBSD() const { return TargetTriple.isOSKFreeBSD(); }
592 bool isTargetGlibc() const { return TargetTriple.isOSGlibc(); }
593 bool isTargetAndroid() const { return TargetTriple.isAndroid(); }
594 bool isTargetNaCl() const { return TargetTriple.isOSNaCl(); }
595 bool isTargetNaCl32() const { return isTargetNaCl() && !is64Bit(); }
596 bool isTargetNaCl64() const { return isTargetNaCl() && is64Bit(); }
597 bool isTargetMCU() const { return TargetTriple.isOSIAMCU(); }
598 bool isTargetFuchsia() const { return TargetTriple.isOSFuchsia(); }
600 bool isTargetWindowsMSVC() const {
601 return TargetTriple.isWindowsMSVCEnvironment();
604 bool isTargetKnownWindowsMSVC() const {
605 return TargetTriple.isKnownWindowsMSVCEnvironment();
608 bool isTargetWindowsCoreCLR() const {
609 return TargetTriple.isWindowsCoreCLREnvironment();
612 bool isTargetWindowsCygwin() const {
613 return TargetTriple.isWindowsCygwinEnvironment();
616 bool isTargetWindowsGNU() const {
617 return TargetTriple.isWindowsGNUEnvironment();
620 bool isTargetWindowsItanium() const {
621 return TargetTriple.isWindowsItaniumEnvironment();
624 bool isTargetCygMing() const { return TargetTriple.isOSCygMing(); }
626 bool isOSWindows() const { return TargetTriple.isOSWindows(); }
628 bool isTargetWin64() const { return In64BitMode && isOSWindows(); }
630 bool isTargetWin32() const { return !In64BitMode && isOSWindows(); }
632 bool isPICStyleGOT() const { return PICStyle == PICStyles::GOT; }
633 bool isPICStyleRIPRel() const { return PICStyle == PICStyles::RIPRel; }
635 bool isPICStyleStubPIC() const {
636 return PICStyle == PICStyles::StubPIC;
639 bool isPositionIndependent() const { return TM.isPositionIndependent(); }
641 bool isCallingConvWin64(CallingConv::ID CC) const {
643 // On Win64, all these conventions just use the default convention.
645 case CallingConv::Fast:
646 case CallingConv::Swift:
647 case CallingConv::X86_FastCall:
648 case CallingConv::X86_StdCall:
649 case CallingConv::X86_ThisCall:
650 case CallingConv::X86_VectorCall:
651 case CallingConv::Intel_OCL_BI:
652 return isTargetWin64();
653 // This convention allows using the Win64 convention on other targets.
654 case CallingConv::Win64:
656 // This convention allows using the SysV convention on Windows targets.
657 case CallingConv::X86_64_SysV:
659 // Otherwise, who knows what this is.
665 /// Classify a global variable reference for the current subtarget according
666 /// to how we should reference it in a non-pcrel context.
667 unsigned char classifyLocalReference(const GlobalValue *GV) const;
669 unsigned char classifyGlobalReference(const GlobalValue *GV,
670 const Module &M) const;
671 unsigned char classifyGlobalReference(const GlobalValue *GV) const;
673 /// Classify a global function reference for the current subtarget.
674 unsigned char classifyGlobalFunctionReference(const GlobalValue *GV,
675 const Module &M) const;
676 unsigned char classifyGlobalFunctionReference(const GlobalValue *GV) const;
678 /// Classify a blockaddress reference for the current subtarget according to
679 /// how we should reference it in a non-pcrel context.
680 unsigned char classifyBlockAddressReference() const;
682 /// Return true if the subtarget allows calls to immediate address.
683 bool isLegalToCallImmediateAddr() const;
685 /// This function returns the name of a function which has an interface
686 /// like the non-standard bzero function, if such a function exists on
687 /// the current subtarget and it is considered prefereable over
688 /// memset with zero passed as the second argument. Otherwise it
690 const char *getBZeroEntry() const;
692 /// This function returns true if the target has sincos() routine in its
693 /// compiler runtime or math libraries.
694 bool hasSinCos() const;
696 /// Enable the MachineScheduler pass for all X86 subtargets.
697 bool enableMachineScheduler() const override { return true; }
699 // TODO: Update the regression tests and return true.
700 bool supportPrintSchedInfo() const override { return false; }
702 bool enableEarlyIfConversion() const override;
704 /// Return the instruction itineraries based on the subtarget selection.
705 const InstrItineraryData *getInstrItineraryData() const override {
709 AntiDepBreakMode getAntiDepBreakMode() const override {
710 return TargetSubtargetInfo::ANTIDEP_CRITICAL;
713 bool enableAdvancedRASplitCost() const override { return true; }
716 } // end namespace llvm
718 #endif // LLVM_LIB_TARGET_X86_X86SUBTARGET_H