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