1 //===--- InitPreprocessor.cpp - PP initialization code. ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the clang::InitializePreprocessor function.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Basic/FileManager.h"
15 #include "clang/Basic/MacroBuilder.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/SyncScope.h"
18 #include "clang/Basic/TargetInfo.h"
19 #include "clang/Basic/Version.h"
20 #include "clang/Frontend/FrontendDiagnostic.h"
21 #include "clang/Frontend/FrontendOptions.h"
22 #include "clang/Frontend/Utils.h"
23 #include "clang/Lex/HeaderSearch.h"
24 #include "clang/Lex/Preprocessor.h"
25 #include "clang/Lex/PreprocessorOptions.h"
26 #include "clang/Serialization/ASTReader.h"
27 #include "llvm/ADT/APFloat.h"
28 using namespace clang;
30 static bool MacroBodyEndsInBackslash(StringRef MacroBody) {
31 while (!MacroBody.empty() && isWhitespace(MacroBody.back()))
32 MacroBody = MacroBody.drop_back();
33 return !MacroBody.empty() && MacroBody.back() == '\\';
36 // Append a #define line to Buf for Macro. Macro should be of the form XXX,
37 // in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
38 // "#define XXX Y z W". To get a #define with no value, use "XXX=".
39 static void DefineBuiltinMacro(MacroBuilder &Builder, StringRef Macro,
40 DiagnosticsEngine &Diags) {
41 std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
42 StringRef MacroName = MacroPair.first;
43 StringRef MacroBody = MacroPair.second;
44 if (MacroName.size() != Macro.size()) {
45 // Per GCC -D semantics, the macro ends at \n if it exists.
46 StringRef::size_type End = MacroBody.find_first_of("\n\r");
47 if (End != StringRef::npos)
48 Diags.Report(diag::warn_fe_macro_contains_embedded_newline)
50 MacroBody = MacroBody.substr(0, End);
51 // We handle macro bodies which end in a backslash by appending an extra
52 // backslash+newline. This makes sure we don't accidentally treat the
53 // backslash as a line continuation marker.
54 if (MacroBodyEndsInBackslash(MacroBody))
55 Builder.defineMacro(MacroName, Twine(MacroBody) + "\\\n");
57 Builder.defineMacro(MacroName, MacroBody);
59 // Push "macroname 1".
60 Builder.defineMacro(Macro);
64 /// AddImplicitInclude - Add an implicit \#include of the specified file to the
65 /// predefines buffer.
66 /// As these includes are generated by -include arguments the header search
67 /// logic is going to search relatively to the current working directory.
68 static void AddImplicitInclude(MacroBuilder &Builder, StringRef File) {
69 Builder.append(Twine("#include \"") + File + "\"");
72 static void AddImplicitIncludeMacros(MacroBuilder &Builder, StringRef File) {
73 Builder.append(Twine("#__include_macros \"") + File + "\"");
74 // Marker token to stop the __include_macros fetch loop.
75 Builder.append("##"); // ##?
78 /// Add an implicit \#include using the original file used to generate
80 static void AddImplicitIncludePCH(MacroBuilder &Builder, Preprocessor &PP,
81 const PCHContainerReader &PCHContainerRdr,
82 StringRef ImplicitIncludePCH) {
83 std::string OriginalFile =
84 ASTReader::getOriginalSourceFile(ImplicitIncludePCH, PP.getFileManager(),
85 PCHContainerRdr, PP.getDiagnostics());
86 if (OriginalFile.empty())
89 AddImplicitInclude(Builder, OriginalFile);
92 /// PickFP - This is used to pick a value based on the FP semantics of the
93 /// specified FP model.
95 static T PickFP(const llvm::fltSemantics *Sem, T IEEEHalfVal, T IEEESingleVal,
96 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
98 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEhalf())
100 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle())
101 return IEEESingleVal;
102 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble())
103 return IEEEDoubleVal;
104 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended())
105 return X87DoubleExtendedVal;
106 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble())
107 return PPCDoubleDoubleVal;
108 assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad());
112 static void DefineFloatMacros(MacroBuilder &Builder, StringRef Prefix,
113 const llvm::fltSemantics *Sem, StringRef Ext) {
114 const char *DenormMin, *Epsilon, *Max, *Min;
115 DenormMin = PickFP(Sem, "5.9604644775390625e-8", "1.40129846e-45",
116 "4.9406564584124654e-324", "3.64519953188247460253e-4951",
117 "4.94065645841246544176568792868221e-324",
118 "6.47517511943802511092443895822764655e-4966");
119 int Digits = PickFP(Sem, 3, 6, 15, 18, 31, 33);
120 int DecimalDigits = PickFP(Sem, 5, 9, 17, 21, 33, 36);
121 Epsilon = PickFP(Sem, "9.765625e-4", "1.19209290e-7",
122 "2.2204460492503131e-16", "1.08420217248550443401e-19",
123 "4.94065645841246544176568792868221e-324",
124 "1.92592994438723585305597794258492732e-34");
125 int MantissaDigits = PickFP(Sem, 11, 24, 53, 64, 106, 113);
126 int Min10Exp = PickFP(Sem, -13, -37, -307, -4931, -291, -4931);
127 int Max10Exp = PickFP(Sem, 4, 38, 308, 4932, 308, 4932);
128 int MinExp = PickFP(Sem, -14, -125, -1021, -16381, -968, -16381);
129 int MaxExp = PickFP(Sem, 15, 128, 1024, 16384, 1024, 16384);
130 Min = PickFP(Sem, "6.103515625e-5", "1.17549435e-38", "2.2250738585072014e-308",
131 "3.36210314311209350626e-4932",
132 "2.00416836000897277799610805135016e-292",
133 "3.36210314311209350626267781732175260e-4932");
134 Max = PickFP(Sem, "6.5504e+4", "3.40282347e+38", "1.7976931348623157e+308",
135 "1.18973149535723176502e+4932",
136 "1.79769313486231580793728971405301e+308",
137 "1.18973149535723176508575932662800702e+4932");
139 SmallString<32> DefPrefix;
144 Builder.defineMacro(DefPrefix + "DENORM_MIN__", Twine(DenormMin)+Ext);
145 Builder.defineMacro(DefPrefix + "HAS_DENORM__");
146 Builder.defineMacro(DefPrefix + "DIG__", Twine(Digits));
147 Builder.defineMacro(DefPrefix + "DECIMAL_DIG__", Twine(DecimalDigits));
148 Builder.defineMacro(DefPrefix + "EPSILON__", Twine(Epsilon)+Ext);
149 Builder.defineMacro(DefPrefix + "HAS_INFINITY__");
150 Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__");
151 Builder.defineMacro(DefPrefix + "MANT_DIG__", Twine(MantissaDigits));
153 Builder.defineMacro(DefPrefix + "MAX_10_EXP__", Twine(Max10Exp));
154 Builder.defineMacro(DefPrefix + "MAX_EXP__", Twine(MaxExp));
155 Builder.defineMacro(DefPrefix + "MAX__", Twine(Max)+Ext);
157 Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+Twine(Min10Exp)+")");
158 Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+Twine(MinExp)+")");
159 Builder.defineMacro(DefPrefix + "MIN__", Twine(Min)+Ext);
163 /// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
164 /// named MacroName with the max value for a type with width 'TypeWidth' a
165 /// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
166 static void DefineTypeSize(const Twine &MacroName, unsigned TypeWidth,
167 StringRef ValSuffix, bool isSigned,
168 MacroBuilder &Builder) {
169 llvm::APInt MaxVal = isSigned ? llvm::APInt::getSignedMaxValue(TypeWidth)
170 : llvm::APInt::getMaxValue(TypeWidth);
171 Builder.defineMacro(MacroName, MaxVal.toString(10, isSigned) + ValSuffix);
174 /// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
175 /// the width, suffix, and signedness of the given type
176 static void DefineTypeSize(const Twine &MacroName, TargetInfo::IntType Ty,
177 const TargetInfo &TI, MacroBuilder &Builder) {
178 DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
179 TI.isTypeSigned(Ty), Builder);
182 static void DefineFmt(const Twine &Prefix, TargetInfo::IntType Ty,
183 const TargetInfo &TI, MacroBuilder &Builder) {
184 bool IsSigned = TI.isTypeSigned(Ty);
185 StringRef FmtModifier = TI.getTypeFormatModifier(Ty);
186 for (const char *Fmt = IsSigned ? "di" : "ouxX"; *Fmt; ++Fmt) {
187 Builder.defineMacro(Prefix + "_FMT" + Twine(*Fmt) + "__",
188 Twine("\"") + FmtModifier + Twine(*Fmt) + "\"");
192 static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty,
193 MacroBuilder &Builder) {
194 Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
197 static void DefineTypeWidth(StringRef MacroName, TargetInfo::IntType Ty,
198 const TargetInfo &TI, MacroBuilder &Builder) {
199 Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty)));
202 static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth,
203 const TargetInfo &TI, MacroBuilder &Builder) {
204 Builder.defineMacro(MacroName,
205 Twine(BitWidth / TI.getCharWidth()));
208 static void DefineExactWidthIntType(TargetInfo::IntType Ty,
209 const TargetInfo &TI,
210 MacroBuilder &Builder) {
211 int TypeWidth = TI.getTypeWidth(Ty);
212 bool IsSigned = TI.isTypeSigned(Ty);
214 // Use the target specified int64 type, when appropriate, so that [u]int64_t
215 // ends up being defined in terms of the correct type.
217 Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
219 const char *Prefix = IsSigned ? "__INT" : "__UINT";
221 DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
222 DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
224 StringRef ConstSuffix(TI.getTypeConstantSuffix(Ty));
225 Builder.defineMacro(Prefix + Twine(TypeWidth) + "_C_SUFFIX__", ConstSuffix);
228 static void DefineExactWidthIntTypeSize(TargetInfo::IntType Ty,
229 const TargetInfo &TI,
230 MacroBuilder &Builder) {
231 int TypeWidth = TI.getTypeWidth(Ty);
232 bool IsSigned = TI.isTypeSigned(Ty);
234 // Use the target specified int64 type, when appropriate, so that [u]int64_t
235 // ends up being defined in terms of the correct type.
237 Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
239 const char *Prefix = IsSigned ? "__INT" : "__UINT";
240 DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
243 static void DefineLeastWidthIntType(unsigned TypeWidth, bool IsSigned,
244 const TargetInfo &TI,
245 MacroBuilder &Builder) {
246 TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
247 if (Ty == TargetInfo::NoInt)
250 const char *Prefix = IsSigned ? "__INT_LEAST" : "__UINT_LEAST";
251 DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
252 DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
253 DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
256 static void DefineFastIntType(unsigned TypeWidth, bool IsSigned,
257 const TargetInfo &TI, MacroBuilder &Builder) {
258 // stdint.h currently defines the fast int types as equivalent to the least
260 TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
261 if (Ty == TargetInfo::NoInt)
264 const char *Prefix = IsSigned ? "__INT_FAST" : "__UINT_FAST";
265 DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
266 DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
268 DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
272 /// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with
273 /// the specified properties.
274 static const char *getLockFreeValue(unsigned TypeWidth, unsigned TypeAlign,
275 unsigned InlineWidth) {
276 // Fully-aligned, power-of-2 sizes no larger than the inline
277 // width will be inlined as lock-free operations.
278 if (TypeWidth == TypeAlign && (TypeWidth & (TypeWidth - 1)) == 0 &&
279 TypeWidth <= InlineWidth)
280 return "2"; // "always lock free"
281 // We cannot be certain what operations the lib calls might be
282 // able to implement as lock-free on future processors.
283 return "1"; // "sometimes lock free"
286 /// Add definitions required for a smooth interaction between
287 /// Objective-C++ automated reference counting and libstdc++ (4.2).
288 static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts,
289 MacroBuilder &Builder) {
290 Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR");
294 // Provide specializations for the __is_scalar type trait so that
295 // lifetime-qualified objects are not considered "scalar" types, which
296 // libstdc++ uses as an indicator of the presence of trivial copy, assign,
297 // default-construct, and destruct semantics (none of which hold for
298 // lifetime-qualified objects in ARC).
299 llvm::raw_string_ostream Out(Result);
301 Out << "namespace std {\n"
303 << "struct __true_type;\n"
304 << "struct __false_type;\n"
307 Out << "template<typename _Tp> struct __is_scalar;\n"
310 if (LangOpts.ObjCAutoRefCount) {
311 Out << "template<typename _Tp>\n"
312 << "struct __is_scalar<__attribute__((objc_ownership(strong))) _Tp> {\n"
313 << " enum { __value = 0 };\n"
314 << " typedef __false_type __type;\n"
319 if (LangOpts.ObjCWeak) {
320 Out << "template<typename _Tp>\n"
321 << "struct __is_scalar<__attribute__((objc_ownership(weak))) _Tp> {\n"
322 << " enum { __value = 0 };\n"
323 << " typedef __false_type __type;\n"
328 if (LangOpts.ObjCAutoRefCount) {
329 Out << "template<typename _Tp>\n"
330 << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))"
332 << " enum { __value = 0 };\n"
333 << " typedef __false_type __type;\n"
340 Builder.append(Result);
343 static void InitializeStandardPredefinedMacros(const TargetInfo &TI,
344 const LangOptions &LangOpts,
345 const FrontendOptions &FEOpts,
346 MacroBuilder &Builder) {
347 if (!LangOpts.MSVCCompat && !LangOpts.TraditionalCPP)
348 Builder.defineMacro("__STDC__");
349 if (LangOpts.Freestanding)
350 Builder.defineMacro("__STDC_HOSTED__", "0");
352 Builder.defineMacro("__STDC_HOSTED__");
354 if (!LangOpts.CPlusPlus) {
356 Builder.defineMacro("__STDC_VERSION__", "201710L");
357 else if (LangOpts.C11)
358 Builder.defineMacro("__STDC_VERSION__", "201112L");
359 else if (LangOpts.C99)
360 Builder.defineMacro("__STDC_VERSION__", "199901L");
361 else if (!LangOpts.GNUMode && LangOpts.Digraphs)
362 Builder.defineMacro("__STDC_VERSION__", "199409L");
364 // FIXME: Use correct value for C++20.
365 if (LangOpts.CPlusPlus2a)
366 Builder.defineMacro("__cplusplus", "201707L");
367 // C++17 [cpp.predefined]p1:
368 // The name __cplusplus is defined to the value 201703L when compiling a
369 // C++ translation unit.
370 else if (LangOpts.CPlusPlus17)
371 Builder.defineMacro("__cplusplus", "201703L");
372 // C++1y [cpp.predefined]p1:
373 // The name __cplusplus is defined to the value 201402L when compiling a
374 // C++ translation unit.
375 else if (LangOpts.CPlusPlus14)
376 Builder.defineMacro("__cplusplus", "201402L");
377 // C++11 [cpp.predefined]p1:
378 // The name __cplusplus is defined to the value 201103L when compiling a
379 // C++ translation unit.
380 else if (LangOpts.CPlusPlus11)
381 Builder.defineMacro("__cplusplus", "201103L");
382 // C++03 [cpp.predefined]p1:
383 // The name __cplusplus is defined to the value 199711L when compiling a
384 // C++ translation unit.
386 Builder.defineMacro("__cplusplus", "199711L");
388 // C++1z [cpp.predefined]p1:
389 // An integer literal of type std::size_t whose value is the alignment
390 // guaranteed by a call to operator new(std::size_t)
392 // We provide this in all language modes, since it seems generally useful.
393 Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__",
394 Twine(TI.getNewAlign() / TI.getCharWidth()) +
395 TI.getTypeConstantSuffix(TI.getSizeType()));
398 // In C11 these are environment macros. In C++11 they are only defined
399 // as part of <cuchar>. To prevent breakage when mixing C and C++
400 // code, define these macros unconditionally. We can define them
401 // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
402 // and 32-bit character literals.
403 Builder.defineMacro("__STDC_UTF_16__", "1");
404 Builder.defineMacro("__STDC_UTF_32__", "1");
407 Builder.defineMacro("__OBJC__");
409 // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros.
410 if (LangOpts.OpenCL) {
411 if (LangOpts.CPlusPlus) {
412 if (LangOpts.OpenCLCPlusPlusVersion == 100)
413 Builder.defineMacro("__OPENCL_CPP_VERSION__", "100");
415 llvm_unreachable("Unsupported OpenCL C++ version");
416 Builder.defineMacro("__CL_CPP_VERSION_1_0__", "100");
418 // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the
419 // language standard with which the program is compiled. __OPENCL_VERSION__
420 // is for the OpenCL version supported by the OpenCL device, which is not
421 // necessarily the language standard with which the program is compiled.
422 // A shared OpenCL header file requires a macro to indicate the language
423 // standard. As a workaround, __OPENCL_C_VERSION__ is defined for
424 // OpenCL v1.0 and v1.1.
425 switch (LangOpts.OpenCLVersion) {
427 Builder.defineMacro("__OPENCL_C_VERSION__", "100");
430 Builder.defineMacro("__OPENCL_C_VERSION__", "110");
433 Builder.defineMacro("__OPENCL_C_VERSION__", "120");
436 Builder.defineMacro("__OPENCL_C_VERSION__", "200");
439 llvm_unreachable("Unsupported OpenCL version");
441 Builder.defineMacro("CL_VERSION_1_0", "100");
442 Builder.defineMacro("CL_VERSION_1_1", "110");
443 Builder.defineMacro("CL_VERSION_1_2", "120");
444 Builder.defineMacro("CL_VERSION_2_0", "200");
446 if (TI.isLittleEndian())
447 Builder.defineMacro("__ENDIAN_LITTLE__");
449 if (LangOpts.FastRelaxedMath)
450 Builder.defineMacro("__FAST_RELAXED_MATH__");
453 // Not "standard" per se, but available even with the -undef flag.
454 if (LangOpts.AsmPreprocessor)
455 Builder.defineMacro("__ASSEMBLER__");
456 if (LangOpts.CUDA && !LangOpts.HIP)
457 Builder.defineMacro("__CUDA__");
459 Builder.defineMacro("__HIP__");
460 Builder.defineMacro("__HIPCC__");
461 if (LangOpts.CUDAIsDevice)
462 Builder.defineMacro("__HIP_DEVICE_COMPILE__");
466 /// Initialize the predefined C++ language feature test macros defined in
467 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
468 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
469 MacroBuilder &Builder) {
472 Builder.defineMacro("__cpp_rtti", "199711L");
473 if (LangOpts.CXXExceptions)
474 Builder.defineMacro("__cpp_exceptions", "199711L");
477 if (LangOpts.CPlusPlus11) {
478 Builder.defineMacro("__cpp_unicode_characters", "200704L");
479 Builder.defineMacro("__cpp_raw_strings", "200710L");
480 Builder.defineMacro("__cpp_unicode_literals", "200710L");
481 Builder.defineMacro("__cpp_user_defined_literals", "200809L");
482 Builder.defineMacro("__cpp_lambdas", "200907L");
483 Builder.defineMacro("__cpp_constexpr",
484 LangOpts.CPlusPlus17 ? "201603L" :
485 LangOpts.CPlusPlus14 ? "201304L" : "200704");
486 Builder.defineMacro("__cpp_range_based_for",
487 LangOpts.CPlusPlus17 ? "201603L" : "200907");
488 Builder.defineMacro("__cpp_static_assert",
489 LangOpts.CPlusPlus17 ? "201411L" : "200410");
490 Builder.defineMacro("__cpp_decltype", "200707L");
491 Builder.defineMacro("__cpp_attributes", "200809L");
492 Builder.defineMacro("__cpp_rvalue_references", "200610L");
493 Builder.defineMacro("__cpp_variadic_templates", "200704L");
494 Builder.defineMacro("__cpp_initializer_lists", "200806L");
495 Builder.defineMacro("__cpp_delegating_constructors", "200604L");
496 Builder.defineMacro("__cpp_nsdmi", "200809L");
497 Builder.defineMacro("__cpp_inheriting_constructors", "201511L");
498 Builder.defineMacro("__cpp_ref_qualifiers", "200710L");
499 Builder.defineMacro("__cpp_alias_templates", "200704L");
501 if (LangOpts.ThreadsafeStatics)
502 Builder.defineMacro("__cpp_threadsafe_static_init", "200806L");
505 if (LangOpts.CPlusPlus14) {
506 Builder.defineMacro("__cpp_binary_literals", "201304L");
507 Builder.defineMacro("__cpp_digit_separators", "201309L");
508 Builder.defineMacro("__cpp_init_captures", "201304L");
509 Builder.defineMacro("__cpp_generic_lambdas", "201304L");
510 Builder.defineMacro("__cpp_decltype_auto", "201304L");
511 Builder.defineMacro("__cpp_return_type_deduction", "201304L");
512 Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L");
513 Builder.defineMacro("__cpp_variable_templates", "201304L");
515 if (LangOpts.SizedDeallocation)
516 Builder.defineMacro("__cpp_sized_deallocation", "201309L");
519 if (LangOpts.CPlusPlus17) {
520 Builder.defineMacro("__cpp_hex_float", "201603L");
521 Builder.defineMacro("__cpp_inline_variables", "201606L");
522 Builder.defineMacro("__cpp_noexcept_function_type", "201510L");
523 Builder.defineMacro("__cpp_capture_star_this", "201603L");
524 Builder.defineMacro("__cpp_if_constexpr", "201606L");
525 Builder.defineMacro("__cpp_deduction_guides", "201703L");
526 Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name)
527 Builder.defineMacro("__cpp_namespace_attributes", "201411L");
528 Builder.defineMacro("__cpp_enumerator_attributes", "201411L");
529 Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L");
530 Builder.defineMacro("__cpp_variadic_using", "201611L");
531 Builder.defineMacro("__cpp_aggregate_bases", "201603L");
532 Builder.defineMacro("__cpp_structured_bindings", "201606L");
533 Builder.defineMacro("__cpp_nontype_template_args", "201411L");
534 Builder.defineMacro("__cpp_fold_expressions", "201603L");
535 Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L");
536 Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L");
538 if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable)
539 Builder.defineMacro("__cpp_aligned_new", "201606L");
540 if (LangOpts.RelaxedTemplateTemplateArgs)
541 Builder.defineMacro("__cpp_template_template_args", "201611L");
545 Builder.defineMacro("__cpp_char8_t", "201811L");
546 Builder.defineMacro("__cpp_impl_destroying_delete", "201806L");
549 if (LangOpts.ConceptsTS)
550 Builder.defineMacro("__cpp_experimental_concepts", "1L");
551 if (LangOpts.CoroutinesTS)
552 Builder.defineMacro("__cpp_coroutines", "201703L");
555 static void InitializePredefinedMacros(const TargetInfo &TI,
556 const LangOptions &LangOpts,
557 const FrontendOptions &FEOpts,
558 MacroBuilder &Builder) {
559 // Compiler version introspection macros.
560 Builder.defineMacro("__llvm__"); // LLVM Backend
561 Builder.defineMacro("__clang__"); // Clang Frontend
563 #define TOSTR(X) TOSTR2(X)
564 Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
565 Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
566 Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
569 Builder.defineMacro("__clang_version__",
570 "\"" CLANG_VERSION_STRING " "
571 + getClangFullRepositoryVersion() + "\"");
572 if (!LangOpts.MSVCCompat) {
573 // Currently claim to be compatible with GCC 4.2.1-5621, but only if we're
574 // not compiling for MSVC compatibility
575 Builder.defineMacro("__GNUC_MINOR__", "2");
576 Builder.defineMacro("__GNUC_PATCHLEVEL__", "1");
577 Builder.defineMacro("__GNUC__", "4");
578 Builder.defineMacro("__GXX_ABI_VERSION", "1002");
581 // Define macros for the C11 / C++11 memory orderings
582 Builder.defineMacro("__ATOMIC_RELAXED", "0");
583 Builder.defineMacro("__ATOMIC_CONSUME", "1");
584 Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
585 Builder.defineMacro("__ATOMIC_RELEASE", "3");
586 Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
587 Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
589 // Define macros for the OpenCL memory scope.
590 // The values should match AtomicScopeOpenCLModel::ID enum.
592 static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 &&
593 static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 &&
594 static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 &&
595 static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4,
596 "Invalid OpenCL memory scope enum definition");
597 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0");
598 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1");
599 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2");
600 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3");
601 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4");
603 // Support for #pragma redefine_extname (Sun compatibility)
604 Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
606 // As sad as it is, enough software depends on the __VERSION__ for version
607 // checks that it is necessary to report 4.2.1 (the base GCC version we claim
608 // compatibility with) first.
609 Builder.defineMacro("__VERSION__", "\"4.2.1 Compatible " +
610 Twine(getClangFullCPPVersion()) + "\"");
612 // Initialize language-specific preprocessor defines.
614 // Standard conforming mode?
615 if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
616 Builder.defineMacro("__STRICT_ANSI__");
618 if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus11)
619 Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
622 if (LangOpts.ObjCRuntime.isNonFragile()) {
623 Builder.defineMacro("__OBJC2__");
625 if (LangOpts.ObjCExceptions)
626 Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
629 if (LangOpts.getGC() != LangOptions::NonGC)
630 Builder.defineMacro("__OBJC_GC__");
632 if (LangOpts.ObjCRuntime.isNeXTFamily())
633 Builder.defineMacro("__NEXT_RUNTIME__");
635 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) {
636 auto version = LangOpts.ObjCRuntime.getVersion();
637 std::string versionString = "1";
638 // Don't rely on the tuple argument, because we can be asked to target
639 // later ABIs than we actually support, so clamp these values to those
640 // currently supported
641 if (version >= VersionTuple(2, 0))
642 Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", "20");
644 Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__",
645 "1" + Twine(std::min(8U, version.getMinor().getValueOr(0))));
648 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
649 VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
652 if (tuple.getMinor().hasValue())
653 minor = tuple.getMinor().getValue();
655 unsigned subminor = 0;
656 if (tuple.getSubminor().hasValue())
657 subminor = tuple.getSubminor().getValue();
659 Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
660 Twine(tuple.getMajor() * 10000 + minor * 100 +
664 Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
665 Builder.defineMacro("IBOutletCollection(ClassName)",
666 "__attribute__((iboutletcollection(ClassName)))");
667 Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
668 Builder.defineMacro("IBInspectable", "");
669 Builder.defineMacro("IB_DESIGNABLE", "");
672 // Define a macro that describes the Objective-C boolean type even for C
673 // and C++ since BOOL can be used from non Objective-C code.
674 Builder.defineMacro("__OBJC_BOOL_IS_BOOL",
675 Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
677 if (LangOpts.CPlusPlus)
678 InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
680 // darwin_constant_cfstrings controls this. This is also dependent
681 // on other things like the runtime I believe. This is set even for C code.
682 if (!LangOpts.NoConstantCFStrings)
683 Builder.defineMacro("__CONSTANT_CFSTRINGS__");
686 Builder.defineMacro("OBJC_NEW_PROPERTIES");
688 if (LangOpts.PascalStrings)
689 Builder.defineMacro("__PASCAL_STRINGS__");
691 if (LangOpts.Blocks) {
692 Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
693 Builder.defineMacro("__BLOCKS__");
696 if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
697 Builder.defineMacro("__EXCEPTIONS");
698 if (!LangOpts.MSVCCompat && LangOpts.RTTI)
699 Builder.defineMacro("__GXX_RTTI");
701 if (LangOpts.SjLjExceptions)
702 Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
703 else if (LangOpts.SEHExceptions)
704 Builder.defineMacro("__SEH__");
705 else if (LangOpts.DWARFExceptions &&
706 (TI.getTriple().isThumb() || TI.getTriple().isARM()))
707 Builder.defineMacro("__ARM_DWARF_EH__");
709 if (LangOpts.Deprecated)
710 Builder.defineMacro("__DEPRECATED");
712 if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus) {
713 Builder.defineMacro("__GNUG__", "4");
714 Builder.defineMacro("__GXX_WEAK__");
715 Builder.defineMacro("__private_extern__", "extern");
718 if (LangOpts.MicrosoftExt) {
719 if (LangOpts.WChar) {
720 // wchar_t supported as a keyword.
721 Builder.defineMacro("_WCHAR_T_DEFINED");
722 Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
726 if (LangOpts.Optimize)
727 Builder.defineMacro("__OPTIMIZE__");
728 if (LangOpts.OptimizeSize)
729 Builder.defineMacro("__OPTIMIZE_SIZE__");
731 if (LangOpts.FastMath)
732 Builder.defineMacro("__FAST_MATH__");
734 // Initialize target-specific preprocessor defines.
736 // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
737 // to the macro __BYTE_ORDER (no trailing underscores)
738 // from glibc's <endian.h> header.
739 // We don't support the PDP-11 as a target, but include
740 // the define so it can still be compared against.
741 Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
742 Builder.defineMacro("__ORDER_BIG_ENDIAN__", "4321");
743 Builder.defineMacro("__ORDER_PDP_ENDIAN__", "3412");
744 if (TI.isBigEndian()) {
745 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
746 Builder.defineMacro("__BIG_ENDIAN__");
748 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
749 Builder.defineMacro("__LITTLE_ENDIAN__");
752 if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
753 && TI.getIntWidth() == 32) {
754 Builder.defineMacro("_LP64");
755 Builder.defineMacro("__LP64__");
758 if (TI.getPointerWidth(0) == 32 && TI.getLongWidth() == 32
759 && TI.getIntWidth() == 32) {
760 Builder.defineMacro("_ILP32");
761 Builder.defineMacro("__ILP32__");
764 // Define type sizing macros based on the target properties.
765 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
766 Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth()));
768 DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
769 DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
770 DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
771 DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
772 DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
773 DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
774 DefineTypeSize("__WINT_MAX__", TI.getWIntType(), TI, Builder);
775 DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
776 DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
778 DefineTypeSize("__UINTMAX_MAX__", TI.getUIntMaxType(), TI, Builder);
779 DefineTypeSize("__PTRDIFF_MAX__", TI.getPtrDiffType(0), TI, Builder);
780 DefineTypeSize("__INTPTR_MAX__", TI.getIntPtrType(), TI, Builder);
781 DefineTypeSize("__UINTPTR_MAX__", TI.getUIntPtrType(), TI, Builder);
783 DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
784 DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
785 DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
786 DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
787 DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
788 DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
789 DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
790 DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
791 DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
792 TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
793 DefineTypeSizeof("__SIZEOF_SIZE_T__",
794 TI.getTypeWidth(TI.getSizeType()), TI, Builder);
795 DefineTypeSizeof("__SIZEOF_WCHAR_T__",
796 TI.getTypeWidth(TI.getWCharType()), TI, Builder);
797 DefineTypeSizeof("__SIZEOF_WINT_T__",
798 TI.getTypeWidth(TI.getWIntType()), TI, Builder);
799 if (TI.hasInt128Type())
800 DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
802 DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
803 DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder);
804 Builder.defineMacro("__INTMAX_C_SUFFIX__",
805 TI.getTypeConstantSuffix(TI.getIntMaxType()));
806 DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
807 DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
808 Builder.defineMacro("__UINTMAX_C_SUFFIX__",
809 TI.getTypeConstantSuffix(TI.getUIntMaxType()));
810 DefineTypeWidth("__INTMAX_WIDTH__", TI.getIntMaxType(), TI, Builder);
811 DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
812 DefineFmt("__PTRDIFF", TI.getPtrDiffType(0), TI, Builder);
813 DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
814 DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
815 DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder);
816 DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
817 DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
818 DefineFmt("__SIZE", TI.getSizeType(), TI, Builder);
819 DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
820 DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
821 DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
822 DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
823 DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
824 DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
825 DefineTypeSize("__SIG_ATOMIC_MAX__", TI.getSigAtomicType(), TI, Builder);
826 DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
827 DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
829 DefineTypeWidth("__UINTMAX_WIDTH__", TI.getUIntMaxType(), TI, Builder);
830 DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder);
831 DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
832 DefineTypeWidth("__UINTPTR_WIDTH__", TI.getUIntPtrType(), TI, Builder);
834 DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16");
835 DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
836 DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
837 DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
839 // Define a __POINTER_WIDTH__ macro for stdint.h.
840 Builder.defineMacro("__POINTER_WIDTH__",
841 Twine((int)TI.getPointerWidth(0)));
843 // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
844 Builder.defineMacro("__BIGGEST_ALIGNMENT__",
845 Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
847 if (!LangOpts.CharIsSigned)
848 Builder.defineMacro("__CHAR_UNSIGNED__");
850 if (!TargetInfo::isTypeSigned(TI.getWCharType()))
851 Builder.defineMacro("__WCHAR_UNSIGNED__");
853 if (!TargetInfo::isTypeSigned(TI.getWIntType()))
854 Builder.defineMacro("__WINT_UNSIGNED__");
856 // Define exact-width integer types for stdint.h
857 DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder);
859 if (TI.getShortWidth() > TI.getCharWidth())
860 DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
862 if (TI.getIntWidth() > TI.getShortWidth())
863 DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
865 if (TI.getLongWidth() > TI.getIntWidth())
866 DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
868 if (TI.getLongLongWidth() > TI.getLongWidth())
869 DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
871 DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder);
872 DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder);
873 DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder);
875 if (TI.getShortWidth() > TI.getCharWidth()) {
876 DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder);
877 DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder);
878 DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder);
881 if (TI.getIntWidth() > TI.getShortWidth()) {
882 DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder);
883 DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder);
884 DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder);
887 if (TI.getLongWidth() > TI.getIntWidth()) {
888 DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder);
889 DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder);
890 DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder);
893 if (TI.getLongLongWidth() > TI.getLongWidth()) {
894 DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder);
895 DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder);
896 DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder);
899 DefineLeastWidthIntType(8, true, TI, Builder);
900 DefineLeastWidthIntType(8, false, TI, Builder);
901 DefineLeastWidthIntType(16, true, TI, Builder);
902 DefineLeastWidthIntType(16, false, TI, Builder);
903 DefineLeastWidthIntType(32, true, TI, Builder);
904 DefineLeastWidthIntType(32, false, TI, Builder);
905 DefineLeastWidthIntType(64, true, TI, Builder);
906 DefineLeastWidthIntType(64, false, TI, Builder);
908 DefineFastIntType(8, true, TI, Builder);
909 DefineFastIntType(8, false, TI, Builder);
910 DefineFastIntType(16, true, TI, Builder);
911 DefineFastIntType(16, false, TI, Builder);
912 DefineFastIntType(32, true, TI, Builder);
913 DefineFastIntType(32, false, TI, Builder);
914 DefineFastIntType(64, true, TI, Builder);
915 DefineFastIntType(64, false, TI, Builder);
917 char UserLabelPrefix[2] = {TI.getDataLayout().getGlobalPrefix(), 0};
918 Builder.defineMacro("__USER_LABEL_PREFIX__", UserLabelPrefix);
920 if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
921 Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
923 Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
925 if (!LangOpts.MSVCCompat) {
926 if (LangOpts.GNUInline || LangOpts.CPlusPlus)
927 Builder.defineMacro("__GNUC_GNU_INLINE__");
929 Builder.defineMacro("__GNUC_STDC_INLINE__");
931 // The value written by __atomic_test_and_set.
932 // FIXME: This is target-dependent.
933 Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
936 auto addLockFreeMacros = [&](const llvm::Twine &Prefix) {
937 // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
938 unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
939 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \
940 Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE", \
941 getLockFreeValue(TI.get##Type##Width(), \
942 TI.get##Type##Align(), \
944 DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
945 DEFINE_LOCK_FREE_MACRO(CHAR, Char);
947 DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char.
948 DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
949 DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
950 DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
951 DEFINE_LOCK_FREE_MACRO(SHORT, Short);
952 DEFINE_LOCK_FREE_MACRO(INT, Int);
953 DEFINE_LOCK_FREE_MACRO(LONG, Long);
954 DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
955 Builder.defineMacro(Prefix + "POINTER_LOCK_FREE",
956 getLockFreeValue(TI.getPointerWidth(0),
957 TI.getPointerAlign(0),
959 #undef DEFINE_LOCK_FREE_MACRO
961 addLockFreeMacros("__CLANG_ATOMIC_");
962 if (!LangOpts.MSVCCompat)
963 addLockFreeMacros("__GCC_ATOMIC_");
965 if (LangOpts.NoInlineDefine)
966 Builder.defineMacro("__NO_INLINE__");
968 if (unsigned PICLevel = LangOpts.PICLevel) {
969 Builder.defineMacro("__PIC__", Twine(PICLevel));
970 Builder.defineMacro("__pic__", Twine(PICLevel));
972 Builder.defineMacro("__PIE__", Twine(PICLevel));
973 Builder.defineMacro("__pie__", Twine(PICLevel));
977 // Macros to control C99 numerics and <float.h>
978 Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
979 Builder.defineMacro("__FLT_RADIX__", "2");
980 Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__");
982 if (LangOpts.getStackProtector() == LangOptions::SSPOn)
983 Builder.defineMacro("__SSP__");
984 else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
985 Builder.defineMacro("__SSP_STRONG__", "2");
986 else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
987 Builder.defineMacro("__SSP_ALL__", "3");
989 // Define a macro that exists only when using the static analyzer.
990 if (FEOpts.ProgramAction == frontend::RunAnalysis)
991 Builder.defineMacro("__clang_analyzer__");
993 if (LangOpts.FastRelaxedMath)
994 Builder.defineMacro("__FAST_RELAXED_MATH__");
996 if (FEOpts.ProgramAction == frontend::RewriteObjC ||
997 LangOpts.getGC() != LangOptions::NonGC) {
998 Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
999 Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))");
1000 Builder.defineMacro("__autoreleasing", "");
1001 Builder.defineMacro("__unsafe_unretained", "");
1002 } else if (LangOpts.ObjC) {
1003 Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
1004 Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
1005 Builder.defineMacro("__autoreleasing",
1006 "__attribute__((objc_ownership(autoreleasing)))");
1007 Builder.defineMacro("__unsafe_unretained",
1008 "__attribute__((objc_ownership(none)))");
1011 // On Darwin, there are __double_underscored variants of the type
1012 // nullability qualifiers.
1013 if (TI.getTriple().isOSDarwin()) {
1014 Builder.defineMacro("__nonnull", "_Nonnull");
1015 Builder.defineMacro("__null_unspecified", "_Null_unspecified");
1016 Builder.defineMacro("__nullable", "_Nullable");
1019 // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and
1020 // the corresponding simulator targets.
1021 if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment())
1022 Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1");
1024 // OpenMP definition
1026 // In implementations that support a preprocessor, the _OPENMP
1027 // macro name is defined to have the decimal value yyyymm where
1028 // yyyy and mm are the year and the month designations of the
1029 // version of the OpenMP API that the implementation support.
1030 if (!LangOpts.OpenMPSimd) {
1031 switch (LangOpts.OpenMP) {
1035 Builder.defineMacro("_OPENMP", "201307");
1038 Builder.defineMacro("_OPENMP", "201511");
1041 // Default version is OpenMP 3.1
1042 Builder.defineMacro("_OPENMP", "201107");
1047 // CUDA device path compilaton
1048 if (LangOpts.CUDAIsDevice && !LangOpts.HIP) {
1049 // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
1050 // backend's target defines.
1051 Builder.defineMacro("__CUDA_ARCH__");
1054 // We need to communicate this to our CUDA header wrapper, which in turn
1055 // informs the proper CUDA headers of this choice.
1056 if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) {
1057 Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__");
1060 // OpenCL definitions.
1061 if (LangOpts.OpenCL) {
1062 #define OPENCLEXT(Ext) \
1063 if (TI.getSupportedOpenCLOpts().isSupported(#Ext, \
1064 LangOpts.OpenCLVersion)) \
1065 Builder.defineMacro(#Ext);
1066 #include "clang/Basic/OpenCLExtensions.def"
1068 auto Arch = TI.getTriple().getArch();
1069 if (Arch == llvm::Triple::spir || Arch == llvm::Triple::spir64)
1070 Builder.defineMacro("__IMAGE_SUPPORT__");
1073 if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1074 // For each extended integer type, g++ defines a macro mapping the
1075 // index of the type (0 in this case) in some list of extended types
1077 Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128");
1078 Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128");
1081 // Get other target #defines.
1082 TI.getTargetDefines(LangOpts, Builder);
1085 /// InitializePreprocessor - Initialize the preprocessor getting it and the
1086 /// environment ready to process a single file. This returns true on error.
1088 void clang::InitializePreprocessor(
1089 Preprocessor &PP, const PreprocessorOptions &InitOpts,
1090 const PCHContainerReader &PCHContainerRdr,
1091 const FrontendOptions &FEOpts) {
1092 const LangOptions &LangOpts = PP.getLangOpts();
1093 std::string PredefineBuffer;
1094 PredefineBuffer.reserve(4080);
1095 llvm::raw_string_ostream Predefines(PredefineBuffer);
1096 MacroBuilder Builder(Predefines);
1098 // Emit line markers for various builtin sections of the file. We don't do
1099 // this in asm preprocessor mode, because "# 4" is not a line marker directive
1101 if (!PP.getLangOpts().AsmPreprocessor)
1102 Builder.append("# 1 \"<built-in>\" 3");
1104 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1105 if (InitOpts.UsePredefines) {
1106 // FIXME: This will create multiple definitions for most of the predefined
1107 // macros. This is not the right way to handle this.
1108 if ((LangOpts.CUDA || LangOpts.OpenMPIsDevice) && PP.getAuxTargetInfo())
1109 InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts,
1112 InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts, Builder);
1114 // Install definitions to make Objective-C++ ARC work well with various
1115 // C++ Standard Library implementations.
1116 if (LangOpts.ObjC && LangOpts.CPlusPlus &&
1117 (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1118 switch (InitOpts.ObjCXXARCStandardLibrary) {
1123 case ARCXX_libstdcxx:
1124 AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1130 // Even with predefines off, some macros are still predefined.
1131 // These should all be defined in the preprocessor according to the
1132 // current language configuration.
1133 InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
1136 // Add on the predefines from the driver. Wrap in a #line directive to report
1137 // that they come from the command line.
1138 if (!PP.getLangOpts().AsmPreprocessor)
1139 Builder.append("# 1 \"<command line>\" 1");
1141 // Process #define's and #undef's in the order they are given.
1142 for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1143 if (InitOpts.Macros[i].second) // isUndef
1144 Builder.undefineMacro(InitOpts.Macros[i].first);
1146 DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
1147 PP.getDiagnostics());
1150 // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1151 if (!PP.getLangOpts().AsmPreprocessor)
1152 Builder.append("# 1 \"<built-in>\" 2");
1154 // If -imacros are specified, include them now. These are processed before
1155 // any -include directives.
1156 for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1157 AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
1159 // Process -include-pch/-include-pth directives.
1160 if (!InitOpts.ImplicitPCHInclude.empty())
1161 AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1162 InitOpts.ImplicitPCHInclude);
1164 // Process -include directives.
1165 for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1166 const std::string &Path = InitOpts.Includes[i];
1167 AddImplicitInclude(Builder, Path);
1170 // Instruct the preprocessor to skip the preamble.
1171 PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
1172 InitOpts.PrecompiledPreambleBytes.second);
1174 // Copy PredefinedBuffer into the Preprocessor.
1175 PP.setPredefines(Predefines.str());