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