TargetRegistry: Change AsmPrinter constructor to be typed as returning an
[oota-llvm.git] / 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 GlobalValue;
22 class TargetMachine;
23   
24 /// PICStyles - The X86 backend supports a number of different styles of PIC.
25 /// 
26 namespace PICStyles {
27 enum Style {
28   StubPIC,          // Used on i386-darwin in -fPIC mode.
29   StubDynamicNoPIC, // Used on i386-darwin in -mdynamic-no-pic mode.
30   GOT,              // Used on many 32-bit unices in -fPIC mode.
31   RIPRel,           // Used on X86-64 when not in -static mode.
32   None              // Set when in -static mode (not PIC or DynamicNoPIC mode).
33 };
34 }
35
36 class X86Subtarget : public TargetSubtarget {
37 protected:
38   enum X86SSEEnum {
39     NoMMXSSE, MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42
40   };
41
42   enum X863DNowEnum {
43     NoThreeDNow, ThreeDNow, ThreeDNowA
44   };
45
46   /// PICStyle - Which PIC style to use
47   ///
48   PICStyles::Style PICStyle;
49   
50   /// X86SSELevel - MMX, SSE1, SSE2, SSE3, SSSE3, SSE41, SSE42, or
51   /// none supported.
52   X86SSEEnum X86SSELevel;
53
54   /// X863DNowLevel - 3DNow or 3DNow Athlon, or none supported.
55   ///
56   X863DNowEnum X863DNowLevel;
57
58   /// HasX86_64 - True if the processor supports X86-64 instructions.
59   ///
60   bool HasX86_64;
61
62   /// HasSSE4A - True if the processor supports SSE4A instructions.
63   bool HasSSE4A;
64
65   /// HasAVX - Target has AVX instructions
66   bool HasAVX;
67
68   /// HasFMA3 - Target has 3-operand fused multiply-add
69   bool HasFMA3;
70
71   /// HasFMA4 - Target has 4-operand fused multiply-add
72   bool HasFMA4;
73
74   /// IsBTMemSlow - True if BT (bit test) of memory instructions are slow.
75   bool IsBTMemSlow;
76   
77   /// DarwinVers - Nonzero if this is a darwin platform: the numeric
78   /// version of the platform, e.g. 8 = 10.4 (Tiger), 9 = 10.5 (Leopard), etc.
79   unsigned char DarwinVers; // Is any darwin-x86 platform.
80
81   /// isLinux - true if this is a "linux" platform.
82   bool IsLinux;
83
84   /// stackAlignment - The minimum alignment known to hold of the stack frame on
85   /// entry to the function and which must be maintained by every function.
86   unsigned stackAlignment;
87
88   /// Max. memset / memcpy size that is turned into rep/movs, rep/stos ops.
89   ///
90   unsigned MaxInlineSizeThreshold;
91
92 private:
93   /// Is64Bit - True if the processor supports 64-bit instructions and
94   /// pointer size is 64 bit.
95   bool Is64Bit;
96
97 public:
98   enum {
99     isELF, isCygwin, isDarwin, isWindows, isMingw
100   } TargetType;
101
102   /// This constructor initializes the data members to match that
103   /// of the specified triple.
104   ///
105   X86Subtarget(const std::string &TT, const std::string &FS, bool is64Bit);
106
107   /// getStackAlignment - Returns the minimum alignment known to hold of the
108   /// stack frame on entry to the function and which must be maintained by every
109   /// function for this subtarget.
110   unsigned getStackAlignment() const { return stackAlignment; }
111
112   /// getMaxInlineSizeThreshold - Returns the maximum memset / memcpy size
113   /// that still makes it profitable to inline the call.
114   unsigned getMaxInlineSizeThreshold() const { return MaxInlineSizeThreshold; }
115
116   /// ParseSubtargetFeatures - Parses features string setting specified
117   /// subtarget options.  Definition of function is auto generated by tblgen.
118   std::string ParseSubtargetFeatures(const std::string &FS,
119                                      const std::string &CPU);
120
121   /// AutoDetectSubtargetFeatures - Auto-detect CPU features using CPUID
122   /// instruction.
123   void AutoDetectSubtargetFeatures();
124
125   bool is64Bit() const { return Is64Bit; }
126
127   PICStyles::Style getPICStyle() const { return PICStyle; }
128   void setPICStyle(PICStyles::Style Style)  { PICStyle = Style; }
129
130   bool hasMMX() const { return X86SSELevel >= MMX; }
131   bool hasSSE1() const { return X86SSELevel >= SSE1; }
132   bool hasSSE2() const { return X86SSELevel >= SSE2; }
133   bool hasSSE3() const { return X86SSELevel >= SSE3; }
134   bool hasSSSE3() const { return X86SSELevel >= SSSE3; }
135   bool hasSSE41() const { return X86SSELevel >= SSE41; }
136   bool hasSSE42() const { return X86SSELevel >= SSE42; }
137   bool hasSSE4A() const { return HasSSE4A; }
138   bool has3DNow() const { return X863DNowLevel >= ThreeDNow; }
139   bool has3DNowA() const { return X863DNowLevel >= ThreeDNowA; }
140   bool hasAVX() const { return HasAVX; }
141   bool hasFMA3() const { return HasFMA3; }
142   bool hasFMA4() const { return HasFMA4; }
143   bool isBTMemSlow() const { return IsBTMemSlow; }
144
145   bool isTargetDarwin() const { return TargetType == isDarwin; }
146   bool isTargetELF() const { return TargetType == isELF; }
147   bool isTargetWindows() const { return TargetType == isWindows; }
148   bool isTargetMingw() const { return TargetType == isMingw; }
149   bool isTargetCygMing() const {
150     return TargetType == isMingw || TargetType == isCygwin;
151   }
152   bool isTargetCygwin() const { return TargetType == isCygwin; }
153   bool isTargetWin64() const {
154     return Is64Bit && (TargetType == isMingw || TargetType == isWindows);
155   }
156
157   std::string getDataLayout() const {
158     const char *p;
159     if (is64Bit())
160       p = "e-p:64:64-s:64-f64:64:64-i64:64:64-f80:128:128";
161     else if (isTargetDarwin())
162       p = "e-p:32:32-f64:32:64-i64:32:64-f80:128:128";
163     else
164       p = "e-p:32:32-f64:32:64-i64:32:64-f80:32:32";
165     return std::string(p);
166   }
167
168   bool isPICStyleSet() const { return PICStyle != PICStyles::None; }
169   bool isPICStyleGOT() const { return PICStyle == PICStyles::GOT; }
170   bool isPICStyleRIPRel() const { return PICStyle == PICStyles::RIPRel; }
171
172   bool isPICStyleStubPIC() const {
173     return PICStyle == PICStyles::StubPIC;
174   }
175
176   bool isPICStyleStubNoDynamic() const {
177     return PICStyle == PICStyles::StubDynamicNoPIC;
178   }
179   bool isPICStyleStubAny() const {
180     return PICStyle == PICStyles::StubDynamicNoPIC ||
181            PICStyle == PICStyles::StubPIC; }
182   
183   /// getDarwinVers - Return the darwin version number, 8 = Tiger, 9 = Leopard,
184   /// 10 = Snow Leopard, etc.
185   unsigned getDarwinVers() const { return DarwinVers; }
186   
187   /// isLinux - Return true if the target is "Linux".
188   bool isLinux() const { return IsLinux; }
189
190   
191   /// ClassifyGlobalReference - Classify a global variable reference for the
192   /// current subtarget according to how we should reference it in a non-pcrel
193   /// context.
194   unsigned char ClassifyGlobalReference(const GlobalValue *GV,
195                                         const TargetMachine &TM)const;
196
197   /// IsLegalToCallImmediateAddr - Return true if the subtarget allows calls
198   /// to immediate address.
199   bool IsLegalToCallImmediateAddr(const TargetMachine &TM) const;
200
201   /// This function returns the name of a function which has an interface
202   /// like the non-standard bzero function, if such a function exists on
203   /// the current subtarget and it is considered prefereable over
204   /// memset with zero passed as the second argument. Otherwise it
205   /// returns null.
206   const char *getBZeroEntry() const;
207
208   /// getSpecialAddressLatency - For targets where it is beneficial to
209   /// backschedule instructions that compute addresses, return a value
210   /// indicating the number of scheduling cycles of backscheduling that
211   /// should be attempted.
212   unsigned getSpecialAddressLatency() const;
213 };
214
215 namespace X86 {
216   /// GetCpuIDAndInfo - Execute the specified cpuid and return the 4 values in
217   /// the specified arguments.  If we can't run cpuid on the host, return true.
218   bool GetCpuIDAndInfo(unsigned value, unsigned *rEAX, unsigned *rEBX,
219                        unsigned *rECX, unsigned *rEDX);
220 }
221
222 } // End llvm namespace
223
224 #endif