xref: /llvm-project/clang/lib/Frontend/InitPreprocessor.cpp (revision b80bbca25400905e614b7cf8f8cf0525f184d362)
1 //===--- InitPreprocessor.cpp - PP initialization code. ---------*- 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 implements the clang::InitializePreprocessor function.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Basic/FileManager.h"
15 #include "clang/Basic/MacroBuilder.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "clang/Basic/Version.h"
19 #include "clang/Frontend/FrontendDiagnostic.h"
20 #include "clang/Frontend/FrontendOptions.h"
21 #include "clang/Frontend/Utils.h"
22 #include "clang/Lex/HeaderSearch.h"
23 #include "clang/Lex/PTHManager.h"
24 #include "clang/Lex/Preprocessor.h"
25 #include "clang/Lex/PreprocessorOptions.h"
26 #include "clang/Serialization/ASTReader.h"
27 #include "llvm/ADT/APFloat.h"
28 using namespace clang;
29 
30 static bool MacroBodyEndsInBackslash(StringRef MacroBody) {
31   while (!MacroBody.empty() && isWhitespace(MacroBody.back()))
32     MacroBody = MacroBody.drop_back();
33   return !MacroBody.empty() && MacroBody.back() == '\\';
34 }
35 
36 // Append a #define line to Buf for Macro.  Macro should be of the form XXX,
37 // in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
38 // "#define XXX Y z W".  To get a #define with no value, use "XXX=".
39 static void DefineBuiltinMacro(MacroBuilder &Builder, StringRef Macro,
40                                DiagnosticsEngine &Diags) {
41   std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
42   StringRef MacroName = MacroPair.first;
43   StringRef MacroBody = MacroPair.second;
44   if (MacroName.size() != Macro.size()) {
45     // Per GCC -D semantics, the macro ends at \n if it exists.
46     StringRef::size_type End = MacroBody.find_first_of("\n\r");
47     if (End != StringRef::npos)
48       Diags.Report(diag::warn_fe_macro_contains_embedded_newline)
49         << MacroName;
50     MacroBody = MacroBody.substr(0, End);
51     // We handle macro bodies which end in a backslash by appending an extra
52     // backslash+newline.  This makes sure we don't accidentally treat the
53     // backslash as a line continuation marker.
54     if (MacroBodyEndsInBackslash(MacroBody))
55       Builder.defineMacro(MacroName, Twine(MacroBody) + "\\\n");
56     else
57       Builder.defineMacro(MacroName, MacroBody);
58   } else {
59     // Push "macroname 1".
60     Builder.defineMacro(Macro);
61   }
62 }
63 
64 /// AddImplicitInclude - Add an implicit \#include of the specified file to the
65 /// predefines buffer.
66 /// As these includes are generated by -include arguments the header search
67 /// logic is going to search relatively to the current working directory.
68 static void AddImplicitInclude(MacroBuilder &Builder, StringRef File) {
69   Builder.append(Twine("#include \"") + File + "\"");
70 }
71 
72 static void AddImplicitIncludeMacros(MacroBuilder &Builder, StringRef File) {
73   Builder.append(Twine("#__include_macros \"") + File + "\"");
74   // Marker token to stop the __include_macros fetch loop.
75   Builder.append("##"); // ##?
76 }
77 
78 /// AddImplicitIncludePTH - Add an implicit \#include using the original file
79 /// used to generate a PTH cache.
80 static void AddImplicitIncludePTH(MacroBuilder &Builder, Preprocessor &PP,
81                                   StringRef ImplicitIncludePTH) {
82   PTHManager *P = PP.getPTHManager();
83   // Null check 'P' in the corner case where it couldn't be created.
84   const char *OriginalFile = P ? P->getOriginalSourceFile() : nullptr;
85 
86   if (!OriginalFile) {
87     PP.getDiagnostics().Report(diag::err_fe_pth_file_has_no_source_header)
88       << ImplicitIncludePTH;
89     return;
90   }
91 
92   AddImplicitInclude(Builder, OriginalFile);
93 }
94 
95 /// \brief Add an implicit \#include using the original file used to generate
96 /// a PCH file.
97 static void AddImplicitIncludePCH(MacroBuilder &Builder, Preprocessor &PP,
98                                   const PCHContainerReader &PCHContainerRdr,
99                                   StringRef ImplicitIncludePCH) {
100   std::string OriginalFile =
101       ASTReader::getOriginalSourceFile(ImplicitIncludePCH, PP.getFileManager(),
102                                        PCHContainerRdr, PP.getDiagnostics());
103   if (OriginalFile.empty())
104     return;
105 
106   AddImplicitInclude(Builder, OriginalFile);
107 }
108 
109 /// PickFP - This is used to pick a value based on the FP semantics of the
110 /// specified FP model.
111 template <typename T>
112 static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
113                 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
114                 T IEEEQuadVal) {
115   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle())
116     return IEEESingleVal;
117   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble())
118     return IEEEDoubleVal;
119   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended())
120     return X87DoubleExtendedVal;
121   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble())
122     return PPCDoubleDoubleVal;
123   assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad());
124   return IEEEQuadVal;
125 }
126 
127 static void DefineFloatMacros(MacroBuilder &Builder, StringRef Prefix,
128                               const llvm::fltSemantics *Sem, StringRef Ext) {
129   const char *DenormMin, *Epsilon, *Max, *Min;
130   DenormMin = PickFP(Sem, "1.40129846e-45", "4.9406564584124654e-324",
131                      "3.64519953188247460253e-4951",
132                      "4.94065645841246544176568792868221e-324",
133                      "6.47517511943802511092443895822764655e-4966");
134   int Digits = PickFP(Sem, 6, 15, 18, 31, 33);
135   int DecimalDigits = PickFP(Sem, 9, 17, 21, 33, 36);
136   Epsilon = PickFP(Sem, "1.19209290e-7", "2.2204460492503131e-16",
137                    "1.08420217248550443401e-19",
138                    "4.94065645841246544176568792868221e-324",
139                    "1.92592994438723585305597794258492732e-34");
140   int MantissaDigits = PickFP(Sem, 24, 53, 64, 106, 113);
141   int Min10Exp = PickFP(Sem, -37, -307, -4931, -291, -4931);
142   int Max10Exp = PickFP(Sem, 38, 308, 4932, 308, 4932);
143   int MinExp = PickFP(Sem, -125, -1021, -16381, -968, -16381);
144   int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024, 16384);
145   Min = PickFP(Sem, "1.17549435e-38", "2.2250738585072014e-308",
146                "3.36210314311209350626e-4932",
147                "2.00416836000897277799610805135016e-292",
148                "3.36210314311209350626267781732175260e-4932");
149   Max = PickFP(Sem, "3.40282347e+38", "1.7976931348623157e+308",
150                "1.18973149535723176502e+4932",
151                "1.79769313486231580793728971405301e+308",
152                "1.18973149535723176508575932662800702e+4932");
153 
154   SmallString<32> DefPrefix;
155   DefPrefix = "__";
156   DefPrefix += Prefix;
157   DefPrefix += "_";
158 
159   Builder.defineMacro(DefPrefix + "DENORM_MIN__", Twine(DenormMin)+Ext);
160   Builder.defineMacro(DefPrefix + "HAS_DENORM__");
161   Builder.defineMacro(DefPrefix + "DIG__", Twine(Digits));
162   Builder.defineMacro(DefPrefix + "DECIMAL_DIG__", Twine(DecimalDigits));
163   Builder.defineMacro(DefPrefix + "EPSILON__", Twine(Epsilon)+Ext);
164   Builder.defineMacro(DefPrefix + "HAS_INFINITY__");
165   Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__");
166   Builder.defineMacro(DefPrefix + "MANT_DIG__", Twine(MantissaDigits));
167 
168   Builder.defineMacro(DefPrefix + "MAX_10_EXP__", Twine(Max10Exp));
169   Builder.defineMacro(DefPrefix + "MAX_EXP__", Twine(MaxExp));
170   Builder.defineMacro(DefPrefix + "MAX__", Twine(Max)+Ext);
171 
172   Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+Twine(Min10Exp)+")");
173   Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+Twine(MinExp)+")");
174   Builder.defineMacro(DefPrefix + "MIN__", Twine(Min)+Ext);
175 }
176 
177 
178 /// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
179 /// named MacroName with the max value for a type with width 'TypeWidth' a
180 /// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
181 static void DefineTypeSize(const Twine &MacroName, unsigned TypeWidth,
182                            StringRef ValSuffix, bool isSigned,
183                            MacroBuilder &Builder) {
184   llvm::APInt MaxVal = isSigned ? llvm::APInt::getSignedMaxValue(TypeWidth)
185                                 : llvm::APInt::getMaxValue(TypeWidth);
186   Builder.defineMacro(MacroName, MaxVal.toString(10, isSigned) + ValSuffix);
187 }
188 
189 /// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
190 /// the width, suffix, and signedness of the given type
191 static void DefineTypeSize(const Twine &MacroName, TargetInfo::IntType Ty,
192                            const TargetInfo &TI, MacroBuilder &Builder) {
193   DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
194                  TI.isTypeSigned(Ty), Builder);
195 }
196 
197 static void DefineFmt(const Twine &Prefix, TargetInfo::IntType Ty,
198                       const TargetInfo &TI, MacroBuilder &Builder) {
199   bool IsSigned = TI.isTypeSigned(Ty);
200   StringRef FmtModifier = TI.getTypeFormatModifier(Ty);
201   for (const char *Fmt = IsSigned ? "di" : "ouxX"; *Fmt; ++Fmt) {
202     Builder.defineMacro(Prefix + "_FMT" + Twine(*Fmt) + "__",
203                         Twine("\"") + FmtModifier + Twine(*Fmt) + "\"");
204   }
205 }
206 
207 static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty,
208                        MacroBuilder &Builder) {
209   Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
210 }
211 
212 static void DefineTypeWidth(StringRef MacroName, TargetInfo::IntType Ty,
213                             const TargetInfo &TI, MacroBuilder &Builder) {
214   Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty)));
215 }
216 
217 static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth,
218                              const TargetInfo &TI, MacroBuilder &Builder) {
219   Builder.defineMacro(MacroName,
220                       Twine(BitWidth / TI.getCharWidth()));
221 }
222 
223 static void DefineExactWidthIntType(TargetInfo::IntType Ty,
224                                     const TargetInfo &TI,
225                                     MacroBuilder &Builder) {
226   int TypeWidth = TI.getTypeWidth(Ty);
227   bool IsSigned = TI.isTypeSigned(Ty);
228 
229   // Use the target specified int64 type, when appropriate, so that [u]int64_t
230   // ends up being defined in terms of the correct type.
231   if (TypeWidth == 64)
232     Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
233 
234   const char *Prefix = IsSigned ? "__INT" : "__UINT";
235 
236   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
237   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
238 
239   StringRef ConstSuffix(TI.getTypeConstantSuffix(Ty));
240   Builder.defineMacro(Prefix + Twine(TypeWidth) + "_C_SUFFIX__", ConstSuffix);
241 }
242 
243 static void DefineExactWidthIntTypeSize(TargetInfo::IntType Ty,
244                                         const TargetInfo &TI,
245                                         MacroBuilder &Builder) {
246   int TypeWidth = TI.getTypeWidth(Ty);
247   bool IsSigned = TI.isTypeSigned(Ty);
248 
249   // Use the target specified int64 type, when appropriate, so that [u]int64_t
250   // ends up being defined in terms of the correct type.
251   if (TypeWidth == 64)
252     Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
253 
254   const char *Prefix = IsSigned ? "__INT" : "__UINT";
255   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
256 }
257 
258 static void DefineLeastWidthIntType(unsigned TypeWidth, bool IsSigned,
259                                     const TargetInfo &TI,
260                                     MacroBuilder &Builder) {
261   TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
262   if (Ty == TargetInfo::NoInt)
263     return;
264 
265   const char *Prefix = IsSigned ? "__INT_LEAST" : "__UINT_LEAST";
266   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
267   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
268   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
269 }
270 
271 static void DefineFastIntType(unsigned TypeWidth, bool IsSigned,
272                               const TargetInfo &TI, MacroBuilder &Builder) {
273   // stdint.h currently defines the fast int types as equivalent to the least
274   // types.
275   TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
276   if (Ty == TargetInfo::NoInt)
277     return;
278 
279   const char *Prefix = IsSigned ? "__INT_FAST" : "__UINT_FAST";
280   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
281   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
282 
283   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
284 }
285 
286 
287 /// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with
288 /// the specified properties.
289 static const char *getLockFreeValue(unsigned TypeWidth, unsigned InlineWidth) {
290   // Fully-aligned, power-of-2 sizes no larger than the inline
291   // width will be inlined as lock-free operations.
292   // Note: we do not need to check alignment since _Atomic(T) is always
293   // appropriately-aligned in clang.
294   if ((TypeWidth & (TypeWidth - 1)) == 0 && TypeWidth <= InlineWidth)
295     return "2"; // "always lock free"
296   // We cannot be certain what operations the lib calls might be
297   // able to implement as lock-free on future processors.
298   return "1"; // "sometimes lock free"
299 }
300 
301 /// \brief Add definitions required for a smooth interaction between
302 /// Objective-C++ automated reference counting and libstdc++ (4.2).
303 static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts,
304                                          MacroBuilder &Builder) {
305   Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR");
306 
307   std::string Result;
308   {
309     // Provide specializations for the __is_scalar type trait so that
310     // lifetime-qualified objects are not considered "scalar" types, which
311     // libstdc++ uses as an indicator of the presence of trivial copy, assign,
312     // default-construct, and destruct semantics (none of which hold for
313     // lifetime-qualified objects in ARC).
314     llvm::raw_string_ostream Out(Result);
315 
316     Out << "namespace std {\n"
317         << "\n"
318         << "struct __true_type;\n"
319         << "struct __false_type;\n"
320         << "\n";
321 
322     Out << "template<typename _Tp> struct __is_scalar;\n"
323         << "\n";
324 
325     if (LangOpts.ObjCAutoRefCount) {
326       Out << "template<typename _Tp>\n"
327           << "struct __is_scalar<__attribute__((objc_ownership(strong))) _Tp> {\n"
328           << "  enum { __value = 0 };\n"
329           << "  typedef __false_type __type;\n"
330           << "};\n"
331           << "\n";
332     }
333 
334     if (LangOpts.ObjCWeak) {
335       Out << "template<typename _Tp>\n"
336           << "struct __is_scalar<__attribute__((objc_ownership(weak))) _Tp> {\n"
337           << "  enum { __value = 0 };\n"
338           << "  typedef __false_type __type;\n"
339           << "};\n"
340           << "\n";
341     }
342 
343     if (LangOpts.ObjCAutoRefCount) {
344       Out << "template<typename _Tp>\n"
345           << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))"
346           << " _Tp> {\n"
347           << "  enum { __value = 0 };\n"
348           << "  typedef __false_type __type;\n"
349           << "};\n"
350           << "\n";
351     }
352 
353     Out << "}\n";
354   }
355   Builder.append(Result);
356 }
357 
358 static void InitializeStandardPredefinedMacros(const TargetInfo &TI,
359                                                const LangOptions &LangOpts,
360                                                const FrontendOptions &FEOpts,
361                                                MacroBuilder &Builder) {
362   if (!LangOpts.MSVCCompat && !LangOpts.TraditionalCPP)
363     Builder.defineMacro("__STDC__");
364   if (LangOpts.Freestanding)
365     Builder.defineMacro("__STDC_HOSTED__", "0");
366   else
367     Builder.defineMacro("__STDC_HOSTED__");
368 
369   if (!LangOpts.CPlusPlus) {
370     if (LangOpts.C11)
371       Builder.defineMacro("__STDC_VERSION__", "201112L");
372     else if (LangOpts.C99)
373       Builder.defineMacro("__STDC_VERSION__", "199901L");
374     else if (!LangOpts.GNUMode && LangOpts.Digraphs)
375       Builder.defineMacro("__STDC_VERSION__", "199409L");
376   } else {
377     // FIXME: Use correct value for C++17.
378     if (LangOpts.CPlusPlus1z)
379       Builder.defineMacro("__cplusplus", "201406L");
380     // C++1y [cpp.predefined]p1:
381     //   The name __cplusplus is defined to the value 201402L when compiling a
382     //   C++ translation unit.
383     else if (LangOpts.CPlusPlus14)
384       Builder.defineMacro("__cplusplus", "201402L");
385     // C++11 [cpp.predefined]p1:
386     //   The name __cplusplus is defined to the value 201103L when compiling a
387     //   C++ translation unit.
388     else if (LangOpts.CPlusPlus11)
389       Builder.defineMacro("__cplusplus", "201103L");
390     // C++03 [cpp.predefined]p1:
391     //   The name __cplusplus is defined to the value 199711L when compiling a
392     //   C++ translation unit.
393     else
394       Builder.defineMacro("__cplusplus", "199711L");
395 
396     // C++1z [cpp.predefined]p1:
397     //   An integer literal of type std::size_t whose value is the alignment
398     //   guaranteed by a call to operator new(std::size_t)
399     //
400     // We provide this in all language modes, since it seems generally useful.
401     Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__",
402                         Twine(TI.getNewAlign() / TI.getCharWidth()) +
403                             TI.getTypeConstantSuffix(TI.getSizeType()));
404   }
405 
406   // In C11 these are environment macros. In C++11 they are only defined
407   // as part of <cuchar>. To prevent breakage when mixing C and C++
408   // code, define these macros unconditionally. We can define them
409   // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
410   // and 32-bit character literals.
411   Builder.defineMacro("__STDC_UTF_16__", "1");
412   Builder.defineMacro("__STDC_UTF_32__", "1");
413 
414   if (LangOpts.ObjC1)
415     Builder.defineMacro("__OBJC__");
416 
417   // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros.
418   if (LangOpts.OpenCL) {
419     // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the
420     // language standard with which the program is compiled. __OPENCL_VERSION__
421     // is for the OpenCL version supported by the OpenCL device, which is not
422     // necessarily the language standard with which the program is compiled.
423     // A shared OpenCL header file requires a macro to indicate the language
424     // standard. As a workaround, __OPENCL_C_VERSION__ is defined for
425     // OpenCL v1.0 and v1.1.
426     switch (LangOpts.OpenCLVersion) {
427     case 100:
428       Builder.defineMacro("__OPENCL_C_VERSION__", "100");
429       break;
430     case 110:
431       Builder.defineMacro("__OPENCL_C_VERSION__", "110");
432       break;
433     case 120:
434       Builder.defineMacro("__OPENCL_C_VERSION__", "120");
435       break;
436     case 200:
437       Builder.defineMacro("__OPENCL_C_VERSION__", "200");
438       break;
439     default:
440       llvm_unreachable("Unsupported OpenCL version");
441     }
442     Builder.defineMacro("CL_VERSION_1_0", "100");
443     Builder.defineMacro("CL_VERSION_1_1", "110");
444     Builder.defineMacro("CL_VERSION_1_2", "120");
445     Builder.defineMacro("CL_VERSION_2_0", "200");
446 
447     if (TI.isLittleEndian())
448       Builder.defineMacro("__ENDIAN_LITTLE__");
449 
450     if (LangOpts.FastRelaxedMath)
451       Builder.defineMacro("__FAST_RELAXED_MATH__");
452   }
453   // Not "standard" per se, but available even with the -undef flag.
454   if (LangOpts.AsmPreprocessor)
455     Builder.defineMacro("__ASSEMBLER__");
456   if (LangOpts.CUDA)
457     Builder.defineMacro("__CUDA__");
458 }
459 
460 /// Initialize the predefined C++ language feature test macros defined in
461 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
462 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
463                                                  MacroBuilder &Builder) {
464   // C++98 features.
465   if (LangOpts.RTTI)
466     Builder.defineMacro("__cpp_rtti", "199711");
467   if (LangOpts.CXXExceptions)
468     Builder.defineMacro("__cpp_exceptions", "199711");
469 
470   // C++11 features.
471   if (LangOpts.CPlusPlus11) {
472     Builder.defineMacro("__cpp_unicode_characters", "200704");
473     Builder.defineMacro("__cpp_raw_strings", "200710");
474     Builder.defineMacro("__cpp_unicode_literals", "200710");
475     Builder.defineMacro("__cpp_user_defined_literals", "200809");
476     Builder.defineMacro("__cpp_lambdas", "200907");
477     Builder.defineMacro("__cpp_constexpr",
478                         LangOpts.CPlusPlus1z ? "201603" :
479                         LangOpts.CPlusPlus14 ? "201304" : "200704");
480     Builder.defineMacro("__cpp_range_based_for",
481                         LangOpts.CPlusPlus1z ? "201603" : "200907");
482     Builder.defineMacro("__cpp_static_assert",
483                         LangOpts.CPlusPlus1z ? "201411" : "200410");
484     Builder.defineMacro("__cpp_decltype", "200707");
485     Builder.defineMacro("__cpp_attributes", "200809");
486     Builder.defineMacro("__cpp_rvalue_references", "200610");
487     Builder.defineMacro("__cpp_variadic_templates", "200704");
488     Builder.defineMacro("__cpp_initializer_lists", "200806");
489     Builder.defineMacro("__cpp_delegating_constructors", "200604");
490     Builder.defineMacro("__cpp_nsdmi", "200809");
491     Builder.defineMacro("__cpp_inheriting_constructors", "201511");
492     Builder.defineMacro("__cpp_ref_qualifiers", "200710");
493     Builder.defineMacro("__cpp_alias_templates", "200704");
494   }
495 
496   // C++14 features.
497   if (LangOpts.CPlusPlus14) {
498     Builder.defineMacro("__cpp_binary_literals", "201304");
499     Builder.defineMacro("__cpp_digit_separators", "201309");
500     Builder.defineMacro("__cpp_init_captures", "201304");
501     Builder.defineMacro("__cpp_generic_lambdas", "201304");
502     Builder.defineMacro("__cpp_decltype_auto", "201304");
503     Builder.defineMacro("__cpp_return_type_deduction", "201304");
504     Builder.defineMacro("__cpp_aggregate_nsdmi", "201304");
505     Builder.defineMacro("__cpp_variable_templates", "201304");
506   }
507   if (LangOpts.SizedDeallocation)
508     Builder.defineMacro("__cpp_sized_deallocation", "201309");
509 
510   // C++17 features.
511   if (LangOpts.CPlusPlus1z) {
512     Builder.defineMacro("__cpp_hex_float", "201603");
513     Builder.defineMacro("__cpp_inline_variables", "201606");
514     Builder.defineMacro("__cpp_noexcept_function_type", "201510");
515     Builder.defineMacro("__cpp_capture_star_this", "201603");
516     Builder.defineMacro("__cpp_if_constexpr", "201606");
517     Builder.defineMacro("__cpp_template_auto", "201606");
518     Builder.defineMacro("__cpp_namespace_attributes", "201411");
519     Builder.defineMacro("__cpp_enumerator_attributes", "201411");
520     Builder.defineMacro("__cpp_nested_namespace_definitions", "201411");
521     Builder.defineMacro("__cpp_variadic_using", "201611");
522     Builder.defineMacro("__cpp_aggregate_bases", "201603");
523     Builder.defineMacro("__cpp_structured_bindings", "201606");
524     Builder.defineMacro("__cpp_nontype_template_args", "201411");
525     Builder.defineMacro("__cpp_fold_expressions", "201603");
526     // FIXME: This is not yet listed in SD-6.
527     Builder.defineMacro("__cpp_deduction_guides", "201611");
528   }
529   if (LangOpts.AlignedAllocation)
530     Builder.defineMacro("__cpp_aligned_new", "201606");
531 
532   // TS features.
533   if (LangOpts.ConceptsTS)
534     Builder.defineMacro("__cpp_experimental_concepts", "1");
535   if (LangOpts.CoroutinesTS)
536     Builder.defineMacro("__cpp_coroutines", "1");
537 }
538 
539 static void InitializePredefinedMacros(const TargetInfo &TI,
540                                        const LangOptions &LangOpts,
541                                        const FrontendOptions &FEOpts,
542                                        MacroBuilder &Builder) {
543   // Compiler version introspection macros.
544   Builder.defineMacro("__llvm__");  // LLVM Backend
545   Builder.defineMacro("__clang__"); // Clang Frontend
546 #define TOSTR2(X) #X
547 #define TOSTR(X) TOSTR2(X)
548   Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
549   Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
550   Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
551 #undef TOSTR
552 #undef TOSTR2
553   Builder.defineMacro("__clang_version__",
554                       "\"" CLANG_VERSION_STRING " "
555                       + getClangFullRepositoryVersion() + "\"");
556   if (!LangOpts.MSVCCompat) {
557     // Currently claim to be compatible with GCC 4.2.1-5621, but only if we're
558     // not compiling for MSVC compatibility
559     Builder.defineMacro("__GNUC_MINOR__", "2");
560     Builder.defineMacro("__GNUC_PATCHLEVEL__", "1");
561     Builder.defineMacro("__GNUC__", "4");
562     Builder.defineMacro("__GXX_ABI_VERSION", "1002");
563   }
564 
565   // Define macros for the C11 / C++11 memory orderings
566   Builder.defineMacro("__ATOMIC_RELAXED", "0");
567   Builder.defineMacro("__ATOMIC_CONSUME", "1");
568   Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
569   Builder.defineMacro("__ATOMIC_RELEASE", "3");
570   Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
571   Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
572 
573   // Support for #pragma redefine_extname (Sun compatibility)
574   Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
575 
576   // As sad as it is, enough software depends on the __VERSION__ for version
577   // checks that it is necessary to report 4.2.1 (the base GCC version we claim
578   // compatibility with) first.
579   Builder.defineMacro("__VERSION__", "\"4.2.1 Compatible " +
580                       Twine(getClangFullCPPVersion()) + "\"");
581 
582   // Initialize language-specific preprocessor defines.
583 
584   // Standard conforming mode?
585   if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
586     Builder.defineMacro("__STRICT_ANSI__");
587 
588   if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus11)
589     Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
590 
591   if (LangOpts.ObjC1) {
592     if (LangOpts.ObjCRuntime.isNonFragile()) {
593       Builder.defineMacro("__OBJC2__");
594 
595       if (LangOpts.ObjCExceptions)
596         Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
597     }
598 
599     if (LangOpts.getGC() != LangOptions::NonGC)
600       Builder.defineMacro("__OBJC_GC__");
601 
602     if (LangOpts.ObjCRuntime.isNeXTFamily())
603       Builder.defineMacro("__NEXT_RUNTIME__");
604 
605     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
606       VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
607 
608       unsigned minor = 0;
609       if (tuple.getMinor().hasValue())
610         minor = tuple.getMinor().getValue();
611 
612       unsigned subminor = 0;
613       if (tuple.getSubminor().hasValue())
614         subminor = tuple.getSubminor().getValue();
615 
616       Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
617                           Twine(tuple.getMajor() * 10000 + minor * 100 +
618                                 subminor));
619     }
620 
621     Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
622     Builder.defineMacro("IBOutletCollection(ClassName)",
623                         "__attribute__((iboutletcollection(ClassName)))");
624     Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
625     Builder.defineMacro("IBInspectable", "");
626     Builder.defineMacro("IB_DESIGNABLE", "");
627   }
628 
629   // Define a macro that describes the Objective-C boolean type even for C
630   // and C++ since BOOL can be used from non Objective-C code.
631   Builder.defineMacro("__OBJC_BOOL_IS_BOOL",
632                       Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
633 
634   if (LangOpts.CPlusPlus)
635     InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
636 
637   // darwin_constant_cfstrings controls this. This is also dependent
638   // on other things like the runtime I believe.  This is set even for C code.
639   if (!LangOpts.NoConstantCFStrings)
640       Builder.defineMacro("__CONSTANT_CFSTRINGS__");
641 
642   if (LangOpts.ObjC2)
643     Builder.defineMacro("OBJC_NEW_PROPERTIES");
644 
645   if (LangOpts.PascalStrings)
646     Builder.defineMacro("__PASCAL_STRINGS__");
647 
648   if (LangOpts.Blocks) {
649     Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
650     Builder.defineMacro("__BLOCKS__");
651   }
652 
653   if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
654     Builder.defineMacro("__EXCEPTIONS");
655   if (!LangOpts.MSVCCompat && LangOpts.RTTI)
656     Builder.defineMacro("__GXX_RTTI");
657   if (LangOpts.SjLjExceptions)
658     Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
659 
660   if (LangOpts.Deprecated)
661     Builder.defineMacro("__DEPRECATED");
662 
663   if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus) {
664     Builder.defineMacro("__GNUG__", "4");
665     Builder.defineMacro("__GXX_WEAK__");
666     Builder.defineMacro("__private_extern__", "extern");
667   }
668 
669   if (LangOpts.MicrosoftExt) {
670     if (LangOpts.WChar) {
671       // wchar_t supported as a keyword.
672       Builder.defineMacro("_WCHAR_T_DEFINED");
673       Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
674     }
675   }
676 
677   if (LangOpts.Optimize)
678     Builder.defineMacro("__OPTIMIZE__");
679   if (LangOpts.OptimizeSize)
680     Builder.defineMacro("__OPTIMIZE_SIZE__");
681 
682   if (LangOpts.FastMath)
683     Builder.defineMacro("__FAST_MATH__");
684 
685   // Initialize target-specific preprocessor defines.
686 
687   // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
688   // to the macro __BYTE_ORDER (no trailing underscores)
689   // from glibc's <endian.h> header.
690   // We don't support the PDP-11 as a target, but include
691   // the define so it can still be compared against.
692   Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
693   Builder.defineMacro("__ORDER_BIG_ENDIAN__",    "4321");
694   Builder.defineMacro("__ORDER_PDP_ENDIAN__",    "3412");
695   if (TI.isBigEndian()) {
696     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
697     Builder.defineMacro("__BIG_ENDIAN__");
698   } else {
699     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
700     Builder.defineMacro("__LITTLE_ENDIAN__");
701   }
702 
703   if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
704       && TI.getIntWidth() == 32) {
705     Builder.defineMacro("_LP64");
706     Builder.defineMacro("__LP64__");
707   }
708 
709   if (TI.getPointerWidth(0) == 32 && TI.getLongWidth() == 32
710       && TI.getIntWidth() == 32) {
711     Builder.defineMacro("_ILP32");
712     Builder.defineMacro("__ILP32__");
713   }
714 
715   // Define type sizing macros based on the target properties.
716   assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
717   Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth()));
718 
719   DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
720   DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
721   DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
722   DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
723   DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
724   DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
725   DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
726   DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
727 
728   DefineTypeSize("__UINTMAX_MAX__", TI.getUIntMaxType(), TI, Builder);
729   DefineTypeSize("__PTRDIFF_MAX__", TI.getPtrDiffType(0), TI, Builder);
730   DefineTypeSize("__INTPTR_MAX__", TI.getIntPtrType(), TI, Builder);
731   DefineTypeSize("__UINTPTR_MAX__", TI.getUIntPtrType(), TI, Builder);
732 
733   DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
734   DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
735   DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
736   DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
737   DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
738   DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
739   DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
740   DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
741   DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
742                    TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
743   DefineTypeSizeof("__SIZEOF_SIZE_T__",
744                    TI.getTypeWidth(TI.getSizeType()), TI, Builder);
745   DefineTypeSizeof("__SIZEOF_WCHAR_T__",
746                    TI.getTypeWidth(TI.getWCharType()), TI, Builder);
747   DefineTypeSizeof("__SIZEOF_WINT_T__",
748                    TI.getTypeWidth(TI.getWIntType()), TI, Builder);
749   if (TI.hasInt128Type())
750     DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
751 
752   DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
753   DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder);
754   Builder.defineMacro("__INTMAX_C_SUFFIX__",
755                       TI.getTypeConstantSuffix(TI.getIntMaxType()));
756   DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
757   DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
758   Builder.defineMacro("__UINTMAX_C_SUFFIX__",
759                       TI.getTypeConstantSuffix(TI.getUIntMaxType()));
760   DefineTypeWidth("__INTMAX_WIDTH__",  TI.getIntMaxType(), TI, Builder);
761   DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
762   DefineFmt("__PTRDIFF", TI.getPtrDiffType(0), TI, Builder);
763   DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
764   DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
765   DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder);
766   DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
767   DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
768   DefineFmt("__SIZE", TI.getSizeType(), TI, Builder);
769   DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
770   DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
771   DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
772   DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
773   DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
774   DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
775   DefineTypeSize("__SIG_ATOMIC_MAX__", TI.getSigAtomicType(), TI, Builder);
776   DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
777   DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
778 
779   DefineTypeWidth("__UINTMAX_WIDTH__",  TI.getUIntMaxType(), TI, Builder);
780   DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder);
781   DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
782   DefineTypeWidth("__UINTPTR_WIDTH__", TI.getUIntPtrType(), TI, Builder);
783 
784   DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
785   DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
786   DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
787 
788   // Define a __POINTER_WIDTH__ macro for stdint.h.
789   Builder.defineMacro("__POINTER_WIDTH__",
790                       Twine((int)TI.getPointerWidth(0)));
791 
792   // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
793   Builder.defineMacro("__BIGGEST_ALIGNMENT__",
794                       Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
795 
796   if (!LangOpts.CharIsSigned)
797     Builder.defineMacro("__CHAR_UNSIGNED__");
798 
799   if (!TargetInfo::isTypeSigned(TI.getWCharType()))
800     Builder.defineMacro("__WCHAR_UNSIGNED__");
801 
802   if (!TargetInfo::isTypeSigned(TI.getWIntType()))
803     Builder.defineMacro("__WINT_UNSIGNED__");
804 
805   // Define exact-width integer types for stdint.h
806   DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder);
807 
808   if (TI.getShortWidth() > TI.getCharWidth())
809     DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
810 
811   if (TI.getIntWidth() > TI.getShortWidth())
812     DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
813 
814   if (TI.getLongWidth() > TI.getIntWidth())
815     DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
816 
817   if (TI.getLongLongWidth() > TI.getLongWidth())
818     DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
819 
820   DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder);
821   DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder);
822   DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder);
823 
824   if (TI.getShortWidth() > TI.getCharWidth()) {
825     DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder);
826     DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder);
827     DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder);
828   }
829 
830   if (TI.getIntWidth() > TI.getShortWidth()) {
831     DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder);
832     DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder);
833     DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder);
834   }
835 
836   if (TI.getLongWidth() > TI.getIntWidth()) {
837     DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder);
838     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder);
839     DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder);
840   }
841 
842   if (TI.getLongLongWidth() > TI.getLongWidth()) {
843     DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder);
844     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder);
845     DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder);
846   }
847 
848   DefineLeastWidthIntType(8, true, TI, Builder);
849   DefineLeastWidthIntType(8, false, TI, Builder);
850   DefineLeastWidthIntType(16, true, TI, Builder);
851   DefineLeastWidthIntType(16, false, TI, Builder);
852   DefineLeastWidthIntType(32, true, TI, Builder);
853   DefineLeastWidthIntType(32, false, TI, Builder);
854   DefineLeastWidthIntType(64, true, TI, Builder);
855   DefineLeastWidthIntType(64, false, TI, Builder);
856 
857   DefineFastIntType(8, true, TI, Builder);
858   DefineFastIntType(8, false, TI, Builder);
859   DefineFastIntType(16, true, TI, Builder);
860   DefineFastIntType(16, false, TI, Builder);
861   DefineFastIntType(32, true, TI, Builder);
862   DefineFastIntType(32, false, TI, Builder);
863   DefineFastIntType(64, true, TI, Builder);
864   DefineFastIntType(64, false, TI, Builder);
865 
866   char UserLabelPrefix[2] = {TI.getDataLayout().getGlobalPrefix(), 0};
867   Builder.defineMacro("__USER_LABEL_PREFIX__", UserLabelPrefix);
868 
869   if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
870     Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
871   else
872     Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
873 
874   if (!LangOpts.MSVCCompat) {
875     if (LangOpts.GNUInline || LangOpts.CPlusPlus)
876       Builder.defineMacro("__GNUC_GNU_INLINE__");
877     else
878       Builder.defineMacro("__GNUC_STDC_INLINE__");
879 
880     // The value written by __atomic_test_and_set.
881     // FIXME: This is target-dependent.
882     Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
883 
884     // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
885     unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
886 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \
887     Builder.defineMacro("__GCC_ATOMIC_" #TYPE "_LOCK_FREE", \
888                         getLockFreeValue(TI.get##Type##Width(), \
889                                          InlineWidthBits));
890     DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
891     DEFINE_LOCK_FREE_MACRO(CHAR, Char);
892     DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
893     DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
894     DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
895     DEFINE_LOCK_FREE_MACRO(SHORT, Short);
896     DEFINE_LOCK_FREE_MACRO(INT, Int);
897     DEFINE_LOCK_FREE_MACRO(LONG, Long);
898     DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
899     Builder.defineMacro("__GCC_ATOMIC_POINTER_LOCK_FREE",
900                         getLockFreeValue(TI.getPointerWidth(0),
901                                          InlineWidthBits));
902 #undef DEFINE_LOCK_FREE_MACRO
903   }
904 
905   if (LangOpts.NoInlineDefine)
906     Builder.defineMacro("__NO_INLINE__");
907 
908   if (unsigned PICLevel = LangOpts.PICLevel) {
909     Builder.defineMacro("__PIC__", Twine(PICLevel));
910     Builder.defineMacro("__pic__", Twine(PICLevel));
911     if (LangOpts.PIE) {
912       Builder.defineMacro("__PIE__", Twine(PICLevel));
913       Builder.defineMacro("__pie__", Twine(PICLevel));
914     }
915   }
916 
917   // Macros to control C99 numerics and <float.h>
918   Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
919   Builder.defineMacro("__FLT_RADIX__", "2");
920   Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__");
921 
922   if (LangOpts.getStackProtector() == LangOptions::SSPOn)
923     Builder.defineMacro("__SSP__");
924   else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
925     Builder.defineMacro("__SSP_STRONG__", "2");
926   else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
927     Builder.defineMacro("__SSP_ALL__", "3");
928 
929   // Define a macro that exists only when using the static analyzer.
930   if (FEOpts.ProgramAction == frontend::RunAnalysis)
931     Builder.defineMacro("__clang_analyzer__");
932 
933   if (LangOpts.FastRelaxedMath)
934     Builder.defineMacro("__FAST_RELAXED_MATH__");
935 
936   if (FEOpts.ProgramAction == frontend::RewriteObjC ||
937       LangOpts.getGC() != LangOptions::NonGC) {
938     Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
939     Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))");
940     Builder.defineMacro("__autoreleasing", "");
941     Builder.defineMacro("__unsafe_unretained", "");
942   } else if (LangOpts.ObjC1) {
943     Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
944     Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
945     Builder.defineMacro("__autoreleasing",
946                         "__attribute__((objc_ownership(autoreleasing)))");
947     Builder.defineMacro("__unsafe_unretained",
948                         "__attribute__((objc_ownership(none)))");
949   }
950 
951   // On Darwin, there are __double_underscored variants of the type
952   // nullability qualifiers.
953   if (TI.getTriple().isOSDarwin()) {
954     Builder.defineMacro("__nonnull", "_Nonnull");
955     Builder.defineMacro("__null_unspecified", "_Null_unspecified");
956     Builder.defineMacro("__nullable", "_Nullable");
957   }
958 
959   // OpenMP definition
960   // OpenMP 2.2:
961   //   In implementations that support a preprocessor, the _OPENMP
962   //   macro name is defined to have the decimal value yyyymm where
963   //   yyyy and mm are the year and the month designations of the
964   //   version of the OpenMP API that the implementation support.
965   switch (LangOpts.OpenMP) {
966   case 0:
967     break;
968   case 40:
969     Builder.defineMacro("_OPENMP", "201307");
970     break;
971   case 45:
972     Builder.defineMacro("_OPENMP", "201511");
973     break;
974   default:
975     // Default version is OpenMP 3.1
976     Builder.defineMacro("_OPENMP", "201107");
977     break;
978   }
979 
980   // CUDA device path compilaton
981   if (LangOpts.CUDAIsDevice) {
982     // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
983     // backend's target defines.
984     Builder.defineMacro("__CUDA_ARCH__");
985   }
986 
987   // We need to communicate this to our CUDA header wrapper, which in turn
988   // informs the proper CUDA headers of this choice.
989   if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) {
990     Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__");
991   }
992 
993   // OpenCL definitions.
994   if (LangOpts.OpenCL) {
995 #define OPENCLEXT(Ext) \
996     if (TI.getSupportedOpenCLOpts().isSupported(#Ext, \
997         LangOpts.OpenCLVersion)) \
998       Builder.defineMacro(#Ext);
999 #include "clang/Basic/OpenCLExtensions.def"
1000   }
1001 
1002   if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1003     // For each extended integer type, g++ defines a macro mapping the
1004     // index of the type (0 in this case) in some list of extended types
1005     // to the type.
1006     Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128");
1007     Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128");
1008   }
1009 
1010   // Get other target #defines.
1011   TI.getTargetDefines(LangOpts, Builder);
1012 }
1013 
1014 /// InitializePreprocessor - Initialize the preprocessor getting it and the
1015 /// environment ready to process a single file. This returns true on error.
1016 ///
1017 void clang::InitializePreprocessor(
1018     Preprocessor &PP, const PreprocessorOptions &InitOpts,
1019     const PCHContainerReader &PCHContainerRdr,
1020     const FrontendOptions &FEOpts) {
1021   const LangOptions &LangOpts = PP.getLangOpts();
1022   std::string PredefineBuffer;
1023   PredefineBuffer.reserve(4080);
1024   llvm::raw_string_ostream Predefines(PredefineBuffer);
1025   MacroBuilder Builder(Predefines);
1026 
1027   // Emit line markers for various builtin sections of the file.  We don't do
1028   // this in asm preprocessor mode, because "# 4" is not a line marker directive
1029   // in this mode.
1030   if (!PP.getLangOpts().AsmPreprocessor)
1031     Builder.append("# 1 \"<built-in>\" 3");
1032 
1033   // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1034   if (InitOpts.UsePredefines) {
1035     if (LangOpts.CUDA && PP.getAuxTargetInfo())
1036       InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts,
1037                                  Builder);
1038 
1039     InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts, Builder);
1040 
1041     // Install definitions to make Objective-C++ ARC work well with various
1042     // C++ Standard Library implementations.
1043     if (LangOpts.ObjC1 && LangOpts.CPlusPlus &&
1044         (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1045       switch (InitOpts.ObjCXXARCStandardLibrary) {
1046       case ARCXX_nolib:
1047       case ARCXX_libcxx:
1048         break;
1049 
1050       case ARCXX_libstdcxx:
1051         AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1052         break;
1053       }
1054     }
1055   }
1056 
1057   // Even with predefines off, some macros are still predefined.
1058   // These should all be defined in the preprocessor according to the
1059   // current language configuration.
1060   InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
1061                                      FEOpts, Builder);
1062 
1063   // Add on the predefines from the driver.  Wrap in a #line directive to report
1064   // that they come from the command line.
1065   if (!PP.getLangOpts().AsmPreprocessor)
1066     Builder.append("# 1 \"<command line>\" 1");
1067 
1068   // Process #define's and #undef's in the order they are given.
1069   for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1070     if (InitOpts.Macros[i].second)  // isUndef
1071       Builder.undefineMacro(InitOpts.Macros[i].first);
1072     else
1073       DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
1074                          PP.getDiagnostics());
1075   }
1076 
1077   // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1078   if (!PP.getLangOpts().AsmPreprocessor)
1079     Builder.append("# 1 \"<built-in>\" 2");
1080 
1081   // If -imacros are specified, include them now.  These are processed before
1082   // any -include directives.
1083   for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1084     AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
1085 
1086   // Process -include-pch/-include-pth directives.
1087   if (!InitOpts.ImplicitPCHInclude.empty())
1088     AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1089                           InitOpts.ImplicitPCHInclude);
1090   if (!InitOpts.ImplicitPTHInclude.empty())
1091     AddImplicitIncludePTH(Builder, PP, InitOpts.ImplicitPTHInclude);
1092 
1093   // Process -include directives.
1094   for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1095     const std::string &Path = InitOpts.Includes[i];
1096     AddImplicitInclude(Builder, Path);
1097   }
1098 
1099   // Instruct the preprocessor to skip the preamble.
1100   PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
1101                              InitOpts.PrecompiledPreambleBytes.second);
1102 
1103   // Copy PredefinedBuffer into the Preprocessor.
1104   PP.setPredefines(Predefines.str());
1105 }
1106