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