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 case 310:
549 Builder.defineMacro(Name: "__OPENCL_C_VERSION__", Value: "310");
550 break;
551 default:
552 llvm_unreachable("Unsupported OpenCL version");
553 }
554 }
555 Builder.defineMacro(Name: "CL_VERSION_1_0", Value: "100");
556 Builder.defineMacro(Name: "CL_VERSION_1_1", Value: "110");
557 Builder.defineMacro(Name: "CL_VERSION_1_2", Value: "120");
558 Builder.defineMacro(Name: "CL_VERSION_2_0", Value: "200");
559 Builder.defineMacro(Name: "CL_VERSION_3_0", Value: "300");
560 Builder.defineMacro(Name: "CL_VERSION_3_1", Value: "310");
561
562 if (TI.isLittleEndian())
563 Builder.defineMacro(Name: "__ENDIAN_LITTLE__");
564
565 if (LangOpts.FastRelaxedMath)
566 Builder.defineMacro(Name: "__FAST_RELAXED_MATH__");
567 }
568
569 if (LangOpts.SYCLIsDevice || LangOpts.SYCLIsHost) {
570 // SYCL Version is set to a value when building SYCL applications
571 if (LangOpts.getSYCLVersion() == LangOptions::SYCL_2017)
572 Builder.defineMacro(Name: "CL_SYCL_LANGUAGE_VERSION", Value: "121");
573 else if (LangOpts.getSYCLVersion() == LangOptions::SYCL_2020)
574 Builder.defineMacro(Name: "SYCL_LANGUAGE_VERSION", Value: "202012L");
575 }
576
577 // Not "standard" per se, but available even with the -undef flag.
578 if (LangOpts.AsmPreprocessor)
579 Builder.defineMacro(Name: "__ASSEMBLER__");
580 if (LangOpts.CUDA) {
581 if (LangOpts.GPURelocatableDeviceCode)
582 Builder.defineMacro(Name: "__CLANG_RDC__");
583 if (!LangOpts.HIP)
584 Builder.defineMacro(Name: "__CUDA__");
585 if (LangOpts.GPUDefaultStream ==
586 LangOptions::GPUDefaultStreamKind::PerThread)
587 Builder.defineMacro(Name: "CUDA_API_PER_THREAD_DEFAULT_STREAM");
588 }
589 if (LangOpts.HIP) {
590 Builder.defineMacro(Name: "__HIP__");
591 Builder.defineMacro(Name: "__HIPCC__");
592 Builder.defineMacro(Name: "__HIP_MEMORY_SCOPE_SINGLETHREAD", Value: "1");
593 Builder.defineMacro(Name: "__HIP_MEMORY_SCOPE_WAVEFRONT", Value: "2");
594 Builder.defineMacro(Name: "__HIP_MEMORY_SCOPE_WORKGROUP", Value: "3");
595 Builder.defineMacro(Name: "__HIP_MEMORY_SCOPE_AGENT", Value: "4");
596 Builder.defineMacro(Name: "__HIP_MEMORY_SCOPE_SYSTEM", Value: "5");
597 Builder.defineMacro(Name: "__HIP_MEMORY_SCOPE_CLUSTER", Value: "6");
598 if (LangOpts.HIPStdPar) {
599 Builder.defineMacro(Name: "__HIPSTDPAR__");
600 if (LangOpts.HIPStdParInterposeAlloc) {
601 Builder.defineMacro(Name: "__HIPSTDPAR_INTERPOSE_ALLOC__");
602 Builder.defineMacro(Name: "__HIPSTDPAR_INTERPOSE_ALLOC_V1__");
603 }
604 }
605 if (LangOpts.CUDAIsDevice) {
606 Builder.defineMacro(Name: "__HIP_DEVICE_COMPILE__");
607 if (!TI.hasHIPImageSupport()) {
608 Builder.defineMacro(Name: "__HIP_NO_IMAGE_SUPPORT__", Value: "1");
609 // Deprecated.
610 Builder.defineMacro(Name: "__HIP_NO_IMAGE_SUPPORT", Value: "1");
611 }
612 }
613 if (LangOpts.GPUDefaultStream ==
614 LangOptions::GPUDefaultStreamKind::PerThread) {
615 Builder.defineMacro(Name: "__HIP_API_PER_THREAD_DEFAULT_STREAM__");
616 // Deprecated.
617 Builder.defineMacro(Name: "HIP_API_PER_THREAD_DEFAULT_STREAM");
618 }
619 }
620
621 if (LangOpts.OpenACC)
622 Builder.defineMacro(Name: "_OPENACC", Value: "202506");
623}
624
625/// Initialize the predefined C++ language feature test macros defined in
626/// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
627static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
628 MacroBuilder &Builder,
629 const TargetInfo &TI) {
630 // C++98 features.
631 if (LangOpts.RTTI)
632 Builder.defineMacro(Name: "__cpp_rtti", Value: "199711L");
633 if (LangOpts.CXXExceptions)
634 Builder.defineMacro(Name: "__cpp_exceptions", Value: "199711L");
635
636 // C++11 features.
637 if (LangOpts.CPlusPlus11) {
638 Builder.defineMacro(Name: "__cpp_unicode_characters", Value: "200704L");
639 Builder.defineMacro(Name: "__cpp_raw_strings", Value: "200710L");
640 Builder.defineMacro(Name: "__cpp_unicode_literals", Value: "200710L");
641 Builder.defineMacro(Name: "__cpp_user_defined_literals", Value: "200809L");
642 Builder.defineMacro(Name: "__cpp_lambdas", Value: "200907L");
643 Builder.defineMacro(Name: "__cpp_constexpr", Value: LangOpts.CPlusPlus26 ? "202406L"
644 : LangOpts.CPlusPlus23 ? "202211L"
645 : LangOpts.CPlusPlus20 ? "202002L"
646 : LangOpts.CPlusPlus17 ? "201603L"
647 : LangOpts.CPlusPlus14 ? "201304L"
648 : "200704");
649 Builder.defineMacro(Name: "__cpp_constexpr_in_decltype", Value: "201711L");
650 Builder.defineMacro(Name: "__cpp_range_based_for",
651 Value: LangOpts.CPlusPlus23 ? "202211L"
652 : LangOpts.CPlusPlus17 ? "201603L"
653 : "200907");
654 // C++17 / C++26 static_assert supported as an extension in earlier language
655 // modes, so we use the C++26 value.
656 Builder.defineMacro(Name: "__cpp_static_assert", Value: "202306L");
657 Builder.defineMacro(Name: "__cpp_decltype", Value: "200707L");
658 Builder.defineMacro(Name: "__cpp_attributes", Value: "200809L");
659 Builder.defineMacro(Name: "__cpp_rvalue_references", Value: "200610L");
660 Builder.defineMacro(Name: "__cpp_variadic_templates", Value: "200704L");
661 Builder.defineMacro(Name: "__cpp_initializer_lists", Value: "200806L");
662 Builder.defineMacro(Name: "__cpp_delegating_constructors", Value: "200604L");
663 Builder.defineMacro(Name: "__cpp_nsdmi", Value: "200809L");
664 Builder.defineMacro(Name: "__cpp_inheriting_constructors", Value: "201511L");
665 Builder.defineMacro(Name: "__cpp_ref_qualifiers", Value: "200710L");
666 Builder.defineMacro(Name: "__cpp_alias_templates", Value: "200704L");
667 }
668 if (LangOpts.ThreadsafeStatics)
669 Builder.defineMacro(Name: "__cpp_threadsafe_static_init", Value: "200806L");
670
671 // C++14 features.
672 if (LangOpts.CPlusPlus14) {
673 Builder.defineMacro(Name: "__cpp_binary_literals", Value: "201304L");
674 Builder.defineMacro(Name: "__cpp_digit_separators", Value: "201309L");
675 Builder.defineMacro(Name: "__cpp_init_captures",
676 Value: LangOpts.CPlusPlus20 ? "201803L" : "201304L");
677 Builder.defineMacro(Name: "__cpp_generic_lambdas",
678 Value: LangOpts.CPlusPlus20 ? "201707L" : "201304L");
679 Builder.defineMacro(Name: "__cpp_decltype_auto", Value: "201304L");
680 Builder.defineMacro(Name: "__cpp_return_type_deduction", Value: "201304L");
681 Builder.defineMacro(Name: "__cpp_aggregate_nsdmi", Value: "201304L");
682 Builder.defineMacro(Name: "__cpp_variable_templates", Value: "201304L");
683 }
684 if (LangOpts.SizedDeallocation)
685 Builder.defineMacro(Name: "__cpp_sized_deallocation", Value: "201309L");
686
687 // C++17 features.
688 if (LangOpts.CPlusPlus17) {
689 Builder.defineMacro(Name: "__cpp_hex_float", Value: "201603L");
690 Builder.defineMacro(Name: "__cpp_inline_variables", Value: "201606L");
691 Builder.defineMacro(Name: "__cpp_noexcept_function_type", Value: "201510L");
692 Builder.defineMacro(Name: "__cpp_capture_star_this", Value: "201603L");
693 Builder.defineMacro(Name: "__cpp_if_constexpr", Value: "201606L");
694 Builder.defineMacro(Name: "__cpp_deduction_guides", Value: "201703L"); // (not latest)
695 Builder.defineMacro(Name: "__cpp_template_auto", Value: "201606L"); // (old name)
696 Builder.defineMacro(Name: "__cpp_namespace_attributes", Value: "201411L");
697 Builder.defineMacro(Name: "__cpp_enumerator_attributes", Value: "201411L");
698 Builder.defineMacro(Name: "__cpp_nested_namespace_definitions", Value: "201411L");
699 Builder.defineMacro(Name: "__cpp_variadic_using", Value: "201611L");
700 Builder.defineMacro(Name: "__cpp_aggregate_bases", Value: "201603L");
701 Builder.defineMacro(Name: "__cpp_structured_bindings", Value: "202411L");
702 Builder.defineMacro(Name: "__cpp_nontype_template_args",
703 Value: "201411L"); // (not latest)
704 Builder.defineMacro(Name: "__cpp_fold_expressions", Value: "201603L");
705 Builder.defineMacro(Name: "__cpp_guaranteed_copy_elision", Value: "201606L");
706 Builder.defineMacro(Name: "__cpp_nontype_template_parameter_auto", Value: "201606L");
707 }
708 if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable)
709 Builder.defineMacro(Name: "__cpp_aligned_new", Value: "201606L");
710
711 Builder.defineMacro(Name: "__cpp_template_template_args", Value: "201611L");
712
713 // C++20 features.
714 if (LangOpts.CPlusPlus20) {
715 Builder.defineMacro(Name: "__cpp_aggregate_paren_init", Value: "201902L");
716
717 Builder.defineMacro(Name: "__cpp_concepts", Value: "202002");
718 Builder.defineMacro(Name: "__cpp_conditional_explicit", Value: "201806L");
719 Builder.defineMacro(Name: "__cpp_consteval", Value: "202211L");
720 Builder.defineMacro(Name: "__cpp_constexpr_dynamic_alloc", Value: "201907L");
721 Builder.defineMacro(Name: "__cpp_constinit", Value: "201907L");
722
723 // Support for coroutines on 32-bit x86 Microsoft platforms is
724 // incomplete, do not advertise it.
725 if (!(TI.getCXXABI().isMicrosoft() && TI.getTriple().isX86_32()))
726 Builder.defineMacro(Name: "__cpp_impl_coroutine", Value: "201902L");
727
728 Builder.defineMacro(Name: "__cpp_designated_initializers", Value: "201707L");
729 Builder.defineMacro(Name: "__cpp_impl_three_way_comparison", Value: "201907L");
730 // Intentionally to set __cpp_modules to 1.
731 // See https://github.com/llvm/llvm-project/issues/71364 for details.
732 // Builder.defineMacro("__cpp_modules", "201907L");
733 Builder.defineMacro(Name: "__cpp_modules", Value: "1");
734 Builder.defineMacro(Name: "__cpp_using_enum", Value: "201907L");
735 }
736 // C++23 features.
737 if (LangOpts.CPlusPlus23) {
738 Builder.defineMacro(Name: "__cpp_implicit_move", Value: "202207L");
739 Builder.defineMacro(Name: "__cpp_size_t_suffix", Value: "202011L");
740 Builder.defineMacro(Name: "__cpp_if_consteval", Value: "202106L");
741 Builder.defineMacro(Name: "__cpp_multidimensional_subscript", Value: "202211L");
742 Builder.defineMacro(Name: "__cpp_auto_cast", Value: "202110L");
743 Builder.defineMacro(Name: "__cpp_explicit_this_parameter", Value: "202110L");
744 }
745
746 // We provide those C++23 features as extensions in earlier language modes, so
747 // we also define their feature test macros.
748 if (LangOpts.CPlusPlus11)
749 Builder.defineMacro(Name: "__cpp_static_call_operator", Value: "202207L");
750 Builder.defineMacro(Name: "__cpp_named_character_escapes", Value: "202207L");
751 Builder.defineMacro(Name: "__cpp_placeholder_variables", Value: "202306L");
752
753 // C++26 features supported in earlier language modes.
754 Builder.defineMacro(Name: "__cpp_pack_indexing", Value: "202311L");
755 Builder.defineMacro(Name: "__cpp_deleted_function", Value: "202403L");
756 Builder.defineMacro(Name: "__cpp_variadic_friend", Value: "202403L");
757 Builder.defineMacro(Name: "__cpp_trivial_relocatability", Value: "202502L");
758
759 if (LangOpts.Char8)
760 Builder.defineMacro(Name: "__cpp_char8_t", Value: "202207L");
761 Builder.defineMacro(Name: "__cpp_impl_destroying_delete", Value: "201806L");
762}
763
764/// InitializeOpenCLFeatureTestMacros - Define OpenCL macros based on target
765/// settings and language version
766void InitializeOpenCLFeatureTestMacros(const TargetInfo &TI,
767 const LangOptions &Opts,
768 MacroBuilder &Builder) {
769 const llvm::StringMap<bool> &OpenCLFeaturesMap = TI.getSupportedOpenCLOpts();
770 // FIXME: OpenCL options which affect language semantics/syntax
771 // should be moved into LangOptions.
772 auto defineOpenCLExtMacro = [&](llvm::StringRef Name, auto... OptArgs) {
773 // Check if extension is supported by target and is available in this
774 // OpenCL version
775 if (TI.hasFeatureEnabled(Features: OpenCLFeaturesMap, Name) &&
776 OpenCLOptions::isOpenCLOptionAvailableIn(Opts, OptArgs...))
777 Builder.defineMacro(Name);
778 };
779#define OPENCL_GENERIC_EXTENSION(Ext, ...) \
780 defineOpenCLExtMacro(#Ext, __VA_ARGS__);
781#include "clang/Basic/OpenCLExtensions.def"
782
783 // Assume compiling for FULL profile
784 Builder.defineMacro(Name: "__opencl_c_int64");
785}
786
787llvm::SmallString<32> ConstructFixedPointLiteral(llvm::APFixedPoint Val,
788 llvm::StringRef Suffix) {
789 if (Val.isSigned() && Val == llvm::APFixedPoint::getMin(Sema: Val.getSemantics())) {
790 // When representing the min value of a signed fixed point type in source
791 // code, we cannot simply write `-<lowest value>`. For example, the min
792 // value of a `short _Fract` cannot be written as `-1.0hr`. This is because
793 // the parser will read this (and really any negative numerical literal) as
794 // a UnaryOperator that owns a FixedPointLiteral with a positive value
795 // rather than just a FixedPointLiteral with a negative value. Compiling
796 // `-1.0hr` results in an overflow to the maximal value of that fixed point
797 // type. The correct way to represent a signed min value is to instead split
798 // it into two halves, like `(-0.5hr-0.5hr)` which is what the standard
799 // defines SFRACT_MIN as.
800 llvm::SmallString<32> Literal;
801 Literal.push_back(Elt: '(');
802 llvm::SmallString<32> HalfStr =
803 ConstructFixedPointLiteral(Val: Val.shr(Amt: 1), Suffix);
804 Literal += HalfStr;
805 Literal += HalfStr;
806 Literal.push_back(Elt: ')');
807 return Literal;
808 }
809
810 llvm::SmallString<32> Str(Val.toString());
811 Str += Suffix;
812 return Str;
813}
814
815void DefineFixedPointMacros(const TargetInfo &TI, MacroBuilder &Builder,
816 llvm::StringRef TypeName, llvm::StringRef Suffix,
817 unsigned Width, unsigned Scale, bool Signed) {
818 // Saturation doesn't affect the size or scale of a fixed point type, so we
819 // don't need it here.
820 llvm::FixedPointSemantics FXSema(
821 Width, Scale, Signed, /*IsSaturated=*/false,
822 !Signed && TI.doUnsignedFixedPointTypesHavePadding());
823 llvm::SmallString<32> MacroPrefix("__");
824 MacroPrefix += TypeName;
825 Builder.defineMacro(Name: MacroPrefix + "_EPSILON__",
826 Value: ConstructFixedPointLiteral(
827 Val: llvm::APFixedPoint::getEpsilon(Sema: FXSema), Suffix));
828 Builder.defineMacro(Name: MacroPrefix + "_FBIT__", Value: Twine(Scale));
829 Builder.defineMacro(
830 Name: MacroPrefix + "_MAX__",
831 Value: ConstructFixedPointLiteral(Val: llvm::APFixedPoint::getMax(Sema: FXSema), Suffix));
832
833 // ISO/IEC TR 18037:2008 doesn't specify MIN macros for unsigned types since
834 // they're all just zero.
835 if (Signed)
836 Builder.defineMacro(
837 Name: MacroPrefix + "_MIN__",
838 Value: ConstructFixedPointLiteral(Val: llvm::APFixedPoint::getMin(Sema: FXSema), Suffix));
839}
840
841static void InitializePredefinedMacros(const TargetInfo &TI,
842 const LangOptions &LangOpts,
843 const FrontendOptions &FEOpts,
844 const PreprocessorOptions &PPOpts,
845 const CodeGenOptions &CGOpts,
846 MacroBuilder &Builder) {
847 // Compiler version introspection macros.
848 Builder.defineMacro(Name: "__llvm__"); // LLVM Backend
849 Builder.defineMacro(Name: "__clang__"); // Clang Frontend
850#define TOSTR2(X) #X
851#define TOSTR(X) TOSTR2(X)
852 Builder.defineMacro(Name: "__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
853 Builder.defineMacro(Name: "__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
854 Builder.defineMacro(Name: "__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
855#undef TOSTR
856#undef TOSTR2
857 Builder.defineMacro(Name: "__clang_version__",
858 Value: "\"" CLANG_VERSION_STRING " "
859 + getClangFullRepositoryVersion() + "\"");
860
861 if (LangOpts.GNUCVersion != 0) {
862 // Major, minor, patch, are given two decimal places each, so 4.2.1 becomes
863 // 40201.
864 unsigned GNUCMajor = LangOpts.GNUCVersion / 100 / 100;
865 unsigned GNUCMinor = LangOpts.GNUCVersion / 100 % 100;
866 unsigned GNUCPatch = LangOpts.GNUCVersion % 100;
867 Builder.defineMacro(Name: "__GNUC__", Value: Twine(GNUCMajor));
868 Builder.defineMacro(Name: "__GNUC_MINOR__", Value: Twine(GNUCMinor));
869 Builder.defineMacro(Name: "__GNUC_PATCHLEVEL__", Value: Twine(GNUCPatch));
870 Builder.defineMacro(Name: "__GXX_ABI_VERSION", Value: "1002");
871
872 if (LangOpts.CPlusPlus) {
873 Builder.defineMacro(Name: "__GNUG__", Value: Twine(GNUCMajor));
874 Builder.defineMacro(Name: "__GXX_WEAK__");
875 }
876 }
877
878 // Define macros for the C11 / C++11 memory orderings
879 Builder.defineMacro(Name: "__ATOMIC_RELAXED", Value: "0");
880 Builder.defineMacro(Name: "__ATOMIC_CONSUME", Value: "1");
881 Builder.defineMacro(Name: "__ATOMIC_ACQUIRE", Value: "2");
882 Builder.defineMacro(Name: "__ATOMIC_RELEASE", Value: "3");
883 Builder.defineMacro(Name: "__ATOMIC_ACQ_REL", Value: "4");
884 Builder.defineMacro(Name: "__ATOMIC_SEQ_CST", Value: "5");
885
886 // Define macros for the clang atomic scopes.
887 Builder.defineMacro(Name: "__MEMORY_SCOPE_SYSTEM", Value: "0");
888 Builder.defineMacro(Name: "__MEMORY_SCOPE_DEVICE", Value: "1");
889 Builder.defineMacro(Name: "__MEMORY_SCOPE_WRKGRP", Value: "2");
890 Builder.defineMacro(Name: "__MEMORY_SCOPE_WVFRNT", Value: "3");
891 Builder.defineMacro(Name: "__MEMORY_SCOPE_SINGLE", Value: "4");
892 Builder.defineMacro(Name: "__MEMORY_SCOPE_CLUSTR", Value: "5");
893
894 // Define macros for the OpenCL memory scope.
895 // The values should match AtomicScopeOpenCLModel::ID enum.
896 static_assert(
897 static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 &&
898 static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 &&
899 static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 &&
900 static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4,
901 "Invalid OpenCL memory scope enum definition");
902 Builder.defineMacro(Name: "__OPENCL_MEMORY_SCOPE_WORK_ITEM", Value: "0");
903 Builder.defineMacro(Name: "__OPENCL_MEMORY_SCOPE_WORK_GROUP", Value: "1");
904 Builder.defineMacro(Name: "__OPENCL_MEMORY_SCOPE_DEVICE", Value: "2");
905 Builder.defineMacro(Name: "__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", Value: "3");
906 Builder.defineMacro(Name: "__OPENCL_MEMORY_SCOPE_SUB_GROUP", Value: "4");
907
908 // Define macros for floating-point data classes, used in __builtin_isfpclass.
909 Builder.defineMacro(Name: "__FPCLASS_SNAN", Value: "0x0001");
910 Builder.defineMacro(Name: "__FPCLASS_QNAN", Value: "0x0002");
911 Builder.defineMacro(Name: "__FPCLASS_NEGINF", Value: "0x0004");
912 Builder.defineMacro(Name: "__FPCLASS_NEGNORMAL", Value: "0x0008");
913 Builder.defineMacro(Name: "__FPCLASS_NEGSUBNORMAL", Value: "0x0010");
914 Builder.defineMacro(Name: "__FPCLASS_NEGZERO", Value: "0x0020");
915 Builder.defineMacro(Name: "__FPCLASS_POSZERO", Value: "0x0040");
916 Builder.defineMacro(Name: "__FPCLASS_POSSUBNORMAL", Value: "0x0080");
917 Builder.defineMacro(Name: "__FPCLASS_POSNORMAL", Value: "0x0100");
918 Builder.defineMacro(Name: "__FPCLASS_POSINF", Value: "0x0200");
919
920 // Support for #pragma redefine_extname (Sun compatibility)
921 Builder.defineMacro(Name: "__PRAGMA_REDEFINE_EXTNAME", Value: "1");
922
923 // Previously this macro was set to a string aiming to achieve compatibility
924 // with GCC 4.2.1. Now, just return the full Clang version
925 Builder.defineMacro(Name: "__VERSION__", Value: "\"" +
926 Twine(getClangFullCPPVersion()) + "\"");
927
928 // Initialize language-specific preprocessor defines.
929
930 // Standard conforming mode?
931 if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
932 Builder.defineMacro(Name: "__STRICT_ANSI__");
933
934 if (LangOpts.GNUCVersion && LangOpts.CPlusPlus11)
935 Builder.defineMacro(Name: "__GXX_EXPERIMENTAL_CXX0X__");
936
937 if (TI.getTriple().isOSCygMing()) {
938 // Set ABI defining macros for libstdc++ for MinGW and Cygwin, where the
939 // default in libstdc++ differs from the defaults for this target.
940 Builder.defineMacro(Name: "__GXX_TYPEINFO_EQUALITY_INLINE", Value: "0");
941 }
942
943 if (LangOpts.ObjC) {
944 if (LangOpts.ObjCRuntime.isNonFragile()) {
945 Builder.defineMacro(Name: "__OBJC2__");
946
947 if (LangOpts.ObjCExceptions)
948 Builder.defineMacro(Name: "OBJC_ZEROCOST_EXCEPTIONS");
949 }
950
951 if (LangOpts.getGC() != LangOptions::NonGC)
952 Builder.defineMacro(Name: "__OBJC_GC__");
953
954 if (LangOpts.ObjCRuntime.isNeXTFamily())
955 Builder.defineMacro(Name: "__NEXT_RUNTIME__");
956
957 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) {
958 auto version = LangOpts.ObjCRuntime.getVersion();
959 // Don't rely on the tuple argument, because we can be asked to target
960 // later ABIs than we actually support, so clamp these values to those
961 // currently supported
962 if (version >= VersionTuple(2, 0))
963 Builder.defineMacro(Name: "__OBJC_GNUSTEP_RUNTIME_ABI__", Value: "20");
964 else
965 Builder.defineMacro(
966 Name: "__OBJC_GNUSTEP_RUNTIME_ABI__",
967 Value: "1" + Twine(std::min(a: 8U, b: version.getMinor().value_or(u: 0))));
968 }
969
970 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
971 VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
972 unsigned minor = tuple.getMinor().value_or(u: 0);
973 unsigned subminor = tuple.getSubminor().value_or(u: 0);
974 Builder.defineMacro(Name: "__OBJFW_RUNTIME_ABI__",
975 Value: Twine(tuple.getMajor() * 10000 + minor * 100 +
976 subminor));
977 }
978
979 Builder.defineMacro(Name: "IBOutlet", Value: "__attribute__((iboutlet))");
980 Builder.defineMacro(Name: "IBOutletCollection(ClassName)",
981 Value: "__attribute__((iboutletcollection(ClassName)))");
982 Builder.defineMacro(Name: "IBAction", Value: "void)__attribute__((ibaction)");
983 Builder.defineMacro(Name: "IBInspectable", Value: "");
984 Builder.defineMacro(Name: "IB_DESIGNABLE", Value: "");
985 }
986
987 // Define a macro that describes the Objective-C boolean type even for C
988 // and C++ since BOOL can be used from non Objective-C code.
989 Builder.defineMacro(Name: "__OBJC_BOOL_IS_BOOL",
990 Value: Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
991
992 if (LangOpts.CPlusPlus)
993 InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder, TI);
994
995 // darwin_constant_cfstrings controls this. This is also dependent
996 // on other things like the runtime I believe. This is set even for C code.
997 if (!LangOpts.NoConstantCFStrings)
998 Builder.defineMacro(Name: "__CONSTANT_CFSTRINGS__");
999
1000 if (LangOpts.ObjC)
1001 Builder.defineMacro(Name: "OBJC_NEW_PROPERTIES");
1002
1003 if (LangOpts.PascalStrings)
1004 Builder.defineMacro(Name: "__PASCAL_STRINGS__");
1005
1006 if (LangOpts.Blocks) {
1007 Builder.defineMacro(Name: "__block", Value: "__attribute__((__blocks__(byref)))");
1008 Builder.defineMacro(Name: "__BLOCKS__");
1009 }
1010
1011 if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
1012 Builder.defineMacro(Name: "__EXCEPTIONS");
1013 if (LangOpts.GNUCVersion && LangOpts.RTTI)
1014 Builder.defineMacro(Name: "__GXX_RTTI");
1015
1016 if (CGOpts.hasSjLjExceptions())
1017 Builder.defineMacro(Name: "__USING_SJLJ_EXCEPTIONS__");
1018 else if (CGOpts.hasSEHExceptions())
1019 Builder.defineMacro(Name: "__SEH__");
1020 else if (CGOpts.hasDWARFExceptions() &&
1021 (TI.getTriple().isThumb() || TI.getTriple().isARM()))
1022 Builder.defineMacro(Name: "__ARM_DWARF_EH__");
1023 else if (CGOpts.hasWasmExceptions() && TI.getTriple().isWasm())
1024 Builder.defineMacro(Name: "__WASM_EXCEPTIONS__");
1025
1026 if (LangOpts.Deprecated)
1027 Builder.defineMacro(Name: "__DEPRECATED");
1028
1029 if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus)
1030 Builder.defineMacro(Name: "__private_extern__", Value: "extern");
1031
1032 if (LangOpts.MicrosoftExt) {
1033 if (LangOpts.WChar) {
1034 // wchar_t supported as a keyword.
1035 Builder.defineMacro(Name: "_WCHAR_T_DEFINED");
1036 Builder.defineMacro(Name: "_NATIVE_WCHAR_T_DEFINED");
1037 }
1038 }
1039
1040 // Macros to help identify the narrow and wide character sets
1041 // FIXME: clang currently ignores -fexec-charset=. If this changes,
1042 // then this may need to be updated.
1043 Builder.defineMacro(Name: "__clang_literal_encoding__", Value: "\"UTF-8\"");
1044 if (TI.getTypeWidth(T: TI.getWCharType()) >= 32) {
1045 // FIXME: 32-bit wchar_t signals UTF-32. This may change
1046 // if -fwide-exec-charset= is ever supported.
1047 Builder.defineMacro(Name: "__clang_wide_literal_encoding__", Value: "\"UTF-32\"");
1048 } else {
1049 // FIXME: Less-than 32-bit wchar_t generally means UTF-16
1050 // (e.g., Windows, 32-bit IBM). This may need to be
1051 // updated if -fwide-exec-charset= is ever supported.
1052 Builder.defineMacro(Name: "__clang_wide_literal_encoding__", Value: "\"UTF-16\"");
1053 }
1054
1055 if (CGOpts.OptimizationLevel != 0)
1056 Builder.defineMacro(Name: "__OPTIMIZE__");
1057 if (CGOpts.OptimizeSize != 0)
1058 Builder.defineMacro(Name: "__OPTIMIZE_SIZE__");
1059
1060 if (LangOpts.FastMath)
1061 Builder.defineMacro(Name: "__FAST_MATH__");
1062
1063 // Initialize target-specific preprocessor defines.
1064
1065 // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
1066 // to the macro __BYTE_ORDER (no trailing underscores)
1067 // from glibc's <endian.h> header.
1068 // We don't support the PDP-11 as a target, but include
1069 // the define so it can still be compared against.
1070 Builder.defineMacro(Name: "__ORDER_LITTLE_ENDIAN__", Value: "1234");
1071 Builder.defineMacro(Name: "__ORDER_BIG_ENDIAN__", Value: "4321");
1072 Builder.defineMacro(Name: "__ORDER_PDP_ENDIAN__", Value: "3412");
1073 if (TI.isBigEndian()) {
1074 Builder.defineMacro(Name: "__BYTE_ORDER__", Value: "__ORDER_BIG_ENDIAN__");
1075 Builder.defineMacro(Name: "__BIG_ENDIAN__");
1076 } else {
1077 Builder.defineMacro(Name: "__BYTE_ORDER__", Value: "__ORDER_LITTLE_ENDIAN__");
1078 Builder.defineMacro(Name: "__LITTLE_ENDIAN__");
1079 }
1080
1081 if (TI.getPointerWidth(AddrSpace: LangAS::Default) == 64 && TI.getLongWidth() == 64 &&
1082 TI.getIntWidth() == 32) {
1083 Builder.defineMacro(Name: "_LP64");
1084 Builder.defineMacro(Name: "__LP64__");
1085 }
1086
1087 if (TI.getPointerWidth(AddrSpace: LangAS::Default) == 32 && TI.getLongWidth() == 32 &&
1088 TI.getIntWidth() == 32) {
1089 Builder.defineMacro(Name: "_ILP32");
1090 Builder.defineMacro(Name: "__ILP32__");
1091 }
1092
1093 // Define type sizing macros based on the target properties.
1094 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
1095 Builder.defineMacro(Name: "__CHAR_BIT__", Value: Twine(TI.getCharWidth()));
1096
1097 // The macro is specifying the number of bits in the width, not the number of
1098 // bits the object requires for its in-memory representation, which is what
1099 // getBoolWidth() will return. The bool/_Bool data type is only ever one bit
1100 // wide. See C23 6.2.6.2p2 for the rules in C. Note that
1101 // C++23 [basic.fundamental]p10 allows an implementation-defined value
1102 // representation for bool; when lowering to LLVM, Clang represents bool as an
1103 // i8 in memory but as an i1 when the value is needed, so '1' is also correct
1104 // for C++.
1105 Builder.defineMacro(Name: "__BOOL_WIDTH__", Value: "1");
1106 Builder.defineMacro(Name: "__SHRT_WIDTH__", Value: Twine(TI.getShortWidth()));
1107 Builder.defineMacro(Name: "__INT_WIDTH__", Value: Twine(TI.getIntWidth()));
1108 Builder.defineMacro(Name: "__LONG_WIDTH__", Value: Twine(TI.getLongWidth()));
1109 Builder.defineMacro(Name: "__LLONG_WIDTH__", Value: Twine(TI.getLongLongWidth()));
1110
1111 size_t BitIntMaxWidth = TI.getMaxBitIntWidth();
1112 assert(BitIntMaxWidth <= llvm::IntegerType::MAX_INT_BITS &&
1113 "Target defined a max bit width larger than LLVM can support!");
1114 assert(BitIntMaxWidth >= TI.getLongLongWidth() &&
1115 "Target defined a max bit width smaller than the C standard allows!");
1116 Builder.defineMacro(Name: "__BITINT_MAXWIDTH__", Value: Twine(BitIntMaxWidth));
1117
1118 DefineTypeSize(MacroName: "__SCHAR_MAX__", Ty: TargetInfo::SignedChar, TI, Builder);
1119 DefineTypeSize(MacroName: "__SHRT_MAX__", Ty: TargetInfo::SignedShort, TI, Builder);
1120 DefineTypeSize(MacroName: "__INT_MAX__", Ty: TargetInfo::SignedInt, TI, Builder);
1121 DefineTypeSize(MacroName: "__LONG_MAX__", Ty: TargetInfo::SignedLong, TI, Builder);
1122 DefineTypeSize(MacroName: "__LONG_LONG_MAX__", Ty: TargetInfo::SignedLongLong, TI, Builder);
1123 DefineTypeSizeAndWidth(Prefix: "__WCHAR", Ty: TI.getWCharType(), TI, Builder);
1124 DefineTypeSizeAndWidth(Prefix: "__WINT", Ty: TI.getWIntType(), TI, Builder);
1125 DefineTypeSizeAndWidth(Prefix: "__INTMAX", Ty: TI.getIntMaxType(), TI, Builder);
1126 DefineTypeSizeAndWidth(Prefix: "__SIZE", Ty: TI.getSizeType(), TI, Builder);
1127
1128 DefineTypeSizeAndWidth(Prefix: "__UINTMAX", Ty: TI.getUIntMaxType(), TI, Builder);
1129 DefineTypeSizeAndWidth(Prefix: "__PTRDIFF", Ty: TI.getPtrDiffType(AddrSpace: LangAS::Default), TI,
1130 Builder);
1131 DefineTypeSizeAndWidth(Prefix: "__INTPTR", Ty: TI.getIntPtrType(), TI, Builder);
1132 DefineTypeSizeAndWidth(Prefix: "__UINTPTR", Ty: TI.getUIntPtrType(), TI, Builder);
1133
1134 DefineTypeSizeof(MacroName: "__SIZEOF_DOUBLE__", BitWidth: TI.getDoubleWidth(), TI, Builder);
1135 DefineTypeSizeof(MacroName: "__SIZEOF_FLOAT__", BitWidth: TI.getFloatWidth(), TI, Builder);
1136 DefineTypeSizeof(MacroName: "__SIZEOF_INT__", BitWidth: TI.getIntWidth(), TI, Builder);
1137 DefineTypeSizeof(MacroName: "__SIZEOF_LONG__", BitWidth: TI.getLongWidth(), TI, Builder);
1138 DefineTypeSizeof(MacroName: "__SIZEOF_LONG_DOUBLE__",BitWidth: TI.getLongDoubleWidth(),TI,Builder);
1139 DefineTypeSizeof(MacroName: "__SIZEOF_LONG_LONG__", BitWidth: TI.getLongLongWidth(), TI, Builder);
1140 DefineTypeSizeof(MacroName: "__SIZEOF_POINTER__", BitWidth: TI.getPointerWidth(AddrSpace: LangAS::Default),
1141 TI, Builder);
1142 DefineTypeSizeof(MacroName: "__SIZEOF_SHORT__", BitWidth: TI.getShortWidth(), TI, Builder);
1143 DefineTypeSizeof(MacroName: "__SIZEOF_PTRDIFF_T__",
1144 BitWidth: TI.getTypeWidth(T: TI.getPtrDiffType(AddrSpace: LangAS::Default)), TI,
1145 Builder);
1146 DefineTypeSizeof(MacroName: "__SIZEOF_SIZE_T__",
1147 BitWidth: TI.getTypeWidth(T: TI.getSizeType()), TI, Builder);
1148 DefineTypeSizeof(MacroName: "__SIZEOF_WCHAR_T__",
1149 BitWidth: TI.getTypeWidth(T: TI.getWCharType()), TI, Builder);
1150 DefineTypeSizeof(MacroName: "__SIZEOF_WINT_T__",
1151 BitWidth: TI.getTypeWidth(T: TI.getWIntType()), TI, Builder);
1152 if (TI.hasInt128Type())
1153 DefineTypeSizeof(MacroName: "__SIZEOF_INT128__", BitWidth: 128, TI, Builder);
1154
1155 DefineType(MacroName: "__INTMAX_TYPE__", Ty: TI.getIntMaxType(), Builder);
1156 DefineFmt(LangOpts, Prefix: "__INTMAX", Ty: TI.getIntMaxType(), TI, Builder);
1157 StringRef ConstSuffix(TI.getTypeConstantSuffix(T: TI.getIntMaxType()));
1158 Builder.defineMacro(Name: "__INTMAX_C_SUFFIX__", Value: ConstSuffix);
1159 Builder.defineMacro(Name: "__INTMAX_C(c)",
1160 Value: ConstSuffix.size() ? Twine("c##") + ConstSuffix : "c");
1161 DefineType(MacroName: "__UINTMAX_TYPE__", Ty: TI.getUIntMaxType(), Builder);
1162 DefineFmt(LangOpts, Prefix: "__UINTMAX", Ty: TI.getUIntMaxType(), TI, Builder);
1163 ConstSuffix = TI.getTypeConstantSuffix(T: TI.getUIntMaxType());
1164 Builder.defineMacro(Name: "__UINTMAX_C_SUFFIX__", Value: ConstSuffix);
1165 Builder.defineMacro(Name: "__UINTMAX_C(c)",
1166 Value: ConstSuffix.size() ? Twine("c##") + ConstSuffix : "c");
1167 DefineType(MacroName: "__PTRDIFF_TYPE__", Ty: TI.getPtrDiffType(AddrSpace: LangAS::Default), Builder);
1168 DefineFmt(LangOpts, Prefix: "__PTRDIFF", Ty: TI.getPtrDiffType(AddrSpace: LangAS::Default), TI,
1169 Builder);
1170 DefineType(MacroName: "__INTPTR_TYPE__", Ty: TI.getIntPtrType(), Builder);
1171 DefineFmt(LangOpts, Prefix: "__INTPTR", Ty: TI.getIntPtrType(), TI, Builder);
1172 DefineType(MacroName: "__SIZE_TYPE__", Ty: TI.getSizeType(), Builder);
1173 DefineFmt(LangOpts, Prefix: "__SIZE", Ty: TI.getSizeType(), TI, Builder);
1174 DefineType(MacroName: "__WCHAR_TYPE__", Ty: TI.getWCharType(), Builder);
1175 DefineType(MacroName: "__WINT_TYPE__", Ty: TI.getWIntType(), Builder);
1176 DefineTypeSizeAndWidth(Prefix: "__SIG_ATOMIC", Ty: TI.getSigAtomicType(), TI, Builder);
1177 if (LangOpts.C23)
1178 DefineType(MacroName: "__CHAR8_TYPE__", Ty: TI.UnsignedChar, Builder);
1179 DefineType(MacroName: "__CHAR16_TYPE__", Ty: TI.getChar16Type(), Builder);
1180 DefineType(MacroName: "__CHAR32_TYPE__", Ty: TI.getChar32Type(), Builder);
1181
1182 DefineType(MacroName: "__UINTPTR_TYPE__", Ty: TI.getUIntPtrType(), Builder);
1183 DefineFmt(LangOpts, Prefix: "__UINTPTR", Ty: TI.getUIntPtrType(), TI, Builder);
1184
1185 // The C standard requires the width of uintptr_t and intptr_t to be the same,
1186 // per 7.20.2.4p1. Same for intmax_t and uintmax_t, per 7.20.2.5p1.
1187 assert(TI.getTypeWidth(TI.getUIntPtrType()) ==
1188 TI.getTypeWidth(TI.getIntPtrType()) &&
1189 "uintptr_t and intptr_t have different widths?");
1190 assert(TI.getTypeWidth(TI.getUIntMaxType()) ==
1191 TI.getTypeWidth(TI.getIntMaxType()) &&
1192 "uintmax_t and intmax_t have different widths?");
1193
1194 if (LangOpts.FixedPoint) {
1195 // Each unsigned type has the same width as their signed type.
1196 DefineFixedPointMacros(TI, Builder, TypeName: "SFRACT", Suffix: "HR", Width: TI.getShortFractWidth(),
1197 Scale: TI.getShortFractScale(), /*Signed=*/true);
1198 DefineFixedPointMacros(TI, Builder, TypeName: "USFRACT", Suffix: "UHR",
1199 Width: TI.getShortFractWidth(),
1200 Scale: TI.getUnsignedShortFractScale(), /*Signed=*/false);
1201 DefineFixedPointMacros(TI, Builder, TypeName: "FRACT", Suffix: "R", Width: TI.getFractWidth(),
1202 Scale: TI.getFractScale(), /*Signed=*/true);
1203 DefineFixedPointMacros(TI, Builder, TypeName: "UFRACT", Suffix: "UR", Width: TI.getFractWidth(),
1204 Scale: TI.getUnsignedFractScale(), /*Signed=*/false);
1205 DefineFixedPointMacros(TI, Builder, TypeName: "LFRACT", Suffix: "LR", Width: TI.getLongFractWidth(),
1206 Scale: TI.getLongFractScale(), /*Signed=*/true);
1207 DefineFixedPointMacros(TI, Builder, TypeName: "ULFRACT", Suffix: "ULR",
1208 Width: TI.getLongFractWidth(),
1209 Scale: TI.getUnsignedLongFractScale(), /*Signed=*/false);
1210 DefineFixedPointMacros(TI, Builder, TypeName: "SACCUM", Suffix: "HK", Width: TI.getShortAccumWidth(),
1211 Scale: TI.getShortAccumScale(), /*Signed=*/true);
1212 DefineFixedPointMacros(TI, Builder, TypeName: "USACCUM", Suffix: "UHK",
1213 Width: TI.getShortAccumWidth(),
1214 Scale: TI.getUnsignedShortAccumScale(), /*Signed=*/false);
1215 DefineFixedPointMacros(TI, Builder, TypeName: "ACCUM", Suffix: "K", Width: TI.getAccumWidth(),
1216 Scale: TI.getAccumScale(), /*Signed=*/true);
1217 DefineFixedPointMacros(TI, Builder, TypeName: "UACCUM", Suffix: "UK", Width: TI.getAccumWidth(),
1218 Scale: TI.getUnsignedAccumScale(), /*Signed=*/false);
1219 DefineFixedPointMacros(TI, Builder, TypeName: "LACCUM", Suffix: "LK", Width: TI.getLongAccumWidth(),
1220 Scale: TI.getLongAccumScale(), /*Signed=*/true);
1221 DefineFixedPointMacros(TI, Builder, TypeName: "ULACCUM", Suffix: "ULK",
1222 Width: TI.getLongAccumWidth(),
1223 Scale: TI.getUnsignedLongAccumScale(), /*Signed=*/false);
1224
1225 Builder.defineMacro(Name: "__SACCUM_IBIT__", Value: Twine(TI.getShortAccumIBits()));
1226 Builder.defineMacro(Name: "__USACCUM_IBIT__",
1227 Value: Twine(TI.getUnsignedShortAccumIBits()));
1228 Builder.defineMacro(Name: "__ACCUM_IBIT__", Value: Twine(TI.getAccumIBits()));
1229 Builder.defineMacro(Name: "__UACCUM_IBIT__", Value: Twine(TI.getUnsignedAccumIBits()));
1230 Builder.defineMacro(Name: "__LACCUM_IBIT__", Value: Twine(TI.getLongAccumIBits()));
1231 Builder.defineMacro(Name: "__ULACCUM_IBIT__",
1232 Value: Twine(TI.getUnsignedLongAccumIBits()));
1233 }
1234
1235 if (TI.hasFloat16Type())
1236 DefineFloatMacros(Builder, Prefix: "FLT16", Sem: &TI.getHalfFormat(), Ext: "F16");
1237 DefineFloatMacros(Builder, Prefix: "FLT", Sem: &TI.getFloatFormat(), Ext: "F");
1238 DefineFloatMacros(Builder, Prefix: "DBL", Sem: &TI.getDoubleFormat(), Ext: "");
1239 DefineFloatMacros(Builder, Prefix: "LDBL", Sem: &TI.getLongDoubleFormat(), Ext: "L");
1240
1241 // Define a __POINTER_WIDTH__ macro for stdint.h.
1242 Builder.defineMacro(Name: "__POINTER_WIDTH__",
1243 Value: Twine((int)TI.getPointerWidth(AddrSpace: LangAS::Default)));
1244
1245 // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
1246 Builder.defineMacro(Name: "__BIGGEST_ALIGNMENT__",
1247 Value: Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
1248
1249 if (!LangOpts.CharIsSigned)
1250 Builder.defineMacro(Name: "__CHAR_UNSIGNED__");
1251
1252 if (!TargetInfo::isTypeSigned(T: TI.getWCharType()))
1253 Builder.defineMacro(Name: "__WCHAR_UNSIGNED__");
1254
1255 if (!TargetInfo::isTypeSigned(T: TI.getWIntType()))
1256 Builder.defineMacro(Name: "__WINT_UNSIGNED__");
1257
1258 // Define exact-width integer types for stdint.h
1259 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::SignedChar, TI, Builder);
1260
1261 if (TI.getShortWidth() > TI.getCharWidth())
1262 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::SignedShort, TI, Builder);
1263
1264 if (TI.getIntWidth() > TI.getShortWidth())
1265 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::SignedInt, TI, Builder);
1266
1267 if (TI.getLongWidth() > TI.getIntWidth())
1268 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::SignedLong, TI, Builder);
1269
1270 if (TI.getLongLongWidth() > TI.getLongWidth())
1271 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::SignedLongLong, TI, Builder);
1272
1273 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::UnsignedChar, TI, Builder);
1274 DefineExactWidthIntTypeSize(Ty: TargetInfo::UnsignedChar, TI, Builder);
1275 DefineExactWidthIntTypeSize(Ty: TargetInfo::SignedChar, TI, Builder);
1276
1277 if (TI.getShortWidth() > TI.getCharWidth()) {
1278 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::UnsignedShort, TI, Builder);
1279 DefineExactWidthIntTypeSize(Ty: TargetInfo::UnsignedShort, TI, Builder);
1280 DefineExactWidthIntTypeSize(Ty: TargetInfo::SignedShort, TI, Builder);
1281 }
1282
1283 if (TI.getIntWidth() > TI.getShortWidth()) {
1284 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::UnsignedInt, TI, Builder);
1285 DefineExactWidthIntTypeSize(Ty: TargetInfo::UnsignedInt, TI, Builder);
1286 DefineExactWidthIntTypeSize(Ty: TargetInfo::SignedInt, TI, Builder);
1287 }
1288
1289 if (TI.getLongWidth() > TI.getIntWidth()) {
1290 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::UnsignedLong, TI, Builder);
1291 DefineExactWidthIntTypeSize(Ty: TargetInfo::UnsignedLong, TI, Builder);
1292 DefineExactWidthIntTypeSize(Ty: TargetInfo::SignedLong, TI, Builder);
1293 }
1294
1295 if (TI.getLongLongWidth() > TI.getLongWidth()) {
1296 DefineExactWidthIntType(LangOpts, Ty: TargetInfo::UnsignedLongLong, TI,
1297 Builder);
1298 DefineExactWidthIntTypeSize(Ty: TargetInfo::UnsignedLongLong, TI, Builder);
1299 DefineExactWidthIntTypeSize(Ty: TargetInfo::SignedLongLong, TI, Builder);
1300 }
1301
1302 DefineLeastWidthIntType(LangOpts, TypeWidth: 8, IsSigned: true, TI, Builder);
1303 DefineLeastWidthIntType(LangOpts, TypeWidth: 8, IsSigned: false, TI, Builder);
1304 DefineLeastWidthIntType(LangOpts, TypeWidth: 16, IsSigned: true, TI, Builder);
1305 DefineLeastWidthIntType(LangOpts, TypeWidth: 16, IsSigned: false, TI, Builder);
1306 DefineLeastWidthIntType(LangOpts, TypeWidth: 32, IsSigned: true, TI, Builder);
1307 DefineLeastWidthIntType(LangOpts, TypeWidth: 32, IsSigned: false, TI, Builder);
1308 DefineLeastWidthIntType(LangOpts, TypeWidth: 64, IsSigned: true, TI, Builder);
1309 DefineLeastWidthIntType(LangOpts, TypeWidth: 64, IsSigned: false, TI, Builder);
1310
1311 DefineFastIntType(LangOpts, TypeWidth: 8, IsSigned: true, TI, Builder);
1312 DefineFastIntType(LangOpts, TypeWidth: 8, IsSigned: false, TI, Builder);
1313 DefineFastIntType(LangOpts, TypeWidth: 16, IsSigned: true, TI, Builder);
1314 DefineFastIntType(LangOpts, TypeWidth: 16, IsSigned: false, TI, Builder);
1315 DefineFastIntType(LangOpts, TypeWidth: 32, IsSigned: true, TI, Builder);
1316 DefineFastIntType(LangOpts, TypeWidth: 32, IsSigned: false, TI, Builder);
1317 DefineFastIntType(LangOpts, TypeWidth: 64, IsSigned: true, TI, Builder);
1318 DefineFastIntType(LangOpts, TypeWidth: 64, IsSigned: false, TI, Builder);
1319
1320 Builder.defineMacro(Name: "__USER_LABEL_PREFIX__", Value: TI.getUserLabelPrefix());
1321
1322 if (!LangOpts.MathErrno)
1323 Builder.defineMacro(Name: "__NO_MATH_ERRNO__");
1324
1325 if (LangOpts.FastMath || (LangOpts.NoHonorInfs && LangOpts.NoHonorNaNs))
1326 Builder.defineMacro(Name: "__FINITE_MATH_ONLY__", Value: "1");
1327 else
1328 Builder.defineMacro(Name: "__FINITE_MATH_ONLY__", Value: "0");
1329
1330 if (LangOpts.GNUCVersion) {
1331 if (LangOpts.GNUInline || LangOpts.CPlusPlus)
1332 Builder.defineMacro(Name: "__GNUC_GNU_INLINE__");
1333 else
1334 Builder.defineMacro(Name: "__GNUC_STDC_INLINE__");
1335
1336 // The value written by __atomic_test_and_set.
1337 // FIXME: This is target-dependent.
1338 Builder.defineMacro(Name: "__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", Value: "1");
1339 }
1340
1341 // GCC defines these macros in both C and C++ modes despite them being needed
1342 // mostly for STL implementations in C++.
1343 auto [Destructive, Constructive] = TI.hardwareInterferenceSizes();
1344 Builder.defineMacro(Name: "__GCC_DESTRUCTIVE_SIZE", Value: Twine(Destructive));
1345 Builder.defineMacro(Name: "__GCC_CONSTRUCTIVE_SIZE", Value: Twine(Constructive));
1346 // We need to use push_macro to allow users to redefine these macros from the
1347 // command line with -D and not issue a -Wmacro-redefined warning.
1348 Builder.append(Str: "#pragma push_macro(\"__GCC_DESTRUCTIVE_SIZE\")");
1349 Builder.append(Str: "#pragma push_macro(\"__GCC_CONSTRUCTIVE_SIZE\")");
1350
1351 auto addLockFreeMacros = [&](const llvm::Twine &Prefix) {
1352 // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
1353#define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \
1354 Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE", \
1355 getLockFreeValue(TI.get##Type##Width(), TI));
1356 DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
1357 DEFINE_LOCK_FREE_MACRO(CHAR, Char);
1358 // char8_t has the same representation / width as unsigned
1359 // char in C++ and is a typedef for unsigned char in C23
1360 if (LangOpts.Char8 || LangOpts.C23)
1361 DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char);
1362 DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
1363 DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
1364 DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
1365 DEFINE_LOCK_FREE_MACRO(SHORT, Short);
1366 DEFINE_LOCK_FREE_MACRO(INT, Int);
1367 DEFINE_LOCK_FREE_MACRO(LONG, Long);
1368 DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
1369 Builder.defineMacro(
1370 Name: Prefix + "POINTER_LOCK_FREE",
1371 Value: getLockFreeValue(TypeWidth: TI.getPointerWidth(AddrSpace: LangAS::Default), TI));
1372#undef DEFINE_LOCK_FREE_MACRO
1373 };
1374 addLockFreeMacros("__CLANG_ATOMIC_");
1375 if (LangOpts.GNUCVersion)
1376 addLockFreeMacros("__GCC_ATOMIC_");
1377
1378 if (CGOpts.getInlining() == CodeGenOptions::OnlyAlwaysInlining)
1379 Builder.defineMacro(Name: "__NO_INLINE__");
1380
1381 if (unsigned PICLevel = LangOpts.PICLevel) {
1382 Builder.defineMacro(Name: "__PIC__", Value: Twine(PICLevel));
1383 Builder.defineMacro(Name: "__pic__", Value: Twine(PICLevel));
1384 if (LangOpts.PIE) {
1385 Builder.defineMacro(Name: "__PIE__", Value: Twine(PICLevel));
1386 Builder.defineMacro(Name: "__pie__", Value: Twine(PICLevel));
1387 }
1388 }
1389
1390 // Macros to control C99 numerics and <float.h>
1391 Builder.defineMacro(Name: "__FLT_RADIX__", Value: "2");
1392 Builder.defineMacro(Name: "__DECIMAL_DIG__", Value: "__LDBL_DECIMAL_DIG__");
1393
1394 if (LangOpts.getStackProtector() == LangOptions::SSPOn)
1395 Builder.defineMacro(Name: "__SSP__");
1396 else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
1397 Builder.defineMacro(Name: "__SSP_STRONG__", Value: "2");
1398 else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
1399 Builder.defineMacro(Name: "__SSP_ALL__", Value: "3");
1400
1401 if (PPOpts.SetUpStaticAnalyzer)
1402 Builder.defineMacro(Name: "__clang_analyzer__");
1403
1404 if (LangOpts.FastRelaxedMath)
1405 Builder.defineMacro(Name: "__FAST_RELAXED_MATH__");
1406
1407 if (FEOpts.ProgramAction == frontend::RewriteObjC ||
1408 LangOpts.getGC() != LangOptions::NonGC) {
1409 Builder.defineMacro(Name: "__weak", Value: "__attribute__((objc_gc(weak)))");
1410 Builder.defineMacro(Name: "__strong", Value: "__attribute__((objc_gc(strong)))");
1411 Builder.defineMacro(Name: "__autoreleasing", Value: "");
1412 Builder.defineMacro(Name: "__unsafe_unretained", Value: "");
1413 } else if (LangOpts.ObjC) {
1414 Builder.defineMacro(Name: "__weak", Value: "__attribute__((objc_ownership(weak)))");
1415 Builder.defineMacro(Name: "__strong", Value: "__attribute__((objc_ownership(strong)))");
1416 Builder.defineMacro(Name: "__autoreleasing",
1417 Value: "__attribute__((objc_ownership(autoreleasing)))");
1418 Builder.defineMacro(Name: "__unsafe_unretained",
1419 Value: "__attribute__((objc_ownership(none)))");
1420 }
1421
1422 // On Darwin, there are __double_underscored variants of the type
1423 // nullability qualifiers.
1424 if (TI.getTriple().isOSDarwin()) {
1425 Builder.defineMacro(Name: "__nonnull", Value: "_Nonnull");
1426 Builder.defineMacro(Name: "__null_unspecified", Value: "_Null_unspecified");
1427 Builder.defineMacro(Name: "__nullable", Value: "_Nullable");
1428 }
1429
1430 // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and
1431 // the corresponding simulator targets.
1432 if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment())
1433 Builder.defineMacro(Name: "__APPLE_EMBEDDED_SIMULATOR__", Value: "1");
1434
1435 // OpenMP definition
1436 // OpenMP 2.2:
1437 // In implementations that support a preprocessor, the _OPENMP
1438 // macro name is defined to have the decimal value yyyymm where
1439 // yyyy and mm are the year and the month designations of the
1440 // version of the OpenMP API that the implementation support.
1441 if (!LangOpts.OpenMPSimd) {
1442 switch (LangOpts.OpenMP) {
1443 case 0:
1444 break;
1445 case 31:
1446 Builder.defineMacro(Name: "_OPENMP", Value: "201107");
1447 break;
1448 case 40:
1449 Builder.defineMacro(Name: "_OPENMP", Value: "201307");
1450 break;
1451 case 45:
1452 Builder.defineMacro(Name: "_OPENMP", Value: "201511");
1453 break;
1454 case 50:
1455 Builder.defineMacro(Name: "_OPENMP", Value: "201811");
1456 break;
1457 case 51:
1458 Builder.defineMacro(Name: "_OPENMP", Value: "202011");
1459 break;
1460 case 52:
1461 Builder.defineMacro(Name: "_OPENMP", Value: "202111");
1462 break;
1463 case 60:
1464 Builder.defineMacro(Name: "_OPENMP", Value: "202411");
1465 break;
1466 default: // case 51:
1467 // Default version is OpenMP 5.1
1468 Builder.defineMacro(Name: "_OPENMP", Value: "202011");
1469 break;
1470 }
1471 }
1472
1473 // CUDA device path compilaton
1474 if (LangOpts.CUDAIsDevice && !LangOpts.HIP) {
1475 // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
1476 // backend's target defines.
1477 Builder.defineMacro(Name: "__CUDA_ARCH__");
1478 }
1479
1480 // We need to communicate this to our CUDA/HIP header wrapper, which in turn
1481 // informs the proper CUDA/HIP headers of this choice.
1482 if (LangOpts.GPUDeviceApproxTranscendentals)
1483 Builder.defineMacro(Name: "__CLANG_GPU_APPROX_TRANSCENDENTALS__");
1484
1485 // Define a macro indicating that the source file is being compiled with a
1486 // SYCL device compiler which doesn't produce host binary.
1487 if (LangOpts.SYCLIsDevice) {
1488 Builder.defineMacro(Name: "__SYCL_DEVICE_ONLY__", Value: "1");
1489 }
1490
1491 // OpenCL definitions.
1492 if (LangOpts.OpenCL) {
1493 InitializeOpenCLFeatureTestMacros(TI, Opts: LangOpts, Builder);
1494
1495 if (TI.getTriple().isSPIR() || TI.getTriple().isSPIRV())
1496 Builder.defineMacro(Name: "__IMAGE_SUPPORT__");
1497 }
1498
1499 if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1500 // For each extended integer type, g++ defines a macro mapping the
1501 // index of the type (0 in this case) in some list of extended types
1502 // to the type.
1503 Builder.defineMacro(Name: "__GLIBCXX_TYPE_INT_N_0", Value: "__int128");
1504 Builder.defineMacro(Name: "__GLIBCXX_BITSIZE_INT_N_0", Value: "128");
1505 }
1506
1507 // ELF targets define __ELF__
1508 if (TI.getTriple().isOSBinFormatELF())
1509 Builder.defineMacro(Name: "__ELF__");
1510
1511 if (LangOpts.Sanitize.hasOneOf(K: SanitizerKind::Address |
1512 SanitizerKind::KernelAddress))
1513 Builder.defineMacro(Name: "__SANITIZE_ADDRESS__");
1514 if (LangOpts.Sanitize.hasOneOf(K: SanitizerKind::HWAddress |
1515 SanitizerKind::KernelHWAddress))
1516 Builder.defineMacro(Name: "__SANITIZE_HWADDRESS__");
1517 if (LangOpts.Sanitize.has(K: SanitizerKind::Thread))
1518 Builder.defineMacro(Name: "__SANITIZE_THREAD__");
1519 if (LangOpts.Sanitize.has(K: SanitizerKind::AllocToken))
1520 Builder.defineMacro(Name: "__SANITIZE_ALLOC_TOKEN__");
1521
1522 if (LangOpts.PointerFieldProtectionABI)
1523 Builder.defineMacro(Name: "__POINTER_FIELD_PROTECTION_ABI__");
1524 if (LangOpts.PointerFieldProtectionTagged)
1525 Builder.defineMacro(Name: "__POINTER_FIELD_PROTECTION_TAGGED__");
1526
1527 // Target OS macro definitions.
1528 if (PPOpts.DefineTargetOSMacros) {
1529 const llvm::Triple &Triple = TI.getTriple();
1530#define TARGET_OS(Name, Predicate) \
1531 Builder.defineMacro(#Name, (Predicate) ? "1" : "0");
1532#include "clang/Basic/TargetOSMacros.def"
1533#undef TARGET_OS
1534 }
1535
1536 if (LangOpts.PointerAuthIntrinsics)
1537 Builder.defineMacro(Name: "__PTRAUTH__");
1538
1539 if (CGOpts.Dwarf2CFIAsm)
1540 Builder.defineMacro(Name: "__GCC_HAVE_DWARF2_CFI_ASM");
1541
1542 // Get other target #defines.
1543 TI.getTargetDefines(Opts: LangOpts, Builder);
1544}
1545
1546static void InitializePGOProfileMacros(const CodeGenOptions &CodeGenOpts,
1547 MacroBuilder &Builder) {
1548 if (CodeGenOpts.hasProfileInstr())
1549 Builder.defineMacro(Name: "__LLVM_INSTR_PROFILE_GENERATE");
1550
1551 if (CodeGenOpts.hasProfileIRUse() || CodeGenOpts.hasProfileClangUse())
1552 Builder.defineMacro(Name: "__LLVM_INSTR_PROFILE_USE");
1553}
1554
1555/// InitializePreprocessor - Initialize the preprocessor getting it and the
1556/// environment ready to process a single file.
1557void clang::InitializePreprocessor(Preprocessor &PP,
1558 const PreprocessorOptions &InitOpts,
1559 const PCHContainerReader &PCHContainerRdr,
1560 const FrontendOptions &FEOpts,
1561 const CodeGenOptions &CodeGenOpts) {
1562 const LangOptions &LangOpts = PP.getLangOpts();
1563 std::string PredefineBuffer;
1564 PredefineBuffer.reserve(res_arg: 4080);
1565 llvm::raw_string_ostream Predefines(PredefineBuffer);
1566 MacroBuilder Builder(Predefines);
1567
1568 // Ensure that the initial value of __COUNTER__ is hooked up.
1569 PP.setCounterValue(InitOpts.InitialCounterValue);
1570
1571 // Emit line markers for various builtin sections of the file. The 3 here
1572 // marks <built-in> as being a system header, which suppresses warnings when
1573 // the same macro is defined multiple times.
1574 Builder.append(Str: "# 1 \"<built-in>\" 3");
1575
1576 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1577 if (InitOpts.UsePredefines) {
1578 // FIXME: This will create multiple definitions for most of the predefined
1579 // macros. This is not the right way to handle this.
1580 if ((LangOpts.CUDA || LangOpts.isTargetDevice()) && PP.getAuxTargetInfo())
1581 InitializePredefinedMacros(TI: *PP.getAuxTargetInfo(), LangOpts, FEOpts,
1582 PPOpts: PP.getPreprocessorOpts(), CGOpts: CodeGenOpts,
1583 Builder);
1584
1585 InitializePredefinedMacros(TI: PP.getTargetInfo(), LangOpts, FEOpts,
1586 PPOpts: PP.getPreprocessorOpts(), CGOpts: CodeGenOpts, Builder);
1587
1588 // Install definitions to make Objective-C++ ARC work well with various
1589 // C++ Standard Library implementations.
1590 if (LangOpts.ObjC && LangOpts.CPlusPlus &&
1591 (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1592 switch (InitOpts.ObjCXXARCStandardLibrary) {
1593 case ARCXX_nolib:
1594 case ARCXX_libcxx:
1595 break;
1596
1597 case ARCXX_libstdcxx:
1598 AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1599 break;
1600 }
1601 }
1602 }
1603
1604 // Even with predefines off, some macros are still predefined.
1605 // These should all be defined in the preprocessor according to the
1606 // current language configuration.
1607 InitializeStandardPredefinedMacros(TI: PP.getTargetInfo(), LangOpts: PP.getLangOpts(),
1608 FEOpts, Builder);
1609
1610 // The PGO instrumentation profile macros are driven by options
1611 // -fprofile[-instr]-generate/-fcs-profile-generate/-fprofile[-instr]-use,
1612 // hence they are not guarded by InitOpts.UsePredefines.
1613 InitializePGOProfileMacros(CodeGenOpts, Builder);
1614
1615 // Add on the predefines from the driver. Wrap in a #line directive to report
1616 // that they come from the command line.
1617 Builder.append(Str: "# 1 \"<command line>\" 1");
1618
1619 // Process #define's and #undef's in the order they are given.
1620 for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1621 if (InitOpts.Macros[i].second) // isUndef
1622 Builder.undefineMacro(Name: InitOpts.Macros[i].first);
1623 else
1624 DefineBuiltinMacro(Builder, Macro: InitOpts.Macros[i].first,
1625 Diags&: PP.getDiagnostics());
1626 }
1627
1628 // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1629 Builder.append(Str: "# 1 \"<built-in>\" 2");
1630
1631 // If -imacros are specified, include them now. These are processed before
1632 // any -include directives.
1633 for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1634 AddImplicitIncludeMacros(Builder, File: InitOpts.MacroIncludes[i]);
1635
1636 // Process -include-pch/-include-pth directives.
1637 if (!InitOpts.ImplicitPCHInclude.empty())
1638 AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1639 ImplicitIncludePCH: InitOpts.ImplicitPCHInclude);
1640
1641 // Process -include directives.
1642 for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1643 const std::string &Path = InitOpts.Includes[i];
1644 AddImplicitInclude(Builder, File: Path);
1645 }
1646
1647 // Instruct the preprocessor to skip the preamble.
1648 PP.setSkipMainFilePreamble(Bytes: InitOpts.PrecompiledPreambleBytes.first,
1649 StartOfLine: InitOpts.PrecompiledPreambleBytes.second);
1650
1651 // Copy PredefinedBuffer into the Preprocessor.
1652 PP.setPredefines(std::move(PredefineBuffer));
1653
1654 // Match gcc behavior regarding gnu-line-directive diagnostics, assuming that
1655 // '-x <*>-cpp-output' is analogous to '-fpreprocessed'.
1656 if (FEOpts.DashX.isPreprocessed()) {
1657 PP.getDiagnostics().setSeverity(Diag: diag::ext_pp_gnu_line_directive,
1658 Map: diag::Severity::Ignored, Loc: SourceLocation());
1659
1660 // Compiling with -xc++-cpp-output should suppress module directive
1661 // recognition. __preprocessed_module can either get the directive treatment
1662 // or be accepted directly by phase 7 in a module declaration. In the latter
1663 // case, __preprocessed_module will work even if there are preprocessing
1664 // tokens on the same line that precede it.
1665 PP.markMainFileAsPreprocessedModuleFile();
1666 }
1667}
1668