xref: /llvm-project/clang/lib/Frontend/InitPreprocessor.cpp (revision bc633a42dd409dbeb456263e3388b8caa4680aa0)
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     // C++1z [cpp.predefined]p1:
389     //   An integer literal of type std::size_t whose value is the alignment
390     //   guaranteed by a call to operator new(std::size_t)
391     //
392     // We provide this in all language modes, since it seems generally useful.
393     Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__",
394                         Twine(TI.getNewAlign() / TI.getCharWidth()) +
395                             TI.getTypeConstantSuffix(TI.getSizeType()));
396   }
397 
398   // In C11 these are environment macros. In C++11 they are only defined
399   // as part of <cuchar>. To prevent breakage when mixing C and C++
400   // code, define these macros unconditionally. We can define them
401   // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
402   // and 32-bit character literals.
403   Builder.defineMacro("__STDC_UTF_16__", "1");
404   Builder.defineMacro("__STDC_UTF_32__", "1");
405 
406   if (LangOpts.ObjC)
407     Builder.defineMacro("__OBJC__");
408 
409   // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros.
410   if (LangOpts.OpenCL) {
411     if (LangOpts.CPlusPlus) {
412       if (LangOpts.OpenCLCPlusPlusVersion == 100)
413         Builder.defineMacro("__OPENCL_CPP_VERSION__", "100");
414       else
415         llvm_unreachable("Unsupported C++ version for OpenCL");
416       Builder.defineMacro("__CL_CPP_VERSION_1_0__", "100");
417     } else {
418       // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the
419       // language standard with which the program is compiled. __OPENCL_VERSION__
420       // is for the OpenCL version supported by the OpenCL device, which is not
421       // necessarily the language standard with which the program is compiled.
422       // A shared OpenCL header file requires a macro to indicate the language
423       // standard. As a workaround, __OPENCL_C_VERSION__ is defined for
424       // OpenCL v1.0 and v1.1.
425       switch (LangOpts.OpenCLVersion) {
426       case 100:
427         Builder.defineMacro("__OPENCL_C_VERSION__", "100");
428         break;
429       case 110:
430         Builder.defineMacro("__OPENCL_C_VERSION__", "110");
431         break;
432       case 120:
433         Builder.defineMacro("__OPENCL_C_VERSION__", "120");
434         break;
435       case 200:
436         Builder.defineMacro("__OPENCL_C_VERSION__", "200");
437         break;
438       default:
439         llvm_unreachable("Unsupported OpenCL version");
440       }
441     }
442     Builder.defineMacro("CL_VERSION_1_0", "100");
443     Builder.defineMacro("CL_VERSION_1_1", "110");
444     Builder.defineMacro("CL_VERSION_1_2", "120");
445     Builder.defineMacro("CL_VERSION_2_0", "200");
446 
447     if (TI.isLittleEndian())
448       Builder.defineMacro("__ENDIAN_LITTLE__");
449 
450     if (LangOpts.FastRelaxedMath)
451       Builder.defineMacro("__FAST_RELAXED_MATH__");
452   }
453   // Not "standard" per se, but available even with the -undef flag.
454   if (LangOpts.AsmPreprocessor)
455     Builder.defineMacro("__ASSEMBLER__");
456   if (LangOpts.CUDA && !LangOpts.HIP)
457     Builder.defineMacro("__CUDA__");
458   if (LangOpts.HIP) {
459     Builder.defineMacro("__HIP__");
460     Builder.defineMacro("__HIPCC__");
461     if (LangOpts.CUDAIsDevice)
462       Builder.defineMacro("__HIP_DEVICE_COMPILE__");
463   }
464 }
465 
466 /// Initialize the predefined C++ language feature test macros defined in
467 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
468 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
469                                                  MacroBuilder &Builder) {
470   // C++98 features.
471   if (LangOpts.RTTI)
472     Builder.defineMacro("__cpp_rtti", "199711L");
473   if (LangOpts.CXXExceptions)
474     Builder.defineMacro("__cpp_exceptions", "199711L");
475 
476   // C++11 features.
477   if (LangOpts.CPlusPlus11) {
478     Builder.defineMacro("__cpp_unicode_characters", "200704L");
479     Builder.defineMacro("__cpp_raw_strings", "200710L");
480     Builder.defineMacro("__cpp_unicode_literals", "200710L");
481     Builder.defineMacro("__cpp_user_defined_literals", "200809L");
482     Builder.defineMacro("__cpp_lambdas", "200907L");
483     Builder.defineMacro("__cpp_constexpr",
484                         LangOpts.CPlusPlus2a ? "201907L" :
485                         LangOpts.CPlusPlus17 ? "201603L" :
486                         LangOpts.CPlusPlus14 ? "201304L" : "200704");
487     Builder.defineMacro("__cpp_range_based_for",
488                         LangOpts.CPlusPlus17 ? "201603L" : "200907");
489     Builder.defineMacro("__cpp_static_assert",
490                         LangOpts.CPlusPlus17 ? "201411L" : "200410");
491     Builder.defineMacro("__cpp_decltype", "200707L");
492     Builder.defineMacro("__cpp_attributes", "200809L");
493     Builder.defineMacro("__cpp_rvalue_references", "200610L");
494     Builder.defineMacro("__cpp_variadic_templates", "200704L");
495     Builder.defineMacro("__cpp_initializer_lists", "200806L");
496     Builder.defineMacro("__cpp_delegating_constructors", "200604L");
497     Builder.defineMacro("__cpp_nsdmi", "200809L");
498     Builder.defineMacro("__cpp_inheriting_constructors", "201511L");
499     Builder.defineMacro("__cpp_ref_qualifiers", "200710L");
500     Builder.defineMacro("__cpp_alias_templates", "200704L");
501   }
502   if (LangOpts.ThreadsafeStatics)
503     Builder.defineMacro("__cpp_threadsafe_static_init", "200806L");
504 
505   // C++14 features.
506   if (LangOpts.CPlusPlus14) {
507     Builder.defineMacro("__cpp_binary_literals", "201304L");
508     Builder.defineMacro("__cpp_digit_separators", "201309L");
509     Builder.defineMacro("__cpp_init_captures", "201304L");
510     Builder.defineMacro("__cpp_generic_lambdas", "201304L");
511     Builder.defineMacro("__cpp_decltype_auto", "201304L");
512     Builder.defineMacro("__cpp_return_type_deduction", "201304L");
513     Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L");
514     Builder.defineMacro("__cpp_variable_templates", "201304L");
515   }
516   if (LangOpts.SizedDeallocation)
517     Builder.defineMacro("__cpp_sized_deallocation", "201309L");
518 
519   // C++17 features.
520   if (LangOpts.CPlusPlus17) {
521     Builder.defineMacro("__cpp_hex_float", "201603L");
522     Builder.defineMacro("__cpp_inline_variables", "201606L");
523     Builder.defineMacro("__cpp_noexcept_function_type", "201510L");
524     Builder.defineMacro("__cpp_capture_star_this", "201603L");
525     Builder.defineMacro("__cpp_if_constexpr", "201606L");
526     Builder.defineMacro("__cpp_deduction_guides", "201703L");
527     Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name)
528     Builder.defineMacro("__cpp_namespace_attributes", "201411L");
529     Builder.defineMacro("__cpp_enumerator_attributes", "201411L");
530     Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L");
531     Builder.defineMacro("__cpp_variadic_using", "201611L");
532     Builder.defineMacro("__cpp_aggregate_bases", "201603L");
533     Builder.defineMacro("__cpp_structured_bindings", "201606L");
534     Builder.defineMacro("__cpp_nontype_template_args", "201411L");
535     Builder.defineMacro("__cpp_fold_expressions", "201603L");
536     Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L");
537     Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L");
538   }
539   if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable)
540     Builder.defineMacro("__cpp_aligned_new", "201606L");
541   if (LangOpts.RelaxedTemplateTemplateArgs)
542     Builder.defineMacro("__cpp_template_template_args", "201611L");
543 
544   // C++20 features.
545   if (LangOpts.CPlusPlus2a) {
546     Builder.defineMacro("__cpp_conditional_explicit", "201806L");
547     Builder.defineMacro("__cpp_constexpr_dynamic_alloc", "201907L");
548     Builder.defineMacro("__cpp_constinit", "201907L");
549     Builder.defineMacro("__cpp_impl_three_way_comparison", "201907L");
550   }
551   if (LangOpts.Char8)
552     Builder.defineMacro("__cpp_char8_t", "201811L");
553   Builder.defineMacro("__cpp_impl_destroying_delete", "201806L");
554 
555   // TS features.
556   if (LangOpts.ConceptsTS)
557     Builder.defineMacro("__cpp_experimental_concepts", "1L");
558   if (LangOpts.Coroutines)
559     Builder.defineMacro("__cpp_coroutines", "201703L");
560 }
561 
562 static void InitializePredefinedMacros(const TargetInfo &TI,
563                                        const LangOptions &LangOpts,
564                                        const FrontendOptions &FEOpts,
565                                        const PreprocessorOptions &PPOpts,
566                                        MacroBuilder &Builder) {
567   // Compiler version introspection macros.
568   Builder.defineMacro("__llvm__");  // LLVM Backend
569   Builder.defineMacro("__clang__"); // Clang Frontend
570 #define TOSTR2(X) #X
571 #define TOSTR(X) TOSTR2(X)
572   Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
573   Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
574   Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
575 #undef TOSTR
576 #undef TOSTR2
577   Builder.defineMacro("__clang_version__",
578                       "\"" CLANG_VERSION_STRING " "
579                       + getClangFullRepositoryVersion() + "\"");
580 
581   if (LangOpts.GNUCVersion != 0) {
582     // Major, minor, patch, are given two decimal places each, so 4.2.1 becomes
583     // 40201.
584     unsigned GNUCMajor = LangOpts.GNUCVersion / 100 / 100;
585     unsigned GNUCMinor = LangOpts.GNUCVersion / 100 % 100;
586     unsigned GNUCPatch = LangOpts.GNUCVersion % 100;
587     Builder.defineMacro("__GNUC__", Twine(GNUCMajor));
588     Builder.defineMacro("__GNUC_MINOR__", Twine(GNUCMinor));
589     Builder.defineMacro("__GNUC_PATCHLEVEL__", Twine(GNUCPatch));
590     Builder.defineMacro("__GXX_ABI_VERSION", "1002");
591 
592     if (LangOpts.CPlusPlus) {
593       Builder.defineMacro("__GNUG__", Twine(GNUCMajor));
594       Builder.defineMacro("__GXX_WEAK__");
595     }
596   }
597 
598   // Define macros for the C11 / C++11 memory orderings
599   Builder.defineMacro("__ATOMIC_RELAXED", "0");
600   Builder.defineMacro("__ATOMIC_CONSUME", "1");
601   Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
602   Builder.defineMacro("__ATOMIC_RELEASE", "3");
603   Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
604   Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
605 
606   // Define macros for the OpenCL memory scope.
607   // The values should match AtomicScopeOpenCLModel::ID enum.
608   static_assert(
609       static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 &&
610           static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 &&
611           static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 &&
612           static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4,
613       "Invalid OpenCL memory scope enum definition");
614   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0");
615   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1");
616   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2");
617   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3");
618   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4");
619 
620   // Support for #pragma redefine_extname (Sun compatibility)
621   Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
622 
623   // Previously this macro was set to a string aiming to achieve compatibility
624   // with GCC 4.2.1. Now, just return the full Clang version
625   Builder.defineMacro("__VERSION__", "\"" +
626                       Twine(getClangFullCPPVersion()) + "\"");
627 
628   // Initialize language-specific preprocessor defines.
629 
630   // Standard conforming mode?
631   if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
632     Builder.defineMacro("__STRICT_ANSI__");
633 
634   if (LangOpts.GNUCVersion && LangOpts.CPlusPlus11)
635     Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
636 
637   if (LangOpts.ObjC) {
638     if (LangOpts.ObjCRuntime.isNonFragile()) {
639       Builder.defineMacro("__OBJC2__");
640 
641       if (LangOpts.ObjCExceptions)
642         Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
643     }
644 
645     if (LangOpts.getGC() != LangOptions::NonGC)
646       Builder.defineMacro("__OBJC_GC__");
647 
648     if (LangOpts.ObjCRuntime.isNeXTFamily())
649       Builder.defineMacro("__NEXT_RUNTIME__");
650 
651     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) {
652       auto version = LangOpts.ObjCRuntime.getVersion();
653       std::string versionString = "1";
654       // Don't rely on the tuple argument, because we can be asked to target
655       // later ABIs than we actually support, so clamp these values to those
656       // currently supported
657       if (version >= VersionTuple(2, 0))
658         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", "20");
659       else
660         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__",
661             "1" + Twine(std::min(8U, version.getMinor().getValueOr(0))));
662     }
663 
664     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
665       VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
666 
667       unsigned minor = 0;
668       if (tuple.getMinor().hasValue())
669         minor = tuple.getMinor().getValue();
670 
671       unsigned subminor = 0;
672       if (tuple.getSubminor().hasValue())
673         subminor = tuple.getSubminor().getValue();
674 
675       Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
676                           Twine(tuple.getMajor() * 10000 + minor * 100 +
677                                 subminor));
678     }
679 
680     Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
681     Builder.defineMacro("IBOutletCollection(ClassName)",
682                         "__attribute__((iboutletcollection(ClassName)))");
683     Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
684     Builder.defineMacro("IBInspectable", "");
685     Builder.defineMacro("IB_DESIGNABLE", "");
686   }
687 
688   // Define a macro that describes the Objective-C boolean type even for C
689   // and C++ since BOOL can be used from non Objective-C code.
690   Builder.defineMacro("__OBJC_BOOL_IS_BOOL",
691                       Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
692 
693   if (LangOpts.CPlusPlus)
694     InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
695 
696   // darwin_constant_cfstrings controls this. This is also dependent
697   // on other things like the runtime I believe.  This is set even for C code.
698   if (!LangOpts.NoConstantCFStrings)
699       Builder.defineMacro("__CONSTANT_CFSTRINGS__");
700 
701   if (LangOpts.ObjC)
702     Builder.defineMacro("OBJC_NEW_PROPERTIES");
703 
704   if (LangOpts.PascalStrings)
705     Builder.defineMacro("__PASCAL_STRINGS__");
706 
707   if (LangOpts.Blocks) {
708     Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
709     Builder.defineMacro("__BLOCKS__");
710   }
711 
712   if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
713     Builder.defineMacro("__EXCEPTIONS");
714   if (LangOpts.GNUCVersion && LangOpts.RTTI)
715     Builder.defineMacro("__GXX_RTTI");
716 
717   if (LangOpts.SjLjExceptions)
718     Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
719   else if (LangOpts.SEHExceptions)
720     Builder.defineMacro("__SEH__");
721   else if (LangOpts.DWARFExceptions &&
722           (TI.getTriple().isThumb() || TI.getTriple().isARM()))
723     Builder.defineMacro("__ARM_DWARF_EH__");
724 
725   if (LangOpts.Deprecated)
726     Builder.defineMacro("__DEPRECATED");
727 
728   if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus)
729     Builder.defineMacro("__private_extern__", "extern");
730 
731   if (LangOpts.MicrosoftExt) {
732     if (LangOpts.WChar) {
733       // wchar_t supported as a keyword.
734       Builder.defineMacro("_WCHAR_T_DEFINED");
735       Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
736     }
737   }
738 
739   if (LangOpts.Optimize)
740     Builder.defineMacro("__OPTIMIZE__");
741   if (LangOpts.OptimizeSize)
742     Builder.defineMacro("__OPTIMIZE_SIZE__");
743 
744   if (LangOpts.FastMath)
745     Builder.defineMacro("__FAST_MATH__");
746 
747   // Initialize target-specific preprocessor defines.
748 
749   // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
750   // to the macro __BYTE_ORDER (no trailing underscores)
751   // from glibc's <endian.h> header.
752   // We don't support the PDP-11 as a target, but include
753   // the define so it can still be compared against.
754   Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
755   Builder.defineMacro("__ORDER_BIG_ENDIAN__",    "4321");
756   Builder.defineMacro("__ORDER_PDP_ENDIAN__",    "3412");
757   if (TI.isBigEndian()) {
758     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
759     Builder.defineMacro("__BIG_ENDIAN__");
760   } else {
761     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
762     Builder.defineMacro("__LITTLE_ENDIAN__");
763   }
764 
765   if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
766       && TI.getIntWidth() == 32) {
767     Builder.defineMacro("_LP64");
768     Builder.defineMacro("__LP64__");
769   }
770 
771   if (TI.getPointerWidth(0) == 32 && TI.getLongWidth() == 32
772       && TI.getIntWidth() == 32) {
773     Builder.defineMacro("_ILP32");
774     Builder.defineMacro("__ILP32__");
775   }
776 
777   // Define type sizing macros based on the target properties.
778   assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
779   Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth()));
780 
781   DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
782   DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
783   DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
784   DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
785   DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
786   DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
787   DefineTypeSize("__WINT_MAX__", TI.getWIntType(), TI, Builder);
788   DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
789   DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
790 
791   DefineTypeSize("__UINTMAX_MAX__", TI.getUIntMaxType(), TI, Builder);
792   DefineTypeSize("__PTRDIFF_MAX__", TI.getPtrDiffType(0), TI, Builder);
793   DefineTypeSize("__INTPTR_MAX__", TI.getIntPtrType(), TI, Builder);
794   DefineTypeSize("__UINTPTR_MAX__", TI.getUIntPtrType(), TI, Builder);
795 
796   DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
797   DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
798   DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
799   DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
800   DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
801   DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
802   DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
803   DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
804   DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
805                    TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
806   DefineTypeSizeof("__SIZEOF_SIZE_T__",
807                    TI.getTypeWidth(TI.getSizeType()), TI, Builder);
808   DefineTypeSizeof("__SIZEOF_WCHAR_T__",
809                    TI.getTypeWidth(TI.getWCharType()), TI, Builder);
810   DefineTypeSizeof("__SIZEOF_WINT_T__",
811                    TI.getTypeWidth(TI.getWIntType()), TI, Builder);
812   if (TI.hasInt128Type())
813     DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
814 
815   DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
816   DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder);
817   Builder.defineMacro("__INTMAX_C_SUFFIX__",
818                       TI.getTypeConstantSuffix(TI.getIntMaxType()));
819   DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
820   DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
821   Builder.defineMacro("__UINTMAX_C_SUFFIX__",
822                       TI.getTypeConstantSuffix(TI.getUIntMaxType()));
823   DefineTypeWidth("__INTMAX_WIDTH__",  TI.getIntMaxType(), TI, Builder);
824   DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
825   DefineFmt("__PTRDIFF", TI.getPtrDiffType(0), TI, Builder);
826   DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
827   DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
828   DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder);
829   DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
830   DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
831   DefineFmt("__SIZE", TI.getSizeType(), TI, Builder);
832   DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
833   DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
834   DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
835   DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
836   DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
837   DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
838   DefineTypeSize("__SIG_ATOMIC_MAX__", TI.getSigAtomicType(), TI, Builder);
839   DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
840   DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
841 
842   DefineTypeWidth("__UINTMAX_WIDTH__",  TI.getUIntMaxType(), TI, Builder);
843   DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder);
844   DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
845   DefineTypeWidth("__UINTPTR_WIDTH__", TI.getUIntPtrType(), TI, Builder);
846 
847   if (TI.hasFloat16Type())
848     DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16");
849   DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
850   DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
851   DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
852 
853   // Define a __POINTER_WIDTH__ macro for stdint.h.
854   Builder.defineMacro("__POINTER_WIDTH__",
855                       Twine((int)TI.getPointerWidth(0)));
856 
857   // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
858   Builder.defineMacro("__BIGGEST_ALIGNMENT__",
859                       Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
860 
861   if (!LangOpts.CharIsSigned)
862     Builder.defineMacro("__CHAR_UNSIGNED__");
863 
864   if (!TargetInfo::isTypeSigned(TI.getWCharType()))
865     Builder.defineMacro("__WCHAR_UNSIGNED__");
866 
867   if (!TargetInfo::isTypeSigned(TI.getWIntType()))
868     Builder.defineMacro("__WINT_UNSIGNED__");
869 
870   // Define exact-width integer types for stdint.h
871   DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder);
872 
873   if (TI.getShortWidth() > TI.getCharWidth())
874     DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
875 
876   if (TI.getIntWidth() > TI.getShortWidth())
877     DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
878 
879   if (TI.getLongWidth() > TI.getIntWidth())
880     DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
881 
882   if (TI.getLongLongWidth() > TI.getLongWidth())
883     DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
884 
885   DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder);
886   DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder);
887   DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder);
888 
889   if (TI.getShortWidth() > TI.getCharWidth()) {
890     DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder);
891     DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder);
892     DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder);
893   }
894 
895   if (TI.getIntWidth() > TI.getShortWidth()) {
896     DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder);
897     DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder);
898     DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder);
899   }
900 
901   if (TI.getLongWidth() > TI.getIntWidth()) {
902     DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder);
903     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder);
904     DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder);
905   }
906 
907   if (TI.getLongLongWidth() > TI.getLongWidth()) {
908     DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder);
909     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder);
910     DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder);
911   }
912 
913   DefineLeastWidthIntType(8, true, TI, Builder);
914   DefineLeastWidthIntType(8, false, TI, Builder);
915   DefineLeastWidthIntType(16, true, TI, Builder);
916   DefineLeastWidthIntType(16, false, TI, Builder);
917   DefineLeastWidthIntType(32, true, TI, Builder);
918   DefineLeastWidthIntType(32, false, TI, Builder);
919   DefineLeastWidthIntType(64, true, TI, Builder);
920   DefineLeastWidthIntType(64, false, TI, Builder);
921 
922   DefineFastIntType(8, true, TI, Builder);
923   DefineFastIntType(8, false, TI, Builder);
924   DefineFastIntType(16, true, TI, Builder);
925   DefineFastIntType(16, false, TI, Builder);
926   DefineFastIntType(32, true, TI, Builder);
927   DefineFastIntType(32, false, TI, Builder);
928   DefineFastIntType(64, true, TI, Builder);
929   DefineFastIntType(64, false, TI, Builder);
930 
931   char UserLabelPrefix[2] = {TI.getDataLayout().getGlobalPrefix(), 0};
932   Builder.defineMacro("__USER_LABEL_PREFIX__", UserLabelPrefix);
933 
934   if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
935     Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
936   else
937     Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
938 
939   if (LangOpts.GNUCVersion) {
940     if (LangOpts.GNUInline || LangOpts.CPlusPlus)
941       Builder.defineMacro("__GNUC_GNU_INLINE__");
942     else
943       Builder.defineMacro("__GNUC_STDC_INLINE__");
944 
945     // The value written by __atomic_test_and_set.
946     // FIXME: This is target-dependent.
947     Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
948   }
949 
950   auto addLockFreeMacros = [&](const llvm::Twine &Prefix) {
951     // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
952     unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
953 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type)                                     \
954   Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE",                             \
955                       getLockFreeValue(TI.get##Type##Width(),                  \
956                                        TI.get##Type##Align(),                  \
957                                        InlineWidthBits));
958     DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
959     DEFINE_LOCK_FREE_MACRO(CHAR, Char);
960     if (LangOpts.Char8)
961       DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char.
962     DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
963     DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
964     DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
965     DEFINE_LOCK_FREE_MACRO(SHORT, Short);
966     DEFINE_LOCK_FREE_MACRO(INT, Int);
967     DEFINE_LOCK_FREE_MACRO(LONG, Long);
968     DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
969     Builder.defineMacro(Prefix + "POINTER_LOCK_FREE",
970                         getLockFreeValue(TI.getPointerWidth(0),
971                                          TI.getPointerAlign(0),
972                                          InlineWidthBits));
973 #undef DEFINE_LOCK_FREE_MACRO
974   };
975   addLockFreeMacros("__CLANG_ATOMIC_");
976   if (LangOpts.GNUCVersion)
977     addLockFreeMacros("__GCC_ATOMIC_");
978 
979   if (LangOpts.NoInlineDefine)
980     Builder.defineMacro("__NO_INLINE__");
981 
982   if (unsigned PICLevel = LangOpts.PICLevel) {
983     Builder.defineMacro("__PIC__", Twine(PICLevel));
984     Builder.defineMacro("__pic__", Twine(PICLevel));
985     if (LangOpts.PIE) {
986       Builder.defineMacro("__PIE__", Twine(PICLevel));
987       Builder.defineMacro("__pie__", Twine(PICLevel));
988     }
989   }
990 
991   // Macros to control C99 numerics and <float.h>
992   Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
993   Builder.defineMacro("__FLT_RADIX__", "2");
994   Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__");
995 
996   if (LangOpts.getStackProtector() == LangOptions::SSPOn)
997     Builder.defineMacro("__SSP__");
998   else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
999     Builder.defineMacro("__SSP_STRONG__", "2");
1000   else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
1001     Builder.defineMacro("__SSP_ALL__", "3");
1002 
1003   if (PPOpts.SetUpStaticAnalyzer)
1004     Builder.defineMacro("__clang_analyzer__");
1005 
1006   if (LangOpts.FastRelaxedMath)
1007     Builder.defineMacro("__FAST_RELAXED_MATH__");
1008 
1009   if (FEOpts.ProgramAction == frontend::RewriteObjC ||
1010       LangOpts.getGC() != LangOptions::NonGC) {
1011     Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
1012     Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))");
1013     Builder.defineMacro("__autoreleasing", "");
1014     Builder.defineMacro("__unsafe_unretained", "");
1015   } else if (LangOpts.ObjC) {
1016     Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
1017     Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
1018     Builder.defineMacro("__autoreleasing",
1019                         "__attribute__((objc_ownership(autoreleasing)))");
1020     Builder.defineMacro("__unsafe_unretained",
1021                         "__attribute__((objc_ownership(none)))");
1022   }
1023 
1024   // On Darwin, there are __double_underscored variants of the type
1025   // nullability qualifiers.
1026   if (TI.getTriple().isOSDarwin()) {
1027     Builder.defineMacro("__nonnull", "_Nonnull");
1028     Builder.defineMacro("__null_unspecified", "_Null_unspecified");
1029     Builder.defineMacro("__nullable", "_Nullable");
1030   }
1031 
1032   // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and
1033   // the corresponding simulator targets.
1034   if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment())
1035     Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1");
1036 
1037   // OpenMP definition
1038   // OpenMP 2.2:
1039   //   In implementations that support a preprocessor, the _OPENMP
1040   //   macro name is defined to have the decimal value yyyymm where
1041   //   yyyy and mm are the year and the month designations of the
1042   //   version of the OpenMP API that the implementation support.
1043   if (!LangOpts.OpenMPSimd) {
1044     switch (LangOpts.OpenMP) {
1045     case 0:
1046       break;
1047     case 31:
1048       Builder.defineMacro("_OPENMP", "201107");
1049       break;
1050     case 40:
1051       Builder.defineMacro("_OPENMP", "201307");
1052       break;
1053     case 50:
1054       Builder.defineMacro("_OPENMP", "201811");
1055       break;
1056     default:
1057       // Default version is OpenMP 4.5
1058       Builder.defineMacro("_OPENMP", "201511");
1059       break;
1060     }
1061   }
1062 
1063   // CUDA device path compilaton
1064   if (LangOpts.CUDAIsDevice && !LangOpts.HIP) {
1065     // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
1066     // backend's target defines.
1067     Builder.defineMacro("__CUDA_ARCH__");
1068   }
1069 
1070   // We need to communicate this to our CUDA header wrapper, which in turn
1071   // informs the proper CUDA headers of this choice.
1072   if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) {
1073     Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__");
1074   }
1075 
1076   // Define a macro indicating that the source file is being compiled with a
1077   // SYCL device compiler which doesn't produce host binary.
1078   if (LangOpts.SYCLIsDevice) {
1079     Builder.defineMacro("__SYCL_DEVICE_ONLY__", "1");
1080   }
1081 
1082   // OpenCL definitions.
1083   if (LangOpts.OpenCL) {
1084 #define OPENCLEXT(Ext)                                                         \
1085   if (TI.getSupportedOpenCLOpts().isSupported(#Ext, LangOpts))                 \
1086     Builder.defineMacro(#Ext);
1087 #include "clang/Basic/OpenCLExtensions.def"
1088 
1089     if (TI.getTriple().isSPIR())
1090       Builder.defineMacro("__IMAGE_SUPPORT__");
1091   }
1092 
1093   if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1094     // For each extended integer type, g++ defines a macro mapping the
1095     // index of the type (0 in this case) in some list of extended types
1096     // to the type.
1097     Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128");
1098     Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128");
1099   }
1100 
1101   // Get other target #defines.
1102   TI.getTargetDefines(LangOpts, Builder);
1103 }
1104 
1105 /// InitializePreprocessor - Initialize the preprocessor getting it and the
1106 /// environment ready to process a single file. This returns true on error.
1107 ///
1108 void clang::InitializePreprocessor(
1109     Preprocessor &PP, const PreprocessorOptions &InitOpts,
1110     const PCHContainerReader &PCHContainerRdr,
1111     const FrontendOptions &FEOpts) {
1112   const LangOptions &LangOpts = PP.getLangOpts();
1113   std::string PredefineBuffer;
1114   PredefineBuffer.reserve(4080);
1115   llvm::raw_string_ostream Predefines(PredefineBuffer);
1116   MacroBuilder Builder(Predefines);
1117 
1118   // Emit line markers for various builtin sections of the file.  We don't do
1119   // this in asm preprocessor mode, because "# 4" is not a line marker directive
1120   // in this mode.
1121   if (!PP.getLangOpts().AsmPreprocessor)
1122     Builder.append("# 1 \"<built-in>\" 3");
1123 
1124   // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1125   if (InitOpts.UsePredefines) {
1126     // FIXME: This will create multiple definitions for most of the predefined
1127     // macros. This is not the right way to handle this.
1128     if ((LangOpts.CUDA || LangOpts.OpenMPIsDevice || LangOpts.SYCLIsDevice) &&
1129         PP.getAuxTargetInfo())
1130       InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts,
1131                                  PP.getPreprocessorOpts(), Builder);
1132 
1133     InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts,
1134                                PP.getPreprocessorOpts(), Builder);
1135 
1136     // Install definitions to make Objective-C++ ARC work well with various
1137     // C++ Standard Library implementations.
1138     if (LangOpts.ObjC && LangOpts.CPlusPlus &&
1139         (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1140       switch (InitOpts.ObjCXXARCStandardLibrary) {
1141       case ARCXX_nolib:
1142       case ARCXX_libcxx:
1143         break;
1144 
1145       case ARCXX_libstdcxx:
1146         AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1147         break;
1148       }
1149     }
1150   }
1151 
1152   // Even with predefines off, some macros are still predefined.
1153   // These should all be defined in the preprocessor according to the
1154   // current language configuration.
1155   InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
1156                                      FEOpts, Builder);
1157 
1158   // Add on the predefines from the driver.  Wrap in a #line directive to report
1159   // that they come from the command line.
1160   if (!PP.getLangOpts().AsmPreprocessor)
1161     Builder.append("# 1 \"<command line>\" 1");
1162 
1163   // Process #define's and #undef's in the order they are given.
1164   for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1165     if (InitOpts.Macros[i].second)  // isUndef
1166       Builder.undefineMacro(InitOpts.Macros[i].first);
1167     else
1168       DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
1169                          PP.getDiagnostics());
1170   }
1171 
1172   // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1173   if (!PP.getLangOpts().AsmPreprocessor)
1174     Builder.append("# 1 \"<built-in>\" 2");
1175 
1176   // If -imacros are specified, include them now.  These are processed before
1177   // any -include directives.
1178   for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1179     AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
1180 
1181   // Process -include-pch/-include-pth directives.
1182   if (!InitOpts.ImplicitPCHInclude.empty())
1183     AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1184                           InitOpts.ImplicitPCHInclude);
1185 
1186   // Process -include directives.
1187   for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1188     const std::string &Path = InitOpts.Includes[i];
1189     AddImplicitInclude(Builder, Path);
1190   }
1191 
1192   // Instruct the preprocessor to skip the preamble.
1193   PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
1194                              InitOpts.PrecompiledPreambleBytes.second);
1195 
1196   // Copy PredefinedBuffer into the Preprocessor.
1197   PP.setPredefines(Predefines.str());
1198 }
1199