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