xref: /llvm-project/clang/lib/Frontend/InitPreprocessor.cpp (revision f0a955d3fa54d2b8600e646bbfb6bf3217a18d0c)
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/HLSLRuntime.h"
15 #include "clang/Basic/MacroBuilder.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/SyncScope.h"
18 #include "clang/Basic/TargetInfo.h"
19 #include "clang/Basic/Version.h"
20 #include "clang/Frontend/FrontendDiagnostic.h"
21 #include "clang/Frontend/FrontendOptions.h"
22 #include "clang/Frontend/Utils.h"
23 #include "clang/Lex/HeaderSearch.h"
24 #include "clang/Lex/Preprocessor.h"
25 #include "clang/Lex/PreprocessorOptions.h"
26 #include "clang/Serialization/ASTReader.h"
27 #include "llvm/ADT/APFloat.h"
28 #include "llvm/IR/DataLayout.h"
29 #include "llvm/IR/DerivedTypes.h"
30 using namespace clang;
31 
32 static bool MacroBodyEndsInBackslash(StringRef MacroBody) {
33   while (!MacroBody.empty() && isWhitespace(MacroBody.back()))
34     MacroBody = MacroBody.drop_back();
35   return !MacroBody.empty() && MacroBody.back() == '\\';
36 }
37 
38 // Append a #define line to Buf for Macro.  Macro should be of the form XXX,
39 // in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
40 // "#define XXX Y z W".  To get a #define with no value, use "XXX=".
41 static void DefineBuiltinMacro(MacroBuilder &Builder, StringRef Macro,
42                                DiagnosticsEngine &Diags) {
43   std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
44   StringRef MacroName = MacroPair.first;
45   StringRef MacroBody = MacroPair.second;
46   if (MacroName.size() != Macro.size()) {
47     // Per GCC -D semantics, the macro ends at \n if it exists.
48     StringRef::size_type End = MacroBody.find_first_of("\n\r");
49     if (End != StringRef::npos)
50       Diags.Report(diag::warn_fe_macro_contains_embedded_newline)
51         << MacroName;
52     MacroBody = MacroBody.substr(0, End);
53     // We handle macro bodies which end in a backslash by appending an extra
54     // backslash+newline.  This makes sure we don't accidentally treat the
55     // backslash as a line continuation marker.
56     if (MacroBodyEndsInBackslash(MacroBody))
57       Builder.defineMacro(MacroName, Twine(MacroBody) + "\\\n");
58     else
59       Builder.defineMacro(MacroName, MacroBody);
60   } else {
61     // Push "macroname 1".
62     Builder.defineMacro(Macro);
63   }
64 }
65 
66 /// AddImplicitInclude - Add an implicit \#include of the specified file to the
67 /// predefines buffer.
68 /// As these includes are generated by -include arguments the header search
69 /// logic is going to search relatively to the current working directory.
70 static void AddImplicitInclude(MacroBuilder &Builder, StringRef File) {
71   Builder.append(Twine("#include \"") + File + "\"");
72 }
73 
74 static void AddImplicitIncludeMacros(MacroBuilder &Builder, StringRef File) {
75   Builder.append(Twine("#__include_macros \"") + File + "\"");
76   // Marker token to stop the __include_macros fetch loop.
77   Builder.append("##"); // ##?
78 }
79 
80 /// Add an implicit \#include using the original file used to generate
81 /// a PCH file.
82 static void AddImplicitIncludePCH(MacroBuilder &Builder, Preprocessor &PP,
83                                   const PCHContainerReader &PCHContainerRdr,
84                                   StringRef ImplicitIncludePCH) {
85   std::string OriginalFile = ASTReader::getOriginalSourceFile(
86       std::string(ImplicitIncludePCH), PP.getFileManager(), PCHContainerRdr,
87       PP.getDiagnostics());
88   if (OriginalFile.empty())
89     return;
90 
91   AddImplicitInclude(Builder, OriginalFile);
92 }
93 
94 /// PickFP - This is used to pick a value based on the FP semantics of the
95 /// specified FP model.
96 template <typename T>
97 static T PickFP(const llvm::fltSemantics *Sem, T IEEEHalfVal, T IEEESingleVal,
98                 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
99                 T IEEEQuadVal) {
100   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEhalf())
101     return IEEEHalfVal;
102   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle())
103     return IEEESingleVal;
104   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble())
105     return IEEEDoubleVal;
106   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended())
107     return X87DoubleExtendedVal;
108   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble())
109     return PPCDoubleDoubleVal;
110   assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad());
111   return IEEEQuadVal;
112 }
113 
114 static void DefineFloatMacros(MacroBuilder &Builder, StringRef Prefix,
115                               const llvm::fltSemantics *Sem, StringRef Ext) {
116   const char *DenormMin, *Epsilon, *Max, *Min;
117   DenormMin = PickFP(Sem, "5.9604644775390625e-8", "1.40129846e-45",
118                      "4.9406564584124654e-324", "3.64519953188247460253e-4951",
119                      "4.94065645841246544176568792868221e-324",
120                      "6.47517511943802511092443895822764655e-4966");
121   int Digits = PickFP(Sem, 3, 6, 15, 18, 31, 33);
122   int DecimalDigits = PickFP(Sem, 5, 9, 17, 21, 33, 36);
123   Epsilon = PickFP(Sem, "9.765625e-4", "1.19209290e-7",
124                    "2.2204460492503131e-16", "1.08420217248550443401e-19",
125                    "4.94065645841246544176568792868221e-324",
126                    "1.92592994438723585305597794258492732e-34");
127   int MantissaDigits = PickFP(Sem, 11, 24, 53, 64, 106, 113);
128   int Min10Exp = PickFP(Sem, -4, -37, -307, -4931, -291, -4931);
129   int Max10Exp = PickFP(Sem, 4, 38, 308, 4932, 308, 4932);
130   int MinExp = PickFP(Sem, -13, -125, -1021, -16381, -968, -16381);
131   int MaxExp = PickFP(Sem, 16, 128, 1024, 16384, 1024, 16384);
132   Min = PickFP(Sem, "6.103515625e-5", "1.17549435e-38", "2.2250738585072014e-308",
133                "3.36210314311209350626e-4932",
134                "2.00416836000897277799610805135016e-292",
135                "3.36210314311209350626267781732175260e-4932");
136   Max = PickFP(Sem, "6.5504e+4", "3.40282347e+38", "1.7976931348623157e+308",
137                "1.18973149535723176502e+4932",
138                "1.79769313486231580793728971405301e+308",
139                "1.18973149535723176508575932662800702e+4932");
140 
141   SmallString<32> DefPrefix;
142   DefPrefix = "__";
143   DefPrefix += Prefix;
144   DefPrefix += "_";
145 
146   Builder.defineMacro(DefPrefix + "DENORM_MIN__", Twine(DenormMin)+Ext);
147   Builder.defineMacro(DefPrefix + "HAS_DENORM__");
148   Builder.defineMacro(DefPrefix + "DIG__", Twine(Digits));
149   Builder.defineMacro(DefPrefix + "DECIMAL_DIG__", Twine(DecimalDigits));
150   Builder.defineMacro(DefPrefix + "EPSILON__", Twine(Epsilon)+Ext);
151   Builder.defineMacro(DefPrefix + "HAS_INFINITY__");
152   Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__");
153   Builder.defineMacro(DefPrefix + "MANT_DIG__", Twine(MantissaDigits));
154 
155   Builder.defineMacro(DefPrefix + "MAX_10_EXP__", Twine(Max10Exp));
156   Builder.defineMacro(DefPrefix + "MAX_EXP__", Twine(MaxExp));
157   Builder.defineMacro(DefPrefix + "MAX__", Twine(Max)+Ext);
158 
159   Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+Twine(Min10Exp)+")");
160   Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+Twine(MinExp)+")");
161   Builder.defineMacro(DefPrefix + "MIN__", Twine(Min)+Ext);
162 }
163 
164 
165 /// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
166 /// named MacroName with the max value for a type with width 'TypeWidth' a
167 /// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
168 static void DefineTypeSize(const Twine &MacroName, unsigned TypeWidth,
169                            StringRef ValSuffix, bool isSigned,
170                            MacroBuilder &Builder) {
171   llvm::APInt MaxVal = isSigned ? llvm::APInt::getSignedMaxValue(TypeWidth)
172                                 : llvm::APInt::getMaxValue(TypeWidth);
173   Builder.defineMacro(MacroName, toString(MaxVal, 10, isSigned) + ValSuffix);
174 }
175 
176 /// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
177 /// the width, suffix, and signedness of the given type
178 static void DefineTypeSize(const Twine &MacroName, TargetInfo::IntType Ty,
179                            const TargetInfo &TI, MacroBuilder &Builder) {
180   DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
181                  TI.isTypeSigned(Ty), Builder);
182 }
183 
184 static void DefineFmt(const Twine &Prefix, TargetInfo::IntType Ty,
185                       const TargetInfo &TI, MacroBuilder &Builder) {
186   bool IsSigned = TI.isTypeSigned(Ty);
187   StringRef FmtModifier = TI.getTypeFormatModifier(Ty);
188   for (const char *Fmt = IsSigned ? "di" : "ouxX"; *Fmt; ++Fmt) {
189     Builder.defineMacro(Prefix + "_FMT" + Twine(*Fmt) + "__",
190                         Twine("\"") + FmtModifier + Twine(*Fmt) + "\"");
191   }
192 }
193 
194 static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty,
195                        MacroBuilder &Builder) {
196   Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
197 }
198 
199 static void DefineTypeWidth(const Twine &MacroName, TargetInfo::IntType Ty,
200                             const TargetInfo &TI, MacroBuilder &Builder) {
201   Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty)));
202 }
203 
204 static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth,
205                              const TargetInfo &TI, MacroBuilder &Builder) {
206   Builder.defineMacro(MacroName,
207                       Twine(BitWidth / TI.getCharWidth()));
208 }
209 
210 // This will generate a macro based on the prefix with `_MAX__` as the suffix
211 // for the max value representable for the type, and a macro with a `_WIDTH__`
212 // suffix for the width of the type.
213 static void DefineTypeSizeAndWidth(const Twine &Prefix, TargetInfo::IntType Ty,
214                                    const TargetInfo &TI,
215                                    MacroBuilder &Builder) {
216   DefineTypeSize(Prefix + "_MAX__", Ty, TI, Builder);
217   DefineTypeWidth(Prefix + "_WIDTH__", Ty, TI, Builder);
218 }
219 
220 static void DefineExactWidthIntType(TargetInfo::IntType Ty,
221                                     const TargetInfo &TI,
222                                     MacroBuilder &Builder) {
223   int TypeWidth = TI.getTypeWidth(Ty);
224   bool IsSigned = TI.isTypeSigned(Ty);
225 
226   // Use the target specified int64 type, when appropriate, so that [u]int64_t
227   // ends up being defined in terms of the correct type.
228   if (TypeWidth == 64)
229     Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
230 
231   // Use the target specified int16 type when appropriate. Some MCU targets
232   // (such as AVR) have definition of [u]int16_t to [un]signed int.
233   if (TypeWidth == 16)
234     Ty = IsSigned ? TI.getInt16Type() : TI.getUInt16Type();
235 
236   const char *Prefix = IsSigned ? "__INT" : "__UINT";
237 
238   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
239   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
240 
241   StringRef ConstSuffix(TI.getTypeConstantSuffix(Ty));
242   Builder.defineMacro(Prefix + Twine(TypeWidth) + "_C_SUFFIX__", ConstSuffix);
243 }
244 
245 static void DefineExactWidthIntTypeSize(TargetInfo::IntType Ty,
246                                         const TargetInfo &TI,
247                                         MacroBuilder &Builder) {
248   int TypeWidth = TI.getTypeWidth(Ty);
249   bool IsSigned = TI.isTypeSigned(Ty);
250 
251   // Use the target specified int64 type, when appropriate, so that [u]int64_t
252   // ends up being defined in terms of the correct type.
253   if (TypeWidth == 64)
254     Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
255 
256   // We don't need to define a _WIDTH macro for the exact-width types because
257   // we already know the width.
258   const char *Prefix = IsSigned ? "__INT" : "__UINT";
259   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
260 }
261 
262 static void DefineLeastWidthIntType(unsigned TypeWidth, bool IsSigned,
263                                     const TargetInfo &TI,
264                                     MacroBuilder &Builder) {
265   TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
266   if (Ty == TargetInfo::NoInt)
267     return;
268 
269   const char *Prefix = IsSigned ? "__INT_LEAST" : "__UINT_LEAST";
270   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
271   // We only want the *_WIDTH macro for the signed types to avoid too many
272   // predefined macros (the unsigned width and the signed width are identical.)
273   if (IsSigned)
274     DefineTypeSizeAndWidth(Prefix + Twine(TypeWidth), Ty, TI, Builder);
275   else
276     DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
277   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
278 }
279 
280 static void DefineFastIntType(unsigned TypeWidth, bool IsSigned,
281                               const TargetInfo &TI, MacroBuilder &Builder) {
282   // stdint.h currently defines the fast int types as equivalent to the least
283   // types.
284   TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
285   if (Ty == TargetInfo::NoInt)
286     return;
287 
288   const char *Prefix = IsSigned ? "__INT_FAST" : "__UINT_FAST";
289   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
290   // We only want the *_WIDTH macro for the signed types to avoid too many
291   // predefined macros (the unsigned width and the signed width are identical.)
292   if (IsSigned)
293     DefineTypeSizeAndWidth(Prefix + Twine(TypeWidth), Ty, TI, Builder);
294   else
295     DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
296   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
297 }
298 
299 
300 /// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with
301 /// the specified properties.
302 static const char *getLockFreeValue(unsigned TypeWidth, const TargetInfo &TI) {
303   // Fully-aligned, power-of-2 sizes no larger than the inline
304   // width will be inlined as lock-free operations.
305   // Note: we do not need to check alignment since _Atomic(T) is always
306   // appropriately-aligned in clang.
307   if (TI.hasBuiltinAtomic(TypeWidth, TypeWidth))
308     return "2"; // "always lock free"
309   // We cannot be certain what operations the lib calls might be
310   // able to implement as lock-free on future processors.
311   return "1"; // "sometimes lock free"
312 }
313 
314 /// Add definitions required for a smooth interaction between
315 /// Objective-C++ automated reference counting and libstdc++ (4.2).
316 static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts,
317                                          MacroBuilder &Builder) {
318   Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR");
319 
320   std::string Result;
321   {
322     // Provide specializations for the __is_scalar type trait so that
323     // lifetime-qualified objects are not considered "scalar" types, which
324     // libstdc++ uses as an indicator of the presence of trivial copy, assign,
325     // default-construct, and destruct semantics (none of which hold for
326     // lifetime-qualified objects in ARC).
327     llvm::raw_string_ostream Out(Result);
328 
329     Out << "namespace std {\n"
330         << "\n"
331         << "struct __true_type;\n"
332         << "struct __false_type;\n"
333         << "\n";
334 
335     Out << "template<typename _Tp> struct __is_scalar;\n"
336         << "\n";
337 
338     if (LangOpts.ObjCAutoRefCount) {
339       Out << "template<typename _Tp>\n"
340           << "struct __is_scalar<__attribute__((objc_ownership(strong))) _Tp> {\n"
341           << "  enum { __value = 0 };\n"
342           << "  typedef __false_type __type;\n"
343           << "};\n"
344           << "\n";
345     }
346 
347     if (LangOpts.ObjCWeak) {
348       Out << "template<typename _Tp>\n"
349           << "struct __is_scalar<__attribute__((objc_ownership(weak))) _Tp> {\n"
350           << "  enum { __value = 0 };\n"
351           << "  typedef __false_type __type;\n"
352           << "};\n"
353           << "\n";
354     }
355 
356     if (LangOpts.ObjCAutoRefCount) {
357       Out << "template<typename _Tp>\n"
358           << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))"
359           << " _Tp> {\n"
360           << "  enum { __value = 0 };\n"
361           << "  typedef __false_type __type;\n"
362           << "};\n"
363           << "\n";
364     }
365 
366     Out << "}\n";
367   }
368   Builder.append(Result);
369 }
370 
371 static void InitializeStandardPredefinedMacros(const TargetInfo &TI,
372                                                const LangOptions &LangOpts,
373                                                const FrontendOptions &FEOpts,
374                                                MacroBuilder &Builder) {
375   if (LangOpts.HLSL) {
376     Builder.defineMacro("__hlsl_clang");
377     // HLSL Version
378     Builder.defineMacro("__HLSL_VERSION",
379                         Twine((unsigned)LangOpts.getHLSLVersion()));
380 
381     if (LangOpts.NativeHalfType)
382       Builder.defineMacro("__HLSL_ENABLE_16_BIT",
383                           Twine((unsigned)LangOpts.getHLSLVersion()));
384 
385     // Shader target information
386     // "enums" for shader stages
387     Builder.defineMacro("__SHADER_STAGE_VERTEX",
388                         Twine((uint32_t)ShaderStage::Vertex));
389     Builder.defineMacro("__SHADER_STAGE_PIXEL",
390                         Twine((uint32_t)ShaderStage::Pixel));
391     Builder.defineMacro("__SHADER_STAGE_GEOMETRY",
392                         Twine((uint32_t)ShaderStage::Geometry));
393     Builder.defineMacro("__SHADER_STAGE_HULL",
394                         Twine((uint32_t)ShaderStage::Hull));
395     Builder.defineMacro("__SHADER_STAGE_DOMAIN",
396                         Twine((uint32_t)ShaderStage::Domain));
397     Builder.defineMacro("__SHADER_STAGE_COMPUTE",
398                         Twine((uint32_t)ShaderStage::Compute));
399     Builder.defineMacro("__SHADER_STAGE_AMPLIFICATION",
400                         Twine((uint32_t)ShaderStage::Amplification));
401     Builder.defineMacro("__SHADER_STAGE_MESH",
402                         Twine((uint32_t)ShaderStage::Mesh));
403     Builder.defineMacro("__SHADER_STAGE_LIBRARY",
404                         Twine((uint32_t)ShaderStage::Library));
405     // The current shader stage itself
406     uint32_t StageInteger = static_cast<uint32_t>(
407         hlsl::getStageFromEnvironment(TI.getTriple().getEnvironment()));
408 
409     Builder.defineMacro("__SHADER_TARGET_STAGE", Twine(StageInteger));
410     // Add target versions
411     if (TI.getTriple().getOS() == llvm::Triple::ShaderModel) {
412       VersionTuple Version = TI.getTriple().getOSVersion();
413       Builder.defineMacro("__SHADER_TARGET_MAJOR", Twine(Version.getMajor()));
414       unsigned Minor = Version.getMinor().value_or(0);
415       Builder.defineMacro("__SHADER_TARGET_MINOR", Twine(Minor));
416     }
417     return;
418   }
419   // C++ [cpp.predefined]p1:
420   //   The following macro names shall be defined by the implementation:
421 
422   //   -- __STDC__
423   //      [C++] Whether __STDC__ is predefined and if so, what its value is,
424   //      are implementation-defined.
425   // (Removed in C++20.)
426   if (!LangOpts.MSVCCompat && !LangOpts.TraditionalCPP)
427     Builder.defineMacro("__STDC__");
428   //   -- __STDC_HOSTED__
429   //      The integer literal 1 if the implementation is a hosted
430   //      implementation or the integer literal 0 if it is not.
431   if (LangOpts.Freestanding)
432     Builder.defineMacro("__STDC_HOSTED__", "0");
433   else
434     Builder.defineMacro("__STDC_HOSTED__");
435 
436   //   -- __STDC_VERSION__
437   //      [C++] Whether __STDC_VERSION__ is predefined and if so, what its
438   //      value is, are implementation-defined.
439   // (Removed in C++20.)
440   if (!LangOpts.CPlusPlus) {
441     // FIXME: Use correct value for C23.
442     if (LangOpts.C2x)
443       Builder.defineMacro("__STDC_VERSION__", "202000L");
444     else if (LangOpts.C17)
445       Builder.defineMacro("__STDC_VERSION__", "201710L");
446     else if (LangOpts.C11)
447       Builder.defineMacro("__STDC_VERSION__", "201112L");
448     else if (LangOpts.C99)
449       Builder.defineMacro("__STDC_VERSION__", "199901L");
450     else if (!LangOpts.GNUMode && LangOpts.Digraphs)
451       Builder.defineMacro("__STDC_VERSION__", "199409L");
452   } else {
453     //   -- __cplusplus
454     if (LangOpts.CPlusPlus26)
455       // FIXME: Use correct value for C++26.
456       Builder.defineMacro("__cplusplus", "202400L");
457     else if (LangOpts.CPlusPlus23)
458       Builder.defineMacro("__cplusplus", "202302L");
459     //      [C++20] The integer literal 202002L.
460     else if (LangOpts.CPlusPlus20)
461       Builder.defineMacro("__cplusplus", "202002L");
462     //      [C++17] The integer literal 201703L.
463     else if (LangOpts.CPlusPlus17)
464       Builder.defineMacro("__cplusplus", "201703L");
465     //      [C++14] The name __cplusplus is defined to the value 201402L when
466     //      compiling a C++ translation unit.
467     else if (LangOpts.CPlusPlus14)
468       Builder.defineMacro("__cplusplus", "201402L");
469     //      [C++11] The name __cplusplus is defined to the value 201103L when
470     //      compiling a C++ translation unit.
471     else if (LangOpts.CPlusPlus11)
472       Builder.defineMacro("__cplusplus", "201103L");
473     //      [C++03] The name __cplusplus is defined to the value 199711L when
474     //      compiling a C++ translation unit.
475     else
476       Builder.defineMacro("__cplusplus", "199711L");
477 
478     //   -- __STDCPP_DEFAULT_NEW_ALIGNMENT__
479     //      [C++17] An integer literal of type std::size_t whose value is the
480     //      alignment guaranteed by a call to operator new(std::size_t)
481     //
482     // We provide this in all language modes, since it seems generally useful.
483     Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__",
484                         Twine(TI.getNewAlign() / TI.getCharWidth()) +
485                             TI.getTypeConstantSuffix(TI.getSizeType()));
486 
487     //   -- __STDCPP_­THREADS__
488     //      Defined, and has the value integer literal 1, if and only if a
489     //      program can have more than one thread of execution.
490     if (LangOpts.getThreadModel() == LangOptions::ThreadModelKind::POSIX)
491       Builder.defineMacro("__STDCPP_THREADS__", "1");
492   }
493 
494   // In C11 these are environment macros. In C++11 they are only defined
495   // as part of <cuchar>. To prevent breakage when mixing C and C++
496   // code, define these macros unconditionally. We can define them
497   // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
498   // and 32-bit character literals.
499   Builder.defineMacro("__STDC_UTF_16__", "1");
500   Builder.defineMacro("__STDC_UTF_32__", "1");
501 
502   if (LangOpts.ObjC)
503     Builder.defineMacro("__OBJC__");
504 
505   // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros.
506   if (LangOpts.OpenCL) {
507     if (LangOpts.CPlusPlus) {
508       switch (LangOpts.OpenCLCPlusPlusVersion) {
509       case 100:
510         Builder.defineMacro("__OPENCL_CPP_VERSION__", "100");
511         break;
512       case 202100:
513         Builder.defineMacro("__OPENCL_CPP_VERSION__", "202100");
514         break;
515       default:
516         llvm_unreachable("Unsupported C++ version for OpenCL");
517       }
518       Builder.defineMacro("__CL_CPP_VERSION_1_0__", "100");
519       Builder.defineMacro("__CL_CPP_VERSION_2021__", "202100");
520     } else {
521       // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the
522       // language standard with which the program is compiled. __OPENCL_VERSION__
523       // is for the OpenCL version supported by the OpenCL device, which is not
524       // necessarily the language standard with which the program is compiled.
525       // A shared OpenCL header file requires a macro to indicate the language
526       // standard. As a workaround, __OPENCL_C_VERSION__ is defined for
527       // OpenCL v1.0 and v1.1.
528       switch (LangOpts.OpenCLVersion) {
529       case 100:
530         Builder.defineMacro("__OPENCL_C_VERSION__", "100");
531         break;
532       case 110:
533         Builder.defineMacro("__OPENCL_C_VERSION__", "110");
534         break;
535       case 120:
536         Builder.defineMacro("__OPENCL_C_VERSION__", "120");
537         break;
538       case 200:
539         Builder.defineMacro("__OPENCL_C_VERSION__", "200");
540         break;
541       case 300:
542         Builder.defineMacro("__OPENCL_C_VERSION__", "300");
543         break;
544       default:
545         llvm_unreachable("Unsupported OpenCL version");
546       }
547     }
548     Builder.defineMacro("CL_VERSION_1_0", "100");
549     Builder.defineMacro("CL_VERSION_1_1", "110");
550     Builder.defineMacro("CL_VERSION_1_2", "120");
551     Builder.defineMacro("CL_VERSION_2_0", "200");
552     Builder.defineMacro("CL_VERSION_3_0", "300");
553 
554     if (TI.isLittleEndian())
555       Builder.defineMacro("__ENDIAN_LITTLE__");
556 
557     if (LangOpts.FastRelaxedMath)
558       Builder.defineMacro("__FAST_RELAXED_MATH__");
559   }
560 
561   if (LangOpts.SYCLIsDevice || LangOpts.SYCLIsHost) {
562     // SYCL Version is set to a value when building SYCL applications
563     if (LangOpts.getSYCLVersion() == LangOptions::SYCL_2017)
564       Builder.defineMacro("CL_SYCL_LANGUAGE_VERSION", "121");
565     else if (LangOpts.getSYCLVersion() == LangOptions::SYCL_2020)
566       Builder.defineMacro("SYCL_LANGUAGE_VERSION", "202001");
567   }
568 
569   // Not "standard" per se, but available even with the -undef flag.
570   if (LangOpts.AsmPreprocessor)
571     Builder.defineMacro("__ASSEMBLER__");
572   if (LangOpts.CUDA) {
573     if (LangOpts.GPURelocatableDeviceCode)
574       Builder.defineMacro("__CLANG_RDC__");
575     if (!LangOpts.HIP)
576       Builder.defineMacro("__CUDA__");
577     if (LangOpts.GPUDefaultStream ==
578         LangOptions::GPUDefaultStreamKind::PerThread)
579       Builder.defineMacro("CUDA_API_PER_THREAD_DEFAULT_STREAM");
580   }
581   if (LangOpts.HIP) {
582     Builder.defineMacro("__HIP__");
583     Builder.defineMacro("__HIPCC__");
584     Builder.defineMacro("__HIP_MEMORY_SCOPE_SINGLETHREAD", "1");
585     Builder.defineMacro("__HIP_MEMORY_SCOPE_WAVEFRONT", "2");
586     Builder.defineMacro("__HIP_MEMORY_SCOPE_WORKGROUP", "3");
587     Builder.defineMacro("__HIP_MEMORY_SCOPE_AGENT", "4");
588     Builder.defineMacro("__HIP_MEMORY_SCOPE_SYSTEM", "5");
589     if (LangOpts.CUDAIsDevice) {
590       Builder.defineMacro("__HIP_DEVICE_COMPILE__");
591       if (!TI.hasHIPImageSupport()) {
592         Builder.defineMacro("__HIP_NO_IMAGE_SUPPORT__", "1");
593         // Deprecated.
594         Builder.defineMacro("__HIP_NO_IMAGE_SUPPORT", "1");
595       }
596     }
597     if (LangOpts.GPUDefaultStream ==
598         LangOptions::GPUDefaultStreamKind::PerThread) {
599       Builder.defineMacro("__HIP_API_PER_THREAD_DEFAULT_STREAM__");
600       // Deprecated.
601       Builder.defineMacro("HIP_API_PER_THREAD_DEFAULT_STREAM");
602     }
603   }
604 }
605 
606 /// Initialize the predefined C++ language feature test macros defined in
607 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
608 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
609                                                  MacroBuilder &Builder) {
610   // C++98 features.
611   if (LangOpts.RTTI)
612     Builder.defineMacro("__cpp_rtti", "199711L");
613   if (LangOpts.CXXExceptions)
614     Builder.defineMacro("__cpp_exceptions", "199711L");
615 
616   // C++11 features.
617   if (LangOpts.CPlusPlus11) {
618     Builder.defineMacro("__cpp_unicode_characters", "200704L");
619     Builder.defineMacro("__cpp_raw_strings", "200710L");
620     Builder.defineMacro("__cpp_unicode_literals", "200710L");
621     Builder.defineMacro("__cpp_user_defined_literals", "200809L");
622     Builder.defineMacro("__cpp_lambdas", "200907L");
623     Builder.defineMacro("__cpp_constexpr", LangOpts.CPlusPlus26   ? "202306L"
624                                            : LangOpts.CPlusPlus23 ? "202211L"
625                                            : LangOpts.CPlusPlus20 ? "201907L"
626                                            : LangOpts.CPlusPlus17 ? "201603L"
627                                            : LangOpts.CPlusPlus14 ? "201304L"
628                                                                   : "200704");
629     Builder.defineMacro("__cpp_constexpr_in_decltype", "201711L");
630     Builder.defineMacro("__cpp_range_based_for",
631                         LangOpts.CPlusPlus17 ? "201603L" : "200907");
632     Builder.defineMacro("__cpp_static_assert",
633                         LangOpts.CPlusPlus17 ? "201411L" : "200410");
634     Builder.defineMacro("__cpp_decltype", "200707L");
635     Builder.defineMacro("__cpp_attributes", "200809L");
636     Builder.defineMacro("__cpp_rvalue_references", "200610L");
637     Builder.defineMacro("__cpp_variadic_templates", "200704L");
638     Builder.defineMacro("__cpp_initializer_lists", "200806L");
639     Builder.defineMacro("__cpp_delegating_constructors", "200604L");
640     Builder.defineMacro("__cpp_nsdmi", "200809L");
641     Builder.defineMacro("__cpp_inheriting_constructors", "201511L");
642     Builder.defineMacro("__cpp_ref_qualifiers", "200710L");
643     Builder.defineMacro("__cpp_alias_templates", "200704L");
644   }
645   if (LangOpts.ThreadsafeStatics)
646     Builder.defineMacro("__cpp_threadsafe_static_init", "200806L");
647 
648   // C++14 features.
649   if (LangOpts.CPlusPlus14) {
650     Builder.defineMacro("__cpp_binary_literals", "201304L");
651     Builder.defineMacro("__cpp_digit_separators", "201309L");
652     Builder.defineMacro("__cpp_init_captures",
653                         LangOpts.CPlusPlus20 ? "201803L" : "201304L");
654     Builder.defineMacro("__cpp_generic_lambdas",
655                         LangOpts.CPlusPlus20 ? "201707L" : "201304L");
656     Builder.defineMacro("__cpp_decltype_auto", "201304L");
657     Builder.defineMacro("__cpp_return_type_deduction", "201304L");
658     Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L");
659     Builder.defineMacro("__cpp_variable_templates", "201304L");
660   }
661   if (LangOpts.SizedDeallocation)
662     Builder.defineMacro("__cpp_sized_deallocation", "201309L");
663 
664   // C++17 features.
665   if (LangOpts.CPlusPlus17) {
666     Builder.defineMacro("__cpp_hex_float", "201603L");
667     Builder.defineMacro("__cpp_inline_variables", "201606L");
668     Builder.defineMacro("__cpp_noexcept_function_type", "201510L");
669     Builder.defineMacro("__cpp_capture_star_this", "201603L");
670     Builder.defineMacro("__cpp_if_constexpr", "201606L");
671     Builder.defineMacro("__cpp_deduction_guides", "201703L"); // (not latest)
672     Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name)
673     Builder.defineMacro("__cpp_namespace_attributes", "201411L");
674     Builder.defineMacro("__cpp_enumerator_attributes", "201411L");
675     Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L");
676     Builder.defineMacro("__cpp_variadic_using", "201611L");
677     Builder.defineMacro("__cpp_aggregate_bases", "201603L");
678     Builder.defineMacro("__cpp_structured_bindings", "201606L");
679     Builder.defineMacro("__cpp_nontype_template_args",
680                         "201411L"); // (not latest)
681     Builder.defineMacro("__cpp_fold_expressions", "201603L");
682     Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L");
683     Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L");
684   }
685   if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable)
686     Builder.defineMacro("__cpp_aligned_new", "201606L");
687   if (LangOpts.RelaxedTemplateTemplateArgs)
688     Builder.defineMacro("__cpp_template_template_args", "201611L");
689 
690   // C++20 features.
691   if (LangOpts.CPlusPlus20) {
692     Builder.defineMacro("__cpp_aggregate_paren_init", "201902L");
693 
694     // P0848 is implemented, but we're still waiting for other concepts
695     // issues to be addressed before bumping __cpp_concepts up to 202002L.
696     // Refer to the discussion of this at https://reviews.llvm.org/D128619.
697     Builder.defineMacro("__cpp_concepts", "201907L");
698     Builder.defineMacro("__cpp_conditional_explicit", "201806L");
699     Builder.defineMacro("__cpp_consteval", "202211L");
700     Builder.defineMacro("__cpp_constexpr_dynamic_alloc", "201907L");
701     Builder.defineMacro("__cpp_constinit", "201907L");
702     Builder.defineMacro("__cpp_impl_coroutine", "201902L");
703     Builder.defineMacro("__cpp_designated_initializers", "201707L");
704     Builder.defineMacro("__cpp_impl_three_way_comparison", "201907L");
705     //Builder.defineMacro("__cpp_modules", "201907L");
706     Builder.defineMacro("__cpp_using_enum", "201907L");
707   }
708   // C++23 features.
709   if (LangOpts.CPlusPlus23) {
710     Builder.defineMacro("__cpp_implicit_move", "202011L");
711     Builder.defineMacro("__cpp_size_t_suffix", "202011L");
712     Builder.defineMacro("__cpp_if_consteval", "202106L");
713     Builder.defineMacro("__cpp_multidimensional_subscript", "202211L");
714   }
715 
716   // We provide those C++23 features as extensions in earlier language modes, so
717   // we also define their feature test macros.
718   if (LangOpts.CPlusPlus11)
719     Builder.defineMacro("__cpp_static_call_operator", "202207L");
720   Builder.defineMacro("__cpp_named_character_escapes", "202207L");
721 
722   if (LangOpts.Char8)
723     Builder.defineMacro("__cpp_char8_t", "202207L");
724   Builder.defineMacro("__cpp_impl_destroying_delete", "201806L");
725 }
726 
727 /// InitializeOpenCLFeatureTestMacros - Define OpenCL macros based on target
728 /// settings and language version
729 void InitializeOpenCLFeatureTestMacros(const TargetInfo &TI,
730                                        const LangOptions &Opts,
731                                        MacroBuilder &Builder) {
732   const llvm::StringMap<bool> &OpenCLFeaturesMap = TI.getSupportedOpenCLOpts();
733   // FIXME: OpenCL options which affect language semantics/syntax
734   // should be moved into LangOptions.
735   auto defineOpenCLExtMacro = [&](llvm::StringRef Name, auto... OptArgs) {
736     // Check if extension is supported by target and is available in this
737     // OpenCL version
738     if (TI.hasFeatureEnabled(OpenCLFeaturesMap, Name) &&
739         OpenCLOptions::isOpenCLOptionAvailableIn(Opts, OptArgs...))
740       Builder.defineMacro(Name);
741   };
742 #define OPENCL_GENERIC_EXTENSION(Ext, ...)                                     \
743   defineOpenCLExtMacro(#Ext, __VA_ARGS__);
744 #include "clang/Basic/OpenCLExtensions.def"
745 
746   // Assume compiling for FULL profile
747   Builder.defineMacro("__opencl_c_int64");
748 }
749 
750 static void InitializePredefinedMacros(const TargetInfo &TI,
751                                        const LangOptions &LangOpts,
752                                        const FrontendOptions &FEOpts,
753                                        const PreprocessorOptions &PPOpts,
754                                        MacroBuilder &Builder) {
755   // Compiler version introspection macros.
756   Builder.defineMacro("__llvm__");  // LLVM Backend
757   Builder.defineMacro("__clang__"); // Clang Frontend
758 #define TOSTR2(X) #X
759 #define TOSTR(X) TOSTR2(X)
760   Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
761   Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
762   Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
763 #undef TOSTR
764 #undef TOSTR2
765   Builder.defineMacro("__clang_version__",
766                       "\"" CLANG_VERSION_STRING " "
767                       + getClangFullRepositoryVersion() + "\"");
768 
769   if (LangOpts.GNUCVersion != 0) {
770     // Major, minor, patch, are given two decimal places each, so 4.2.1 becomes
771     // 40201.
772     unsigned GNUCMajor = LangOpts.GNUCVersion / 100 / 100;
773     unsigned GNUCMinor = LangOpts.GNUCVersion / 100 % 100;
774     unsigned GNUCPatch = LangOpts.GNUCVersion % 100;
775     Builder.defineMacro("__GNUC__", Twine(GNUCMajor));
776     Builder.defineMacro("__GNUC_MINOR__", Twine(GNUCMinor));
777     Builder.defineMacro("__GNUC_PATCHLEVEL__", Twine(GNUCPatch));
778     Builder.defineMacro("__GXX_ABI_VERSION", "1002");
779 
780     if (LangOpts.CPlusPlus) {
781       Builder.defineMacro("__GNUG__", Twine(GNUCMajor));
782       Builder.defineMacro("__GXX_WEAK__");
783     }
784   }
785 
786   // Define macros for the C11 / C++11 memory orderings
787   Builder.defineMacro("__ATOMIC_RELAXED", "0");
788   Builder.defineMacro("__ATOMIC_CONSUME", "1");
789   Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
790   Builder.defineMacro("__ATOMIC_RELEASE", "3");
791   Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
792   Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
793 
794   // Define macros for the OpenCL memory scope.
795   // The values should match AtomicScopeOpenCLModel::ID enum.
796   static_assert(
797       static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 &&
798           static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 &&
799           static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 &&
800           static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4,
801       "Invalid OpenCL memory scope enum definition");
802   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0");
803   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1");
804   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2");
805   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3");
806   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4");
807 
808   // Define macros for floating-point data classes, used in __builtin_isfpclass.
809   Builder.defineMacro("__FPCLASS_SNAN", "0x0001");
810   Builder.defineMacro("__FPCLASS_QNAN", "0x0002");
811   Builder.defineMacro("__FPCLASS_NEGINF", "0x0004");
812   Builder.defineMacro("__FPCLASS_NEGNORMAL", "0x0008");
813   Builder.defineMacro("__FPCLASS_NEGSUBNORMAL", "0x0010");
814   Builder.defineMacro("__FPCLASS_NEGZERO", "0x0020");
815   Builder.defineMacro("__FPCLASS_POSZERO", "0x0040");
816   Builder.defineMacro("__FPCLASS_POSSUBNORMAL", "0x0080");
817   Builder.defineMacro("__FPCLASS_POSNORMAL", "0x0100");
818   Builder.defineMacro("__FPCLASS_POSINF", "0x0200");
819 
820   // Support for #pragma redefine_extname (Sun compatibility)
821   Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
822 
823   // Previously this macro was set to a string aiming to achieve compatibility
824   // with GCC 4.2.1. Now, just return the full Clang version
825   Builder.defineMacro("__VERSION__", "\"" +
826                       Twine(getClangFullCPPVersion()) + "\"");
827 
828   // Initialize language-specific preprocessor defines.
829 
830   // Standard conforming mode?
831   if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
832     Builder.defineMacro("__STRICT_ANSI__");
833 
834   if (LangOpts.GNUCVersion && LangOpts.CPlusPlus11)
835     Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
836 
837   if (LangOpts.ObjC) {
838     if (LangOpts.ObjCRuntime.isNonFragile()) {
839       Builder.defineMacro("__OBJC2__");
840 
841       if (LangOpts.ObjCExceptions)
842         Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
843     }
844 
845     if (LangOpts.getGC() != LangOptions::NonGC)
846       Builder.defineMacro("__OBJC_GC__");
847 
848     if (LangOpts.ObjCRuntime.isNeXTFamily())
849       Builder.defineMacro("__NEXT_RUNTIME__");
850 
851     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) {
852       auto version = LangOpts.ObjCRuntime.getVersion();
853       std::string versionString = "1";
854       // Don't rely on the tuple argument, because we can be asked to target
855       // later ABIs than we actually support, so clamp these values to those
856       // currently supported
857       if (version >= VersionTuple(2, 0))
858         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", "20");
859       else
860         Builder.defineMacro(
861             "__OBJC_GNUSTEP_RUNTIME_ABI__",
862             "1" + Twine(std::min(8U, version.getMinor().value_or(0))));
863     }
864 
865     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
866       VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
867       unsigned minor = tuple.getMinor().value_or(0);
868       unsigned subminor = tuple.getSubminor().value_or(0);
869       Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
870                           Twine(tuple.getMajor() * 10000 + minor * 100 +
871                                 subminor));
872     }
873 
874     Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
875     Builder.defineMacro("IBOutletCollection(ClassName)",
876                         "__attribute__((iboutletcollection(ClassName)))");
877     Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
878     Builder.defineMacro("IBInspectable", "");
879     Builder.defineMacro("IB_DESIGNABLE", "");
880   }
881 
882   // Define a macro that describes the Objective-C boolean type even for C
883   // and C++ since BOOL can be used from non Objective-C code.
884   Builder.defineMacro("__OBJC_BOOL_IS_BOOL",
885                       Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
886 
887   if (LangOpts.CPlusPlus)
888     InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
889 
890   // darwin_constant_cfstrings controls this. This is also dependent
891   // on other things like the runtime I believe.  This is set even for C code.
892   if (!LangOpts.NoConstantCFStrings)
893       Builder.defineMacro("__CONSTANT_CFSTRINGS__");
894 
895   if (LangOpts.ObjC)
896     Builder.defineMacro("OBJC_NEW_PROPERTIES");
897 
898   if (LangOpts.PascalStrings)
899     Builder.defineMacro("__PASCAL_STRINGS__");
900 
901   if (LangOpts.Blocks) {
902     Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
903     Builder.defineMacro("__BLOCKS__");
904   }
905 
906   if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
907     Builder.defineMacro("__EXCEPTIONS");
908   if (LangOpts.GNUCVersion && LangOpts.RTTI)
909     Builder.defineMacro("__GXX_RTTI");
910 
911   if (LangOpts.hasSjLjExceptions())
912     Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
913   else if (LangOpts.hasSEHExceptions())
914     Builder.defineMacro("__SEH__");
915   else if (LangOpts.hasDWARFExceptions() &&
916            (TI.getTriple().isThumb() || TI.getTriple().isARM()))
917     Builder.defineMacro("__ARM_DWARF_EH__");
918 
919   if (LangOpts.Deprecated)
920     Builder.defineMacro("__DEPRECATED");
921 
922   if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus)
923     Builder.defineMacro("__private_extern__", "extern");
924 
925   if (LangOpts.MicrosoftExt) {
926     if (LangOpts.WChar) {
927       // wchar_t supported as a keyword.
928       Builder.defineMacro("_WCHAR_T_DEFINED");
929       Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
930     }
931   }
932 
933   // Macros to help identify the narrow and wide character sets
934   // FIXME: clang currently ignores -fexec-charset=. If this changes,
935   // then this may need to be updated.
936   Builder.defineMacro("__clang_literal_encoding__", "\"UTF-8\"");
937   if (TI.getTypeWidth(TI.getWCharType()) >= 32) {
938     // FIXME: 32-bit wchar_t signals UTF-32. This may change
939     // if -fwide-exec-charset= is ever supported.
940     Builder.defineMacro("__clang_wide_literal_encoding__", "\"UTF-32\"");
941   } else {
942     // FIXME: Less-than 32-bit wchar_t generally means UTF-16
943     // (e.g., Windows, 32-bit IBM). This may need to be
944     // updated if -fwide-exec-charset= is ever supported.
945     Builder.defineMacro("__clang_wide_literal_encoding__", "\"UTF-16\"");
946   }
947 
948   if (LangOpts.Optimize)
949     Builder.defineMacro("__OPTIMIZE__");
950   if (LangOpts.OptimizeSize)
951     Builder.defineMacro("__OPTIMIZE_SIZE__");
952 
953   if (LangOpts.FastMath)
954     Builder.defineMacro("__FAST_MATH__");
955 
956   // Initialize target-specific preprocessor defines.
957 
958   // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
959   // to the macro __BYTE_ORDER (no trailing underscores)
960   // from glibc's <endian.h> header.
961   // We don't support the PDP-11 as a target, but include
962   // the define so it can still be compared against.
963   Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
964   Builder.defineMacro("__ORDER_BIG_ENDIAN__",    "4321");
965   Builder.defineMacro("__ORDER_PDP_ENDIAN__",    "3412");
966   if (TI.isBigEndian()) {
967     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
968     Builder.defineMacro("__BIG_ENDIAN__");
969   } else {
970     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
971     Builder.defineMacro("__LITTLE_ENDIAN__");
972   }
973 
974   if (TI.getPointerWidth(LangAS::Default) == 64 && TI.getLongWidth() == 64 &&
975       TI.getIntWidth() == 32) {
976     Builder.defineMacro("_LP64");
977     Builder.defineMacro("__LP64__");
978   }
979 
980   if (TI.getPointerWidth(LangAS::Default) == 32 && TI.getLongWidth() == 32 &&
981       TI.getIntWidth() == 32) {
982     Builder.defineMacro("_ILP32");
983     Builder.defineMacro("__ILP32__");
984   }
985 
986   // Define type sizing macros based on the target properties.
987   assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
988   Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth()));
989 
990   Builder.defineMacro("__BOOL_WIDTH__", Twine(TI.getBoolWidth()));
991   Builder.defineMacro("__SHRT_WIDTH__", Twine(TI.getShortWidth()));
992   Builder.defineMacro("__INT_WIDTH__", Twine(TI.getIntWidth()));
993   Builder.defineMacro("__LONG_WIDTH__", Twine(TI.getLongWidth()));
994   Builder.defineMacro("__LLONG_WIDTH__", Twine(TI.getLongLongWidth()));
995 
996   size_t BitIntMaxWidth = TI.getMaxBitIntWidth();
997   assert(BitIntMaxWidth <= llvm::IntegerType::MAX_INT_BITS &&
998          "Target defined a max bit width larger than LLVM can support!");
999   assert(BitIntMaxWidth >= TI.getLongLongWidth() &&
1000          "Target defined a max bit width smaller than the C standard allows!");
1001   Builder.defineMacro("__BITINT_MAXWIDTH__", Twine(BitIntMaxWidth));
1002 
1003   DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
1004   DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
1005   DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
1006   DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
1007   DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
1008   DefineTypeSizeAndWidth("__WCHAR", TI.getWCharType(), TI, Builder);
1009   DefineTypeSizeAndWidth("__WINT", TI.getWIntType(), TI, Builder);
1010   DefineTypeSizeAndWidth("__INTMAX", TI.getIntMaxType(), TI, Builder);
1011   DefineTypeSizeAndWidth("__SIZE", TI.getSizeType(), TI, Builder);
1012 
1013   DefineTypeSizeAndWidth("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
1014   DefineTypeSizeAndWidth("__PTRDIFF", TI.getPtrDiffType(LangAS::Default), TI,
1015                          Builder);
1016   DefineTypeSizeAndWidth("__INTPTR", TI.getIntPtrType(), TI, Builder);
1017   DefineTypeSizeAndWidth("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
1018 
1019   DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
1020   DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
1021   DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
1022   DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
1023   DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
1024   DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
1025   DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(LangAS::Default),
1026                    TI, Builder);
1027   DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
1028   DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
1029                    TI.getTypeWidth(TI.getPtrDiffType(LangAS::Default)), TI,
1030                    Builder);
1031   DefineTypeSizeof("__SIZEOF_SIZE_T__",
1032                    TI.getTypeWidth(TI.getSizeType()), TI, Builder);
1033   DefineTypeSizeof("__SIZEOF_WCHAR_T__",
1034                    TI.getTypeWidth(TI.getWCharType()), TI, Builder);
1035   DefineTypeSizeof("__SIZEOF_WINT_T__",
1036                    TI.getTypeWidth(TI.getWIntType()), TI, Builder);
1037   if (TI.hasInt128Type())
1038     DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
1039 
1040   DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
1041   DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder);
1042   Builder.defineMacro("__INTMAX_C_SUFFIX__",
1043                       TI.getTypeConstantSuffix(TI.getIntMaxType()));
1044   DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
1045   DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
1046   Builder.defineMacro("__UINTMAX_C_SUFFIX__",
1047                       TI.getTypeConstantSuffix(TI.getUIntMaxType()));
1048   DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(LangAS::Default), Builder);
1049   DefineFmt("__PTRDIFF", TI.getPtrDiffType(LangAS::Default), TI, Builder);
1050   DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
1051   DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder);
1052   DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
1053   DefineFmt("__SIZE", TI.getSizeType(), TI, Builder);
1054   DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
1055   DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
1056   DefineTypeSizeAndWidth("__SIG_ATOMIC", TI.getSigAtomicType(), TI, Builder);
1057   DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
1058   DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
1059 
1060   DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder);
1061   DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
1062 
1063   // The C standard requires the width of uintptr_t and intptr_t to be the same,
1064   // per 7.20.2.4p1. Same for intmax_t and uintmax_t, per 7.20.2.5p1.
1065   assert(TI.getTypeWidth(TI.getUIntPtrType()) ==
1066              TI.getTypeWidth(TI.getIntPtrType()) &&
1067          "uintptr_t and intptr_t have different widths?");
1068   assert(TI.getTypeWidth(TI.getUIntMaxType()) ==
1069              TI.getTypeWidth(TI.getIntMaxType()) &&
1070          "uintmax_t and intmax_t have different widths?");
1071 
1072   if (TI.hasFloat16Type())
1073     DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16");
1074   DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
1075   DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
1076   DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
1077 
1078   // Define a __POINTER_WIDTH__ macro for stdint.h.
1079   Builder.defineMacro("__POINTER_WIDTH__",
1080                       Twine((int)TI.getPointerWidth(LangAS::Default)));
1081 
1082   // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
1083   Builder.defineMacro("__BIGGEST_ALIGNMENT__",
1084                       Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
1085 
1086   if (!LangOpts.CharIsSigned)
1087     Builder.defineMacro("__CHAR_UNSIGNED__");
1088 
1089   if (!TargetInfo::isTypeSigned(TI.getWCharType()))
1090     Builder.defineMacro("__WCHAR_UNSIGNED__");
1091 
1092   if (!TargetInfo::isTypeSigned(TI.getWIntType()))
1093     Builder.defineMacro("__WINT_UNSIGNED__");
1094 
1095   // Define exact-width integer types for stdint.h
1096   DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder);
1097 
1098   if (TI.getShortWidth() > TI.getCharWidth())
1099     DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
1100 
1101   if (TI.getIntWidth() > TI.getShortWidth())
1102     DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
1103 
1104   if (TI.getLongWidth() > TI.getIntWidth())
1105     DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
1106 
1107   if (TI.getLongLongWidth() > TI.getLongWidth())
1108     DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
1109 
1110   DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder);
1111   DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder);
1112   DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder);
1113 
1114   if (TI.getShortWidth() > TI.getCharWidth()) {
1115     DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder);
1116     DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder);
1117     DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder);
1118   }
1119 
1120   if (TI.getIntWidth() > TI.getShortWidth()) {
1121     DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder);
1122     DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder);
1123     DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder);
1124   }
1125 
1126   if (TI.getLongWidth() > TI.getIntWidth()) {
1127     DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder);
1128     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder);
1129     DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder);
1130   }
1131 
1132   if (TI.getLongLongWidth() > TI.getLongWidth()) {
1133     DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder);
1134     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder);
1135     DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder);
1136   }
1137 
1138   DefineLeastWidthIntType(8, true, TI, Builder);
1139   DefineLeastWidthIntType(8, false, TI, Builder);
1140   DefineLeastWidthIntType(16, true, TI, Builder);
1141   DefineLeastWidthIntType(16, false, TI, Builder);
1142   DefineLeastWidthIntType(32, true, TI, Builder);
1143   DefineLeastWidthIntType(32, false, TI, Builder);
1144   DefineLeastWidthIntType(64, true, TI, Builder);
1145   DefineLeastWidthIntType(64, false, TI, Builder);
1146 
1147   DefineFastIntType(8, true, TI, Builder);
1148   DefineFastIntType(8, false, TI, Builder);
1149   DefineFastIntType(16, true, TI, Builder);
1150   DefineFastIntType(16, false, TI, Builder);
1151   DefineFastIntType(32, true, TI, Builder);
1152   DefineFastIntType(32, false, TI, Builder);
1153   DefineFastIntType(64, true, TI, Builder);
1154   DefineFastIntType(64, false, TI, Builder);
1155 
1156   Builder.defineMacro("__USER_LABEL_PREFIX__", TI.getUserLabelPrefix());
1157 
1158   if (!LangOpts.MathErrno)
1159     Builder.defineMacro("__NO_MATH_ERRNO__");
1160 
1161   if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
1162     Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
1163   else
1164     Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
1165 
1166   if (LangOpts.GNUCVersion) {
1167     if (LangOpts.GNUInline || LangOpts.CPlusPlus)
1168       Builder.defineMacro("__GNUC_GNU_INLINE__");
1169     else
1170       Builder.defineMacro("__GNUC_STDC_INLINE__");
1171 
1172     // The value written by __atomic_test_and_set.
1173     // FIXME: This is target-dependent.
1174     Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
1175   }
1176 
1177   auto addLockFreeMacros = [&](const llvm::Twine &Prefix) {
1178     // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
1179 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type)                                     \
1180   Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE",                             \
1181                       getLockFreeValue(TI.get##Type##Width(), TI));
1182     DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
1183     DEFINE_LOCK_FREE_MACRO(CHAR, Char);
1184     if (LangOpts.Char8)
1185       DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char.
1186     DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
1187     DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
1188     DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
1189     DEFINE_LOCK_FREE_MACRO(SHORT, Short);
1190     DEFINE_LOCK_FREE_MACRO(INT, Int);
1191     DEFINE_LOCK_FREE_MACRO(LONG, Long);
1192     DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
1193     Builder.defineMacro(
1194         Prefix + "POINTER_LOCK_FREE",
1195         getLockFreeValue(TI.getPointerWidth(LangAS::Default), TI));
1196 #undef DEFINE_LOCK_FREE_MACRO
1197   };
1198   addLockFreeMacros("__CLANG_ATOMIC_");
1199   if (LangOpts.GNUCVersion)
1200     addLockFreeMacros("__GCC_ATOMIC_");
1201 
1202   if (LangOpts.NoInlineDefine)
1203     Builder.defineMacro("__NO_INLINE__");
1204 
1205   if (unsigned PICLevel = LangOpts.PICLevel) {
1206     Builder.defineMacro("__PIC__", Twine(PICLevel));
1207     Builder.defineMacro("__pic__", Twine(PICLevel));
1208     if (LangOpts.PIE) {
1209       Builder.defineMacro("__PIE__", Twine(PICLevel));
1210       Builder.defineMacro("__pie__", Twine(PICLevel));
1211     }
1212   }
1213 
1214   // Macros to control C99 numerics and <float.h>
1215   Builder.defineMacro("__FLT_RADIX__", "2");
1216   Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__");
1217 
1218   if (LangOpts.getStackProtector() == LangOptions::SSPOn)
1219     Builder.defineMacro("__SSP__");
1220   else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
1221     Builder.defineMacro("__SSP_STRONG__", "2");
1222   else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
1223     Builder.defineMacro("__SSP_ALL__", "3");
1224 
1225   if (PPOpts.SetUpStaticAnalyzer)
1226     Builder.defineMacro("__clang_analyzer__");
1227 
1228   if (LangOpts.FastRelaxedMath)
1229     Builder.defineMacro("__FAST_RELAXED_MATH__");
1230 
1231   if (FEOpts.ProgramAction == frontend::RewriteObjC ||
1232       LangOpts.getGC() != LangOptions::NonGC) {
1233     Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
1234     Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))");
1235     Builder.defineMacro("__autoreleasing", "");
1236     Builder.defineMacro("__unsafe_unretained", "");
1237   } else if (LangOpts.ObjC) {
1238     Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
1239     Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
1240     Builder.defineMacro("__autoreleasing",
1241                         "__attribute__((objc_ownership(autoreleasing)))");
1242     Builder.defineMacro("__unsafe_unretained",
1243                         "__attribute__((objc_ownership(none)))");
1244   }
1245 
1246   // On Darwin, there are __double_underscored variants of the type
1247   // nullability qualifiers.
1248   if (TI.getTriple().isOSDarwin()) {
1249     Builder.defineMacro("__nonnull", "_Nonnull");
1250     Builder.defineMacro("__null_unspecified", "_Null_unspecified");
1251     Builder.defineMacro("__nullable", "_Nullable");
1252   }
1253 
1254   // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and
1255   // the corresponding simulator targets.
1256   if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment())
1257     Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1");
1258 
1259   // OpenMP definition
1260   // OpenMP 2.2:
1261   //   In implementations that support a preprocessor, the _OPENMP
1262   //   macro name is defined to have the decimal value yyyymm where
1263   //   yyyy and mm are the year and the month designations of the
1264   //   version of the OpenMP API that the implementation support.
1265   if (!LangOpts.OpenMPSimd) {
1266     switch (LangOpts.OpenMP) {
1267     case 0:
1268       break;
1269     case 31:
1270       Builder.defineMacro("_OPENMP", "201107");
1271       break;
1272     case 40:
1273       Builder.defineMacro("_OPENMP", "201307");
1274       break;
1275     case 45:
1276       Builder.defineMacro("_OPENMP", "201511");
1277       break;
1278     case 50:
1279       Builder.defineMacro("_OPENMP", "201811");
1280       break;
1281     case 52:
1282       Builder.defineMacro("_OPENMP", "202111");
1283       break;
1284     default: // case 51:
1285       // Default version is OpenMP 5.1
1286       Builder.defineMacro("_OPENMP", "202011");
1287       break;
1288     }
1289   }
1290 
1291   // CUDA device path compilaton
1292   if (LangOpts.CUDAIsDevice && !LangOpts.HIP) {
1293     // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
1294     // backend's target defines.
1295     Builder.defineMacro("__CUDA_ARCH__");
1296   }
1297 
1298   // We need to communicate this to our CUDA header wrapper, which in turn
1299   // informs the proper CUDA headers of this choice.
1300   if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) {
1301     Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__");
1302   }
1303 
1304   // Define a macro indicating that the source file is being compiled with a
1305   // SYCL device compiler which doesn't produce host binary.
1306   if (LangOpts.SYCLIsDevice) {
1307     Builder.defineMacro("__SYCL_DEVICE_ONLY__", "1");
1308   }
1309 
1310   // OpenCL definitions.
1311   if (LangOpts.OpenCL) {
1312     InitializeOpenCLFeatureTestMacros(TI, LangOpts, Builder);
1313 
1314     if (TI.getTriple().isSPIR() || TI.getTriple().isSPIRV())
1315       Builder.defineMacro("__IMAGE_SUPPORT__");
1316   }
1317 
1318   if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1319     // For each extended integer type, g++ defines a macro mapping the
1320     // index of the type (0 in this case) in some list of extended types
1321     // to the type.
1322     Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128");
1323     Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128");
1324   }
1325 
1326   // ELF targets define __ELF__
1327   if (TI.getTriple().isOSBinFormatELF())
1328     Builder.defineMacro("__ELF__");
1329 
1330   // Get other target #defines.
1331   TI.getTargetDefines(LangOpts, Builder);
1332 }
1333 
1334 /// InitializePreprocessor - Initialize the preprocessor getting it and the
1335 /// environment ready to process a single file.
1336 void clang::InitializePreprocessor(
1337     Preprocessor &PP, const PreprocessorOptions &InitOpts,
1338     const PCHContainerReader &PCHContainerRdr,
1339     const FrontendOptions &FEOpts) {
1340   const LangOptions &LangOpts = PP.getLangOpts();
1341   std::string PredefineBuffer;
1342   PredefineBuffer.reserve(4080);
1343   llvm::raw_string_ostream Predefines(PredefineBuffer);
1344   MacroBuilder Builder(Predefines);
1345 
1346   // Emit line markers for various builtin sections of the file. The 3 here
1347   // marks <built-in> as being a system header, which suppresses warnings when
1348   // the same macro is defined multiple times.
1349   Builder.append("# 1 \"<built-in>\" 3");
1350 
1351   // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1352   if (InitOpts.UsePredefines) {
1353     // FIXME: This will create multiple definitions for most of the predefined
1354     // macros. This is not the right way to handle this.
1355     if ((LangOpts.CUDA || LangOpts.OpenMPIsTargetDevice ||
1356          LangOpts.SYCLIsDevice) &&
1357         PP.getAuxTargetInfo())
1358       InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts,
1359                                  PP.getPreprocessorOpts(), Builder);
1360 
1361     InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts,
1362                                PP.getPreprocessorOpts(), Builder);
1363 
1364     // Install definitions to make Objective-C++ ARC work well with various
1365     // C++ Standard Library implementations.
1366     if (LangOpts.ObjC && LangOpts.CPlusPlus &&
1367         (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1368       switch (InitOpts.ObjCXXARCStandardLibrary) {
1369       case ARCXX_nolib:
1370       case ARCXX_libcxx:
1371         break;
1372 
1373       case ARCXX_libstdcxx:
1374         AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1375         break;
1376       }
1377     }
1378   }
1379 
1380   // Even with predefines off, some macros are still predefined.
1381   // These should all be defined in the preprocessor according to the
1382   // current language configuration.
1383   InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
1384                                      FEOpts, Builder);
1385 
1386   // Add on the predefines from the driver.  Wrap in a #line directive to report
1387   // that they come from the command line.
1388   Builder.append("# 1 \"<command line>\" 1");
1389 
1390   // Process #define's and #undef's in the order they are given.
1391   for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1392     if (InitOpts.Macros[i].second)  // isUndef
1393       Builder.undefineMacro(InitOpts.Macros[i].first);
1394     else
1395       DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
1396                          PP.getDiagnostics());
1397   }
1398 
1399   // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1400   Builder.append("# 1 \"<built-in>\" 2");
1401 
1402   // If -imacros are specified, include them now.  These are processed before
1403   // any -include directives.
1404   for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1405     AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
1406 
1407   // Process -include-pch/-include-pth directives.
1408   if (!InitOpts.ImplicitPCHInclude.empty())
1409     AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1410                           InitOpts.ImplicitPCHInclude);
1411 
1412   // Process -include directives.
1413   for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1414     const std::string &Path = InitOpts.Includes[i];
1415     AddImplicitInclude(Builder, Path);
1416   }
1417 
1418   // Instruct the preprocessor to skip the preamble.
1419   PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
1420                              InitOpts.PrecompiledPreambleBytes.second);
1421 
1422   // Copy PredefinedBuffer into the Preprocessor.
1423   PP.setPredefines(std::move(PredefineBuffer));
1424 }
1425