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