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/Target/TargetSubtarget.h"
  18 #include <string>
  19
  20 namespace llvm {
  21 class Module;
  22 class GlobalValue;
  23 class TargetMachine;
  24
  25 namespace PICStyles {
  26 enum Style {
  27   Stub, GOT, RIPRel, WinPIC, None
  28 };
  29 }
  30
  31 class X86Subtarget : public TargetSubtarget {
  32 public:
  33   enum AsmWriterFlavorTy {
  34     // Note: This numbering has to match the GCC assembler dialects for inline
  35     // asm alternatives to work right.
  36     ATT = 0, Intel = 1, Unset
  37   };
  38 protected:
  39   enum X86SSEEnum {
  40     NoMMXSSE, MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42
  41   };
  42
  43   enum X863DNowEnum {
  44     NoThreeDNow, ThreeDNow, ThreeDNowA
  45   };
  46
  47   /// AsmFlavor - Which x86 asm dialect to use.
  48   ///
  49   AsmWriterFlavorTy AsmFlavor;
  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   /// HasX86_64 - True if the processor supports X86-64 instructions.
  64   ///
  65   bool HasX86_64;
  66
  67   /// HasSSE4A - True if the processor supports SSE4A instructions.
  68   bool HasSSE4A;
  69
  70   /// HasAVX - Target has AVX instructions
  71   bool HasAVX;
  72
  73   /// HasFMA3 - Target has 3-operand fused multiply-add
  74   bool HasFMA3;
  75
  76   /// HasFMA4 - Target has 4-operand fused multiply-add
  77   bool HasFMA4;
  78
  79   /// IsBTMemSlow - True if BT (bit test) of memory instructions are slow.
  80   bool IsBTMemSlow;
  81
  82   /// DarwinVers - Nonzero if this is a darwin platform: the numeric
  83   /// version of the platform, e.g. 8 = 10.4 (Tiger), 9 = 10.5 (Leopard), etc.
  84   unsigned char DarwinVers; // Is any darwin-x86 platform.
  85
  86   /// isLinux - true if this is a "linux" platform.
  87   bool IsLinux;
  88
  89   /// stackAlignment - The minimum alignment known to hold of the stack frame on
  90   /// entry to the function and which must be maintained by every function.
  91   unsigned stackAlignment;
  92
  93   /// Max. memset / memcpy size that is turned into rep/movs, rep/stos ops.
  94   ///
  95   unsigned MaxInlineSizeThreshold;
  96
  97 private:
  98   /// Is64Bit - True if the processor supports 64-bit instructions and module
  99   /// pointer size is 64 bit.
 100   bool Is64Bit;
 101
 102 public:
 103   enum {
 104     isELF, isCygwin, isDarwin, isWindows, isMingw
 105   } TargetType;
 106
 107   /// This constructor initializes the data members to match that
 108   /// of the specified module.
 109   ///
 110   X86Subtarget(const Module &M, const std::string &FS, bool is64Bit);
 111
 112   /// getStackAlignment - Returns the minimum alignment known to hold of the
 113   /// stack frame on entry to the function and which must be maintained by every
 114   /// function for this subtarget.
 115   unsigned getStackAlignment() const { return stackAlignment; }
 116
 117   /// getMaxInlineSizeThreshold - Returns the maximum memset / memcpy size
 118   /// that still makes it profitable to inline the call.
 119   unsigned getMaxInlineSizeThreshold() const { return MaxInlineSizeThreshold; }
 120
 121   /// ParseSubtargetFeatures - Parses features string setting specified
 122   /// subtarget options.  Definition of function is auto generated by tblgen.
 123   std::string ParseSubtargetFeatures(const std::string &FS,
 124                                      const std::string &CPU);
 125
 126   /// AutoDetectSubtargetFeatures - Auto-detect CPU features using CPUID
 127   /// instruction.
 128   void AutoDetectSubtargetFeatures();
 129
 130   bool is64Bit() const { return Is64Bit; }
 131
 132   PICStyles::Style getPICStyle() const { return PICStyle; }
 133   void setPICStyle(PICStyles::Style Style)  { PICStyle = Style; }
 134
 135   bool hasMMX() const { return X86SSELevel >= MMX; }
 136   bool hasSSE1() const { return X86SSELevel >= SSE1; }
 137   bool hasSSE2() const { return X86SSELevel >= SSE2; }
 138   bool hasSSE3() const { return X86SSELevel >= SSE3; }
 139   bool hasSSSE3() const { return X86SSELevel >= SSSE3; }
 140   bool hasSSE41() const { return X86SSELevel >= SSE41; }
 141   bool hasSSE42() const { return X86SSELevel >= SSE42; }
 142   bool hasSSE4A() const { return HasSSE4A; }
 143   bool has3DNow() const { return X863DNowLevel >= ThreeDNow; }
 144   bool has3DNowA() const { return X863DNowLevel >= ThreeDNowA; }
 145   bool hasAVX() const { return HasAVX; }
 146   bool hasFMA3() const { return HasFMA3; }
 147   bool hasFMA4() const { return HasFMA4; }
 148
 149   bool isBTMemSlow() const { return IsBTMemSlow; }
 150
 151   unsigned getAsmFlavor() const {
 152     return AsmFlavor != Unset ? unsigned(AsmFlavor) : 0;
 153   }
 154
 155   bool isFlavorAtt() const { return AsmFlavor == ATT; }
 156   bool isFlavorIntel() const { return AsmFlavor == Intel; }
 157
 158   bool isTargetDarwin() const { return TargetType == isDarwin; }
 159   bool isTargetELF() const {
 160     return TargetType == isELF;
 161   }
 162   bool isTargetWindows() const { return TargetType == isWindows; }
 163   bool isTargetMingw() const { return TargetType == isMingw; }
 164   bool isTargetCygMing() const { return (TargetType == isMingw ||
 165                                          TargetType == isCygwin); }
 166   bool isTargetCygwin() const { return TargetType == isCygwin; }
 167   bool isTargetWin64() const {
 168     return (Is64Bit && (TargetType == isMingw || TargetType == isWindows));
 169   }
 170
 171   std::string getDataLayout() const {
 172     const char *p;
 173     if (is64Bit())
 174       p = "e-p:64:64-s:64-f64:64:64-i64:64:64-f80:128:128";
 175     else {
 176       if (isTargetDarwin())
 177         p = "e-p:32:32-f64:32:64-i64:32:64-f80:128:128";
 178       else
 179         p = "e-p:32:32-f64:32:64-i64:32:64-f80:32:32";
 180     }
 181     return std::string(p);
 182   }
 183
 184   bool isPICStyleSet() const { return PICStyle != PICStyles::None; }
 185   bool isPICStyleGOT() const { return PICStyle == PICStyles::GOT; }
 186   bool isPICStyleStub() const { return PICStyle == PICStyles::Stub; }
 187   bool isPICStyleRIPRel() const { return PICStyle == PICStyles::RIPRel; }
 188   bool isPICStyleWinPIC() const { return PICStyle == PICStyles::WinPIC; }
 189
 190   /// getDarwinVers - Return the darwin version number, 8 = tiger, 9 = leopard.
 191   unsigned getDarwinVers() const { return DarwinVers; }
 192
 193   /// isLinux - Return true if the target is "Linux".
 194   bool isLinux() const { return IsLinux; }
 195
 196   /// True if accessing the GV requires an extra load. For Windows, dllimported
 197   /// symbols are indirect, loading the value at address GV rather then the
 198   /// value of GV itself. This means that the GlobalAddress must be in the base
 199   /// or index register of the address, not the GV offset field.
 200   bool GVRequiresExtraLoad(const GlobalValue* GV, const TargetMachine& TM,
 201                            bool isDirectCall) const;
 202
 203   /// True if accessing the GV requires a register.  This is a superset of the
 204   /// cases where GVRequiresExtraLoad is true.  Some variations of PIC require
 205   /// a register, but not an extra load.
 206   bool GVRequiresRegister(const GlobalValue* GV, const TargetMachine& TM,
 207                            bool isDirectCall) const;
 208
 209   /// IsLegalToCallImmediateAddr - Return true if the subtarget allows calls
 210   /// to immediate address.
 211   bool IsLegalToCallImmediateAddr(const TargetMachine &TM) const;
 212
 213   /// This function returns the name of a function which has an interface
 214   /// like the non-standard bzero function, if such a function exists on
 215   /// the current subtarget and it is considered prefereable over
 216   /// memset with zero passed as the second argument. Otherwise it
 217   /// returns null.
 218   const char *getBZeroEntry() const;
 219
 220   /// getSpecialAddressLatency - For targets where it is beneficial to
 221   /// backschedule instructions that compute addresses, return a value
 222   /// indicating the number of scheduling cycles of backscheduling that
 223   /// should be attempted.
 224   unsigned getSpecialAddressLatency() const;
 225 };
 226
 227 namespace X86 {
 228   /// GetCpuIDAndInfo - Execute the specified cpuid and return the 4 values in
 229   /// the specified arguments.  If we can't run cpuid on the host, return true.
 230   bool GetCpuIDAndInfo(unsigned value, unsigned *rEAX, unsigned *rEBX,
 231                        unsigned *rECX, unsigned *rEDX);
 232 }
 233
 234 } // End llvm namespace
 235
 236 #endif