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