1 //===--- PPC.h - Declare PPC target feature support -------------*- 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 PPC TargetInfo objects.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_BASIC_TARGETS_PPC_H
15 #define LLVM_CLANG_LIB_BASIC_TARGETS_PPC_H
16 
17 #include "OSTargets.h"
18 #include "clang/Basic/TargetInfo.h"
19 #include "clang/Basic/TargetOptions.h"
20 #include "llvm/ADT/Triple.h"
21 #include "llvm/ADT/StringSwitch.h"
22 #include "llvm/Support/Compiler.h"
23 
24 namespace clang {
25 namespace targets {
26 
27 // PPC abstract base class
28 class LLVM_LIBRARY_VISIBILITY PPCTargetInfo : public TargetInfo {
29 
30   /// Flags for architecture specific defines.
31   typedef enum {
32     ArchDefineNone = 0,
33     ArchDefineName = 1 << 0, // <name> is substituted for arch name.
34     ArchDefinePpcgr = 1 << 1,
35     ArchDefinePpcsq = 1 << 2,
36     ArchDefine440 = 1 << 3,
37     ArchDefine603 = 1 << 4,
38     ArchDefine604 = 1 << 5,
39     ArchDefinePwr4 = 1 << 6,
40     ArchDefinePwr5 = 1 << 7,
41     ArchDefinePwr5x = 1 << 8,
42     ArchDefinePwr6 = 1 << 9,
43     ArchDefinePwr6x = 1 << 10,
44     ArchDefinePwr7 = 1 << 11,
45     ArchDefinePwr8 = 1 << 12,
46     ArchDefinePwr9 = 1 << 13,
47     ArchDefineA2 = 1 << 14,
48     ArchDefineA2q = 1 << 15
49   } ArchDefineTypes;
50 
51 
52   ArchDefineTypes ArchDefs = ArchDefineNone;
53   static const Builtin::Info BuiltinInfo[];
54   static const char *const GCCRegNames[];
55   static const TargetInfo::GCCRegAlias GCCRegAliases[];
56   std::string CPU;
57 
58   // Target cpu features.
59   bool HasAltivec = false;
60   bool HasVSX = false;
61   bool HasP8Vector = false;
62   bool HasP8Crypto = false;
63   bool HasDirectMove = false;
64   bool HasQPX = false;
65   bool HasHTM = false;
66   bool HasBPERMD = false;
67   bool HasExtDiv = false;
68   bool HasP9Vector = false;
69 
70 protected:
71   std::string ABI;
72 
73 public:
PPCTargetInfo(const llvm::Triple & Triple,const TargetOptions &)74   PPCTargetInfo(const llvm::Triple &Triple, const TargetOptions &)
75       : TargetInfo(Triple) {
76     SuitableAlign = 128;
77     SimdDefaultAlign = 128;
78     LongDoubleWidth = LongDoubleAlign = 128;
79     LongDoubleFormat = &llvm::APFloat::PPCDoubleDouble();
80   }
81 
82   // Set the language option for altivec based on our value.
83   void adjust(LangOptions &Opts) override;
84 
85   // Note: GCC recognizes the following additional cpus:
86   //  401, 403, 405, 405fp, 440fp, 464, 464fp, 476, 476fp, 505, 740, 801,
87   //  821, 823, 8540, 8548, e300c2, e300c3, e500mc64, e6500, 860, cell,
88   //  titan, rs64.
89   bool isValidCPUName(StringRef Name) const override;
90   void fillValidCPUList(SmallVectorImpl<StringRef> &Values) const override;
91 
setCPU(const std::string & Name)92   bool setCPU(const std::string &Name) override {
93     bool CPUKnown = isValidCPUName(Name);
94     if (CPUKnown) {
95       CPU = Name;
96 
97       // CPU identification.
98       ArchDefs =
99           (ArchDefineTypes)llvm::StringSwitch<int>(CPU)
100               .Case("440", ArchDefineName)
101               .Case("450", ArchDefineName | ArchDefine440)
102               .Case("601", ArchDefineName)
103               .Case("602", ArchDefineName | ArchDefinePpcgr)
104               .Case("603", ArchDefineName | ArchDefinePpcgr)
105               .Case("603e", ArchDefineName | ArchDefine603 | ArchDefinePpcgr)
106               .Case("603ev", ArchDefineName | ArchDefine603 | ArchDefinePpcgr)
107               .Case("604", ArchDefineName | ArchDefinePpcgr)
108               .Case("604e", ArchDefineName | ArchDefine604 | ArchDefinePpcgr)
109               .Case("620", ArchDefineName | ArchDefinePpcgr)
110               .Case("630", ArchDefineName | ArchDefinePpcgr)
111               .Case("7400", ArchDefineName | ArchDefinePpcgr)
112               .Case("7450", ArchDefineName | ArchDefinePpcgr)
113               .Case("750", ArchDefineName | ArchDefinePpcgr)
114               .Case("970", ArchDefineName | ArchDefinePwr4 | ArchDefinePpcgr |
115                                ArchDefinePpcsq)
116               .Case("a2", ArchDefineA2)
117               .Case("a2q", ArchDefineName | ArchDefineA2 | ArchDefineA2q)
118               .Cases("power3", "pwr3", ArchDefinePpcgr)
119               .Cases("power4", "pwr4",
120                     ArchDefinePwr4 | ArchDefinePpcgr | ArchDefinePpcsq)
121               .Cases("power5", "pwr5",
122                     ArchDefinePwr5 | ArchDefinePwr4 | ArchDefinePpcgr |
123                         ArchDefinePpcsq)
124               .Cases("power5x", "pwr5x",
125                     ArchDefinePwr5x | ArchDefinePwr5 | ArchDefinePwr4 |
126                         ArchDefinePpcgr | ArchDefinePpcsq)
127               .Cases("power6", "pwr6",
128                     ArchDefinePwr6 | ArchDefinePwr5x | ArchDefinePwr5 |
129                         ArchDefinePwr4 | ArchDefinePpcgr | ArchDefinePpcsq)
130               .Cases("power6x", "pwr6x",
131                     ArchDefinePwr6x | ArchDefinePwr6 | ArchDefinePwr5x |
132                         ArchDefinePwr5 | ArchDefinePwr4 | ArchDefinePpcgr |
133                         ArchDefinePpcsq)
134               .Cases("power7", "pwr7",
135                     ArchDefinePwr7 | ArchDefinePwr6x | ArchDefinePwr6 |
136                         ArchDefinePwr5x | ArchDefinePwr5 | ArchDefinePwr4 |
137                         ArchDefinePpcgr | ArchDefinePpcsq)
138               // powerpc64le automatically defaults to at least power8.
139               .Cases("power8", "pwr8", "ppc64le",
140                     ArchDefinePwr8 | ArchDefinePwr7 | ArchDefinePwr6x |
141                         ArchDefinePwr6 | ArchDefinePwr5x | ArchDefinePwr5 |
142                         ArchDefinePwr4 | ArchDefinePpcgr | ArchDefinePpcsq)
143               .Cases("power9", "pwr9",
144                     ArchDefinePwr9 | ArchDefinePwr8 | ArchDefinePwr7 |
145                         ArchDefinePwr6x | ArchDefinePwr6 | ArchDefinePwr5x |
146                         ArchDefinePwr5 | ArchDefinePwr4 | ArchDefinePpcgr |
147                         ArchDefinePpcsq)
148               .Default(ArchDefineNone);
149     }
150     return CPUKnown;
151   }
152 
getABI()153   StringRef getABI() const override { return ABI; }
154 
155   ArrayRef<Builtin::Info> getTargetBuiltins() const override;
156 
isCLZForZeroUndef()157   bool isCLZForZeroUndef() const override { return false; }
158 
159   void getTargetDefines(const LangOptions &Opts,
160                         MacroBuilder &Builder) const override;
161 
162   bool
163   initFeatureMap(llvm::StringMap<bool> &Features, DiagnosticsEngine &Diags,
164                  StringRef CPU,
165                  const std::vector<std::string> &FeaturesVec) const override;
166 
167   bool handleTargetFeatures(std::vector<std::string> &Features,
168                             DiagnosticsEngine &Diags) override;
169 
170   bool hasFeature(StringRef Feature) const override;
171 
172   void setFeatureEnabled(llvm::StringMap<bool> &Features, StringRef Name,
173                          bool Enabled) const override;
174 
175   ArrayRef<const char *> getGCCRegNames() const override;
176 
177   ArrayRef<TargetInfo::GCCRegAlias> getGCCRegAliases() const override;
178 
179   ArrayRef<TargetInfo::AddlRegName> getGCCAddlRegNames() const override;
180 
validateAsmConstraint(const char * & Name,TargetInfo::ConstraintInfo & Info)181   bool validateAsmConstraint(const char *&Name,
182                              TargetInfo::ConstraintInfo &Info) const override {
183     switch (*Name) {
184     default:
185       return false;
186     case 'O': // Zero
187       break;
188     case 'b': // Base register
189     case 'f': // Floating point register
190       Info.setAllowsRegister();
191       break;
192     // FIXME: The following are added to allow parsing.
193     // I just took a guess at what the actions should be.
194     // Also, is more specific checking needed?  I.e. specific registers?
195     case 'd': // Floating point register (containing 64-bit value)
196     case 'v': // Altivec vector register
197       Info.setAllowsRegister();
198       break;
199     case 'w':
200       switch (Name[1]) {
201       case 'd': // VSX vector register to hold vector double data
202       case 'f': // VSX vector register to hold vector float data
203       case 's': // VSX vector register to hold scalar float data
204       case 'a': // Any VSX register
205       case 'c': // An individual CR bit
206       case 'i': // FP or VSX register to hold 64-bit integers data
207         break;
208       default:
209         return false;
210       }
211       Info.setAllowsRegister();
212       Name++; // Skip over 'w'.
213       break;
214     case 'h': // `MQ', `CTR', or `LINK' register
215     case 'q': // `MQ' register
216     case 'c': // `CTR' register
217     case 'l': // `LINK' register
218     case 'x': // `CR' register (condition register) number 0
219     case 'y': // `CR' register (condition register)
220     case 'z': // `XER[CA]' carry bit (part of the XER register)
221       Info.setAllowsRegister();
222       break;
223     case 'I': // Signed 16-bit constant
224     case 'J': // Unsigned 16-bit constant shifted left 16 bits
225               //  (use `L' instead for SImode constants)
226     case 'K': // Unsigned 16-bit constant
227     case 'L': // Signed 16-bit constant shifted left 16 bits
228     case 'M': // Constant larger than 31
229     case 'N': // Exact power of 2
230     case 'P': // Constant whose negation is a signed 16-bit constant
231     case 'G': // Floating point constant that can be loaded into a
232               // register with one instruction per word
233     case 'H': // Integer/Floating point constant that can be loaded
234               // into a register using three instructions
235       break;
236     case 'm': // Memory operand. Note that on PowerPC targets, m can
237               // include addresses that update the base register. It
238               // is therefore only safe to use `m' in an asm statement
239               // if that asm statement accesses the operand exactly once.
240               // The asm statement must also use `%U<opno>' as a
241               // placeholder for the "update" flag in the corresponding
242               // load or store instruction. For example:
243               // asm ("st%U0 %1,%0" : "=m" (mem) : "r" (val));
244               // is correct but:
245               // asm ("st %1,%0" : "=m" (mem) : "r" (val));
246               // is not. Use es rather than m if you don't want the base
247               // register to be updated.
248     case 'e':
249       if (Name[1] != 's')
250         return false;
251       // es: A "stable" memory operand; that is, one which does not
252       // include any automodification of the base register. Unlike
253       // `m', this constraint can be used in asm statements that
254       // might access the operand several times, or that might not
255       // access it at all.
256       Info.setAllowsMemory();
257       Name++; // Skip over 'e'.
258       break;
259     case 'Q': // Memory operand that is an offset from a register (it is
260               // usually better to use `m' or `es' in asm statements)
261     case 'Z': // Memory operand that is an indexed or indirect from a
262               // register (it is usually better to use `m' or `es' in
263               // asm statements)
264       Info.setAllowsMemory();
265       Info.setAllowsRegister();
266       break;
267     case 'R': // AIX TOC entry
268     case 'a': // Address operand that is an indexed or indirect from a
269               // register (`p' is preferable for asm statements)
270     case 'S': // Constant suitable as a 64-bit mask operand
271     case 'T': // Constant suitable as a 32-bit mask operand
272     case 'U': // System V Release 4 small data area reference
273     case 't': // AND masks that can be performed by two rldic{l, r}
274               // instructions
275     case 'W': // Vector constant that does not require memory
276     case 'j': // Vector constant that is all zeros.
277       break;
278       // End FIXME.
279     }
280     return true;
281   }
282 
convertConstraint(const char * & Constraint)283   std::string convertConstraint(const char *&Constraint) const override {
284     std::string R;
285     switch (*Constraint) {
286     case 'e':
287     case 'w':
288       // Two-character constraint; add "^" hint for later parsing.
289       R = std::string("^") + std::string(Constraint, 2);
290       Constraint++;
291       break;
292     default:
293       return TargetInfo::convertConstraint(Constraint);
294     }
295     return R;
296   }
297 
getClobbers()298   const char *getClobbers() const override { return ""; }
getEHDataRegisterNumber(unsigned RegNo)299   int getEHDataRegisterNumber(unsigned RegNo) const override {
300     if (RegNo == 0)
301       return 3;
302     if (RegNo == 1)
303       return 4;
304     return -1;
305   }
306 
hasSjLjLowering()307   bool hasSjLjLowering() const override { return true; }
308 
useFloat128ManglingForLongDouble()309   bool useFloat128ManglingForLongDouble() const override {
310     return LongDoubleWidth == 128 &&
311            LongDoubleFormat == &llvm::APFloat::PPCDoubleDouble() &&
312            getTriple().isOSBinFormatELF();
313   }
314 };
315 
316 class LLVM_LIBRARY_VISIBILITY PPC32TargetInfo : public PPCTargetInfo {
317 public:
PPC32TargetInfo(const llvm::Triple & Triple,const TargetOptions & Opts)318   PPC32TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts)
319       : PPCTargetInfo(Triple, Opts) {
320     resetDataLayout("E-m:e-p:32:32-i64:64-n32");
321 
322     switch (getTriple().getOS()) {
323     case llvm::Triple::Linux:
324     case llvm::Triple::FreeBSD:
325     case llvm::Triple::NetBSD:
326       SizeType = UnsignedInt;
327       PtrDiffType = SignedInt;
328       IntPtrType = SignedInt;
329       break;
330     default:
331       break;
332     }
333 
334     switch (getTriple().getOS()) {
335     case llvm::Triple::FreeBSD:
336     case llvm::Triple::NetBSD:
337     case llvm::Triple::OpenBSD:
338       LongDoubleWidth = LongDoubleAlign = 64;
339       LongDoubleFormat = &llvm::APFloat::IEEEdouble();
340       break;
341     default:
342       break;
343     }
344 
345     // PPC32 supports atomics up to 4 bytes.
346     MaxAtomicPromoteWidth = MaxAtomicInlineWidth = 32;
347   }
348 
getBuiltinVaListKind()349   BuiltinVaListKind getBuiltinVaListKind() const override {
350     // This is the ELF definition, and is overridden by the Darwin sub-target
351     return TargetInfo::PowerABIBuiltinVaList;
352   }
353 };
354 
355 // Note: ABI differences may eventually require us to have a separate
356 // TargetInfo for little endian.
357 class LLVM_LIBRARY_VISIBILITY PPC64TargetInfo : public PPCTargetInfo {
358 public:
PPC64TargetInfo(const llvm::Triple & Triple,const TargetOptions & Opts)359   PPC64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts)
360       : PPCTargetInfo(Triple, Opts) {
361     LongWidth = LongAlign = PointerWidth = PointerAlign = 64;
362     IntMaxType = SignedLong;
363     Int64Type = SignedLong;
364 
365     if ((Triple.getArch() == llvm::Triple::ppc64le)) {
366       resetDataLayout("e-m:e-i64:64-n32:64");
367       ABI = "elfv2";
368     } else {
369       resetDataLayout("E-m:e-i64:64-n32:64");
370       ABI = "elfv1";
371     }
372 
373     switch (getTriple().getOS()) {
374     case llvm::Triple::FreeBSD:
375       LongDoubleWidth = LongDoubleAlign = 64;
376       LongDoubleFormat = &llvm::APFloat::IEEEdouble();
377       break;
378     default:
379       break;
380     }
381 
382     // PPC64 supports atomics up to 8 bytes.
383     MaxAtomicPromoteWidth = MaxAtomicInlineWidth = 64;
384   }
385 
getBuiltinVaListKind()386   BuiltinVaListKind getBuiltinVaListKind() const override {
387     return TargetInfo::CharPtrBuiltinVaList;
388   }
389 
390   // PPC64 Linux-specific ABI options.
setABI(const std::string & Name)391   bool setABI(const std::string &Name) override {
392     if (Name == "elfv1" || Name == "elfv1-qpx" || Name == "elfv2") {
393       ABI = Name;
394       return true;
395     }
396     return false;
397   }
398 
checkCallingConvention(CallingConv CC)399   CallingConvCheckResult checkCallingConvention(CallingConv CC) const override {
400     switch (CC) {
401     case CC_Swift:
402       return CCCR_OK;
403     default:
404       return CCCR_Warning;
405     }
406   }
407 };
408 
409 class LLVM_LIBRARY_VISIBILITY DarwinPPC32TargetInfo
410     : public DarwinTargetInfo<PPC32TargetInfo> {
411 public:
DarwinPPC32TargetInfo(const llvm::Triple & Triple,const TargetOptions & Opts)412   DarwinPPC32TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts)
413       : DarwinTargetInfo<PPC32TargetInfo>(Triple, Opts) {
414     HasAlignMac68kSupport = true;
415     BoolWidth = BoolAlign = 32; // XXX support -mone-byte-bool?
416     PtrDiffType = SignedInt; // for http://llvm.org/bugs/show_bug.cgi?id=15726
417     LongLongAlign = 32;
418     resetDataLayout("E-m:o-p:32:32-f64:32:64-n32");
419   }
420 
getBuiltinVaListKind()421   BuiltinVaListKind getBuiltinVaListKind() const override {
422     return TargetInfo::CharPtrBuiltinVaList;
423   }
424 };
425 
426 class LLVM_LIBRARY_VISIBILITY DarwinPPC64TargetInfo
427     : public DarwinTargetInfo<PPC64TargetInfo> {
428 public:
DarwinPPC64TargetInfo(const llvm::Triple & Triple,const TargetOptions & Opts)429   DarwinPPC64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts)
430       : DarwinTargetInfo<PPC64TargetInfo>(Triple, Opts) {
431     HasAlignMac68kSupport = true;
432     resetDataLayout("E-m:o-i64:64-n32:64");
433   }
434 };
435 
436 } // namespace targets
437 } // namespace clang
438 #endif // LLVM_CLANG_LIB_BASIC_TARGETS_PPC_H
439