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