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