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