1 //===--- InitPreprocessor.cpp - PP initialization code. ---------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file implements the clang::InitializePreprocessor function. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "clang/Basic/FileManager.h" 14 #include "clang/Basic/MacroBuilder.h" 15 #include "clang/Basic/SourceManager.h" 16 #include "clang/Basic/SyncScope.h" 17 #include "clang/Basic/TargetInfo.h" 18 #include "clang/Basic/Version.h" 19 #include "clang/Frontend/FrontendDiagnostic.h" 20 #include "clang/Frontend/FrontendOptions.h" 21 #include "clang/Frontend/Utils.h" 22 #include "clang/Lex/HeaderSearch.h" 23 #include "clang/Lex/Preprocessor.h" 24 #include "clang/Lex/PreprocessorOptions.h" 25 #include "clang/Serialization/ASTReader.h" 26 #include "llvm/ADT/APFloat.h" 27 using namespace clang; 28 29 static bool MacroBodyEndsInBackslash(StringRef MacroBody) { 30 while (!MacroBody.empty() && isWhitespace(MacroBody.back())) 31 MacroBody = MacroBody.drop_back(); 32 return !MacroBody.empty() && MacroBody.back() == '\\'; 33 } 34 35 // Append a #define line to Buf for Macro. Macro should be of the form XXX, 36 // in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit 37 // "#define XXX Y z W". To get a #define with no value, use "XXX=". 38 static void DefineBuiltinMacro(MacroBuilder &Builder, StringRef Macro, 39 DiagnosticsEngine &Diags) { 40 std::pair<StringRef, StringRef> MacroPair = Macro.split('='); 41 StringRef MacroName = MacroPair.first; 42 StringRef MacroBody = MacroPair.second; 43 if (MacroName.size() != Macro.size()) { 44 // Per GCC -D semantics, the macro ends at \n if it exists. 45 StringRef::size_type End = MacroBody.find_first_of("\n\r"); 46 if (End != StringRef::npos) 47 Diags.Report(diag::warn_fe_macro_contains_embedded_newline) 48 << MacroName; 49 MacroBody = MacroBody.substr(0, End); 50 // We handle macro bodies which end in a backslash by appending an extra 51 // backslash+newline. This makes sure we don't accidentally treat the 52 // backslash as a line continuation marker. 53 if (MacroBodyEndsInBackslash(MacroBody)) 54 Builder.defineMacro(MacroName, Twine(MacroBody) + "\\\n"); 55 else 56 Builder.defineMacro(MacroName, MacroBody); 57 } else { 58 // Push "macroname 1". 59 Builder.defineMacro(Macro); 60 } 61 } 62 63 /// AddImplicitInclude - Add an implicit \#include of the specified file to the 64 /// predefines buffer. 65 /// As these includes are generated by -include arguments the header search 66 /// logic is going to search relatively to the current working directory. 67 static void AddImplicitInclude(MacroBuilder &Builder, StringRef File) { 68 Builder.append(Twine("#include \"") + File + "\""); 69 } 70 71 static void AddImplicitIncludeMacros(MacroBuilder &Builder, StringRef File) { 72 Builder.append(Twine("#__include_macros \"") + File + "\""); 73 // Marker token to stop the __include_macros fetch loop. 74 Builder.append("##"); // ##? 75 } 76 77 /// Add an implicit \#include using the original file used to generate 78 /// a PCH file. 79 static void AddImplicitIncludePCH(MacroBuilder &Builder, Preprocessor &PP, 80 const PCHContainerReader &PCHContainerRdr, 81 StringRef ImplicitIncludePCH) { 82 std::string OriginalFile = 83 ASTReader::getOriginalSourceFile(ImplicitIncludePCH, PP.getFileManager(), 84 PCHContainerRdr, PP.getDiagnostics()); 85 if (OriginalFile.empty()) 86 return; 87 88 AddImplicitInclude(Builder, OriginalFile); 89 } 90 91 /// PickFP - This is used to pick a value based on the FP semantics of the 92 /// specified FP model. 93 template <typename T> 94 static T PickFP(const llvm::fltSemantics *Sem, T IEEEHalfVal, T IEEESingleVal, 95 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal, 96 T IEEEQuadVal) { 97 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEhalf()) 98 return IEEEHalfVal; 99 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle()) 100 return IEEESingleVal; 101 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble()) 102 return IEEEDoubleVal; 103 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended()) 104 return X87DoubleExtendedVal; 105 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble()) 106 return PPCDoubleDoubleVal; 107 assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad()); 108 return IEEEQuadVal; 109 } 110 111 static void DefineFloatMacros(MacroBuilder &Builder, StringRef Prefix, 112 const llvm::fltSemantics *Sem, StringRef Ext) { 113 const char *DenormMin, *Epsilon, *Max, *Min; 114 DenormMin = PickFP(Sem, "5.9604644775390625e-8", "1.40129846e-45", 115 "4.9406564584124654e-324", "3.64519953188247460253e-4951", 116 "4.94065645841246544176568792868221e-324", 117 "6.47517511943802511092443895822764655e-4966"); 118 int Digits = PickFP(Sem, 3, 6, 15, 18, 31, 33); 119 int DecimalDigits = PickFP(Sem, 5, 9, 17, 21, 33, 36); 120 Epsilon = PickFP(Sem, "9.765625e-4", "1.19209290e-7", 121 "2.2204460492503131e-16", "1.08420217248550443401e-19", 122 "4.94065645841246544176568792868221e-324", 123 "1.92592994438723585305597794258492732e-34"); 124 int MantissaDigits = PickFP(Sem, 11, 24, 53, 64, 106, 113); 125 int Min10Exp = PickFP(Sem, -4, -37, -307, -4931, -291, -4931); 126 int Max10Exp = PickFP(Sem, 4, 38, 308, 4932, 308, 4932); 127 int MinExp = PickFP(Sem, -13, -125, -1021, -16381, -968, -16381); 128 int MaxExp = PickFP(Sem, 16, 128, 1024, 16384, 1024, 16384); 129 Min = PickFP(Sem, "6.103515625e-5", "1.17549435e-38", "2.2250738585072014e-308", 130 "3.36210314311209350626e-4932", 131 "2.00416836000897277799610805135016e-292", 132 "3.36210314311209350626267781732175260e-4932"); 133 Max = PickFP(Sem, "6.5504e+4", "3.40282347e+38", "1.7976931348623157e+308", 134 "1.18973149535723176502e+4932", 135 "1.79769313486231580793728971405301e+308", 136 "1.18973149535723176508575932662800702e+4932"); 137 138 SmallString<32> DefPrefix; 139 DefPrefix = "__"; 140 DefPrefix += Prefix; 141 DefPrefix += "_"; 142 143 Builder.defineMacro(DefPrefix + "DENORM_MIN__", Twine(DenormMin)+Ext); 144 Builder.defineMacro(DefPrefix + "HAS_DENORM__"); 145 Builder.defineMacro(DefPrefix + "DIG__", Twine(Digits)); 146 Builder.defineMacro(DefPrefix + "DECIMAL_DIG__", Twine(DecimalDigits)); 147 Builder.defineMacro(DefPrefix + "EPSILON__", Twine(Epsilon)+Ext); 148 Builder.defineMacro(DefPrefix + "HAS_INFINITY__"); 149 Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__"); 150 Builder.defineMacro(DefPrefix + "MANT_DIG__", Twine(MantissaDigits)); 151 152 Builder.defineMacro(DefPrefix + "MAX_10_EXP__", Twine(Max10Exp)); 153 Builder.defineMacro(DefPrefix + "MAX_EXP__", Twine(MaxExp)); 154 Builder.defineMacro(DefPrefix + "MAX__", Twine(Max)+Ext); 155 156 Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+Twine(Min10Exp)+")"); 157 Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+Twine(MinExp)+")"); 158 Builder.defineMacro(DefPrefix + "MIN__", Twine(Min)+Ext); 159 } 160 161 162 /// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro 163 /// named MacroName with the max value for a type with width 'TypeWidth' a 164 /// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL). 165 static void DefineTypeSize(const Twine &MacroName, unsigned TypeWidth, 166 StringRef ValSuffix, bool isSigned, 167 MacroBuilder &Builder) { 168 llvm::APInt MaxVal = isSigned ? llvm::APInt::getSignedMaxValue(TypeWidth) 169 : llvm::APInt::getMaxValue(TypeWidth); 170 Builder.defineMacro(MacroName, MaxVal.toString(10, isSigned) + ValSuffix); 171 } 172 173 /// DefineTypeSize - An overloaded helper that uses TargetInfo to determine 174 /// the width, suffix, and signedness of the given type 175 static void DefineTypeSize(const Twine &MacroName, TargetInfo::IntType Ty, 176 const TargetInfo &TI, MacroBuilder &Builder) { 177 DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty), 178 TI.isTypeSigned(Ty), Builder); 179 } 180 181 static void DefineFmt(const Twine &Prefix, TargetInfo::IntType Ty, 182 const TargetInfo &TI, MacroBuilder &Builder) { 183 bool IsSigned = TI.isTypeSigned(Ty); 184 StringRef FmtModifier = TI.getTypeFormatModifier(Ty); 185 for (const char *Fmt = IsSigned ? "di" : "ouxX"; *Fmt; ++Fmt) { 186 Builder.defineMacro(Prefix + "_FMT" + Twine(*Fmt) + "__", 187 Twine("\"") + FmtModifier + Twine(*Fmt) + "\""); 188 } 189 } 190 191 static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty, 192 MacroBuilder &Builder) { 193 Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty)); 194 } 195 196 static void DefineTypeWidth(StringRef MacroName, TargetInfo::IntType Ty, 197 const TargetInfo &TI, MacroBuilder &Builder) { 198 Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty))); 199 } 200 201 static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth, 202 const TargetInfo &TI, MacroBuilder &Builder) { 203 Builder.defineMacro(MacroName, 204 Twine(BitWidth / TI.getCharWidth())); 205 } 206 207 static void DefineExactWidthIntType(TargetInfo::IntType Ty, 208 const TargetInfo &TI, 209 MacroBuilder &Builder) { 210 int TypeWidth = TI.getTypeWidth(Ty); 211 bool IsSigned = TI.isTypeSigned(Ty); 212 213 // Use the target specified int64 type, when appropriate, so that [u]int64_t 214 // ends up being defined in terms of the correct type. 215 if (TypeWidth == 64) 216 Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type(); 217 218 const char *Prefix = IsSigned ? "__INT" : "__UINT"; 219 220 DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder); 221 DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder); 222 223 StringRef ConstSuffix(TI.getTypeConstantSuffix(Ty)); 224 Builder.defineMacro(Prefix + Twine(TypeWidth) + "_C_SUFFIX__", ConstSuffix); 225 } 226 227 static void DefineExactWidthIntTypeSize(TargetInfo::IntType Ty, 228 const TargetInfo &TI, 229 MacroBuilder &Builder) { 230 int TypeWidth = TI.getTypeWidth(Ty); 231 bool IsSigned = TI.isTypeSigned(Ty); 232 233 // Use the target specified int64 type, when appropriate, so that [u]int64_t 234 // ends up being defined in terms of the correct type. 235 if (TypeWidth == 64) 236 Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type(); 237 238 const char *Prefix = IsSigned ? "__INT" : "__UINT"; 239 DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder); 240 } 241 242 static void DefineLeastWidthIntType(unsigned TypeWidth, bool IsSigned, 243 const TargetInfo &TI, 244 MacroBuilder &Builder) { 245 TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned); 246 if (Ty == TargetInfo::NoInt) 247 return; 248 249 const char *Prefix = IsSigned ? "__INT_LEAST" : "__UINT_LEAST"; 250 DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder); 251 DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder); 252 DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder); 253 } 254 255 static void DefineFastIntType(unsigned TypeWidth, bool IsSigned, 256 const TargetInfo &TI, MacroBuilder &Builder) { 257 // stdint.h currently defines the fast int types as equivalent to the least 258 // types. 259 TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned); 260 if (Ty == TargetInfo::NoInt) 261 return; 262 263 const char *Prefix = IsSigned ? "__INT_FAST" : "__UINT_FAST"; 264 DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder); 265 DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder); 266 267 DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder); 268 } 269 270 271 /// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with 272 /// the specified properties. 273 static const char *getLockFreeValue(unsigned TypeWidth, unsigned TypeAlign, 274 unsigned InlineWidth) { 275 // Fully-aligned, power-of-2 sizes no larger than the inline 276 // width will be inlined as lock-free operations. 277 if (TypeWidth == TypeAlign && (TypeWidth & (TypeWidth - 1)) == 0 && 278 TypeWidth <= InlineWidth) 279 return "2"; // "always lock free" 280 // We cannot be certain what operations the lib calls might be 281 // able to implement as lock-free on future processors. 282 return "1"; // "sometimes lock free" 283 } 284 285 /// Add definitions required for a smooth interaction between 286 /// Objective-C++ automated reference counting and libstdc++ (4.2). 287 static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts, 288 MacroBuilder &Builder) { 289 Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR"); 290 291 std::string Result; 292 { 293 // Provide specializations for the __is_scalar type trait so that 294 // lifetime-qualified objects are not considered "scalar" types, which 295 // libstdc++ uses as an indicator of the presence of trivial copy, assign, 296 // default-construct, and destruct semantics (none of which hold for 297 // lifetime-qualified objects in ARC). 298 llvm::raw_string_ostream Out(Result); 299 300 Out << "namespace std {\n" 301 << "\n" 302 << "struct __true_type;\n" 303 << "struct __false_type;\n" 304 << "\n"; 305 306 Out << "template<typename _Tp> struct __is_scalar;\n" 307 << "\n"; 308 309 if (LangOpts.ObjCAutoRefCount) { 310 Out << "template<typename _Tp>\n" 311 << "struct __is_scalar<__attribute__((objc_ownership(strong))) _Tp> {\n" 312 << " enum { __value = 0 };\n" 313 << " typedef __false_type __type;\n" 314 << "};\n" 315 << "\n"; 316 } 317 318 if (LangOpts.ObjCWeak) { 319 Out << "template<typename _Tp>\n" 320 << "struct __is_scalar<__attribute__((objc_ownership(weak))) _Tp> {\n" 321 << " enum { __value = 0 };\n" 322 << " typedef __false_type __type;\n" 323 << "};\n" 324 << "\n"; 325 } 326 327 if (LangOpts.ObjCAutoRefCount) { 328 Out << "template<typename _Tp>\n" 329 << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))" 330 << " _Tp> {\n" 331 << " enum { __value = 0 };\n" 332 << " typedef __false_type __type;\n" 333 << "};\n" 334 << "\n"; 335 } 336 337 Out << "}\n"; 338 } 339 Builder.append(Result); 340 } 341 342 static void InitializeStandardPredefinedMacros(const TargetInfo &TI, 343 const LangOptions &LangOpts, 344 const FrontendOptions &FEOpts, 345 MacroBuilder &Builder) { 346 if (!LangOpts.MSVCCompat && !LangOpts.TraditionalCPP) 347 Builder.defineMacro("__STDC__"); 348 if (LangOpts.Freestanding) 349 Builder.defineMacro("__STDC_HOSTED__", "0"); 350 else 351 Builder.defineMacro("__STDC_HOSTED__"); 352 353 if (!LangOpts.CPlusPlus) { 354 if (LangOpts.C17) 355 Builder.defineMacro("__STDC_VERSION__", "201710L"); 356 else if (LangOpts.C11) 357 Builder.defineMacro("__STDC_VERSION__", "201112L"); 358 else if (LangOpts.C99) 359 Builder.defineMacro("__STDC_VERSION__", "199901L"); 360 else if (!LangOpts.GNUMode && LangOpts.Digraphs) 361 Builder.defineMacro("__STDC_VERSION__", "199409L"); 362 } else { 363 // FIXME: Use correct value for C++20. 364 if (LangOpts.CPlusPlus2a) 365 Builder.defineMacro("__cplusplus", "201707L"); 366 // C++17 [cpp.predefined]p1: 367 // The name __cplusplus is defined to the value 201703L when compiling a 368 // C++ translation unit. 369 else if (LangOpts.CPlusPlus17) 370 Builder.defineMacro("__cplusplus", "201703L"); 371 // C++1y [cpp.predefined]p1: 372 // The name __cplusplus is defined to the value 201402L when compiling a 373 // C++ translation unit. 374 else if (LangOpts.CPlusPlus14) 375 Builder.defineMacro("__cplusplus", "201402L"); 376 // C++11 [cpp.predefined]p1: 377 // The name __cplusplus is defined to the value 201103L when compiling a 378 // C++ translation unit. 379 else if (LangOpts.CPlusPlus11) 380 Builder.defineMacro("__cplusplus", "201103L"); 381 // C++03 [cpp.predefined]p1: 382 // The name __cplusplus is defined to the value 199711L when compiling a 383 // C++ translation unit. 384 else 385 Builder.defineMacro("__cplusplus", "199711L"); 386 387 // C++1z [cpp.predefined]p1: 388 // An integer literal of type std::size_t whose value is the alignment 389 // guaranteed by a call to operator new(std::size_t) 390 // 391 // We provide this in all language modes, since it seems generally useful. 392 Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__", 393 Twine(TI.getNewAlign() / TI.getCharWidth()) + 394 TI.getTypeConstantSuffix(TI.getSizeType())); 395 } 396 397 // In C11 these are environment macros. In C++11 they are only defined 398 // as part of <cuchar>. To prevent breakage when mixing C and C++ 399 // code, define these macros unconditionally. We can define them 400 // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit 401 // and 32-bit character literals. 402 Builder.defineMacro("__STDC_UTF_16__", "1"); 403 Builder.defineMacro("__STDC_UTF_32__", "1"); 404 405 if (LangOpts.ObjC) 406 Builder.defineMacro("__OBJC__"); 407 408 // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros. 409 if (LangOpts.OpenCL) { 410 if (LangOpts.CPlusPlus) { 411 if (LangOpts.OpenCLCPlusPlusVersion == 100) 412 Builder.defineMacro("__OPENCL_CPP_VERSION__", "100"); 413 else 414 llvm_unreachable("Unsupported C++ version for OpenCL"); 415 Builder.defineMacro("__CL_CPP_VERSION_1_0__", "100"); 416 } else { 417 // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the 418 // language standard with which the program is compiled. __OPENCL_VERSION__ 419 // is for the OpenCL version supported by the OpenCL device, which is not 420 // necessarily the language standard with which the program is compiled. 421 // A shared OpenCL header file requires a macro to indicate the language 422 // standard. As a workaround, __OPENCL_C_VERSION__ is defined for 423 // OpenCL v1.0 and v1.1. 424 switch (LangOpts.OpenCLVersion) { 425 case 100: 426 Builder.defineMacro("__OPENCL_C_VERSION__", "100"); 427 break; 428 case 110: 429 Builder.defineMacro("__OPENCL_C_VERSION__", "110"); 430 break; 431 case 120: 432 Builder.defineMacro("__OPENCL_C_VERSION__", "120"); 433 break; 434 case 200: 435 Builder.defineMacro("__OPENCL_C_VERSION__", "200"); 436 break; 437 default: 438 llvm_unreachable("Unsupported OpenCL version"); 439 } 440 } 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"); 445 446 if (TI.isLittleEndian()) 447 Builder.defineMacro("__ENDIAN_LITTLE__"); 448 449 if (LangOpts.FastRelaxedMath) 450 Builder.defineMacro("__FAST_RELAXED_MATH__"); 451 } 452 // Not "standard" per se, but available even with the -undef flag. 453 if (LangOpts.AsmPreprocessor) 454 Builder.defineMacro("__ASSEMBLER__"); 455 if (LangOpts.CUDA && !LangOpts.HIP) 456 Builder.defineMacro("__CUDA__"); 457 if (LangOpts.HIP) { 458 Builder.defineMacro("__HIP__"); 459 Builder.defineMacro("__HIPCC__"); 460 if (LangOpts.CUDAIsDevice) 461 Builder.defineMacro("__HIP_DEVICE_COMPILE__"); 462 } 463 } 464 465 /// Initialize the predefined C++ language feature test macros defined in 466 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations". 467 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts, 468 MacroBuilder &Builder) { 469 // C++98 features. 470 if (LangOpts.RTTI) 471 Builder.defineMacro("__cpp_rtti", "199711L"); 472 if (LangOpts.CXXExceptions) 473 Builder.defineMacro("__cpp_exceptions", "199711L"); 474 475 // C++11 features. 476 if (LangOpts.CPlusPlus11) { 477 Builder.defineMacro("__cpp_unicode_characters", "200704L"); 478 Builder.defineMacro("__cpp_raw_strings", "200710L"); 479 Builder.defineMacro("__cpp_unicode_literals", "200710L"); 480 Builder.defineMacro("__cpp_user_defined_literals", "200809L"); 481 Builder.defineMacro("__cpp_lambdas", "200907L"); 482 Builder.defineMacro("__cpp_constexpr", 483 LangOpts.CPlusPlus17 ? "201603L" : 484 LangOpts.CPlusPlus14 ? "201304L" : "200704"); 485 Builder.defineMacro("__cpp_range_based_for", 486 LangOpts.CPlusPlus17 ? "201603L" : "200907"); 487 Builder.defineMacro("__cpp_static_assert", 488 LangOpts.CPlusPlus17 ? "201411L" : "200410"); 489 Builder.defineMacro("__cpp_decltype", "200707L"); 490 Builder.defineMacro("__cpp_attributes", "200809L"); 491 Builder.defineMacro("__cpp_rvalue_references", "200610L"); 492 Builder.defineMacro("__cpp_variadic_templates", "200704L"); 493 Builder.defineMacro("__cpp_initializer_lists", "200806L"); 494 Builder.defineMacro("__cpp_delegating_constructors", "200604L"); 495 Builder.defineMacro("__cpp_nsdmi", "200809L"); 496 Builder.defineMacro("__cpp_inheriting_constructors", "201511L"); 497 Builder.defineMacro("__cpp_ref_qualifiers", "200710L"); 498 Builder.defineMacro("__cpp_alias_templates", "200704L"); 499 } 500 if (LangOpts.ThreadsafeStatics) 501 Builder.defineMacro("__cpp_threadsafe_static_init", "200806L"); 502 503 // C++14 features. 504 if (LangOpts.CPlusPlus14) { 505 Builder.defineMacro("__cpp_binary_literals", "201304L"); 506 Builder.defineMacro("__cpp_digit_separators", "201309L"); 507 Builder.defineMacro("__cpp_init_captures", "201304L"); 508 Builder.defineMacro("__cpp_generic_lambdas", "201304L"); 509 Builder.defineMacro("__cpp_decltype_auto", "201304L"); 510 Builder.defineMacro("__cpp_return_type_deduction", "201304L"); 511 Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L"); 512 Builder.defineMacro("__cpp_variable_templates", "201304L"); 513 } 514 if (LangOpts.SizedDeallocation) 515 Builder.defineMacro("__cpp_sized_deallocation", "201309L"); 516 517 // C++17 features. 518 if (LangOpts.CPlusPlus17) { 519 Builder.defineMacro("__cpp_hex_float", "201603L"); 520 Builder.defineMacro("__cpp_inline_variables", "201606L"); 521 Builder.defineMacro("__cpp_noexcept_function_type", "201510L"); 522 Builder.defineMacro("__cpp_capture_star_this", "201603L"); 523 Builder.defineMacro("__cpp_if_constexpr", "201606L"); 524 Builder.defineMacro("__cpp_deduction_guides", "201703L"); 525 Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name) 526 Builder.defineMacro("__cpp_namespace_attributes", "201411L"); 527 Builder.defineMacro("__cpp_enumerator_attributes", "201411L"); 528 Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L"); 529 Builder.defineMacro("__cpp_variadic_using", "201611L"); 530 Builder.defineMacro("__cpp_aggregate_bases", "201603L"); 531 Builder.defineMacro("__cpp_structured_bindings", "201606L"); 532 Builder.defineMacro("__cpp_nontype_template_args", "201411L"); 533 Builder.defineMacro("__cpp_fold_expressions", "201603L"); 534 Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L"); 535 Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L"); 536 } 537 if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable) 538 Builder.defineMacro("__cpp_aligned_new", "201606L"); 539 if (LangOpts.RelaxedTemplateTemplateArgs) 540 Builder.defineMacro("__cpp_template_template_args", "201611L"); 541 542 // C++20 features. 543 if (LangOpts.CPlusPlus2a) 544 Builder.defineMacro("__cpp_conditional_explicit", "201806L"); 545 if (LangOpts.Char8) 546 Builder.defineMacro("__cpp_char8_t", "201811L"); 547 Builder.defineMacro("__cpp_impl_destroying_delete", "201806L"); 548 549 // TS features. 550 if (LangOpts.ConceptsTS) 551 Builder.defineMacro("__cpp_experimental_concepts", "1L"); 552 if (LangOpts.Coroutines) 553 Builder.defineMacro("__cpp_coroutines", "201703L"); 554 } 555 556 static void InitializePredefinedMacros(const TargetInfo &TI, 557 const LangOptions &LangOpts, 558 const FrontendOptions &FEOpts, 559 MacroBuilder &Builder) { 560 // Compiler version introspection macros. 561 Builder.defineMacro("__llvm__"); // LLVM Backend 562 Builder.defineMacro("__clang__"); // Clang Frontend 563 #define TOSTR2(X) #X 564 #define TOSTR(X) TOSTR2(X) 565 Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR)); 566 Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR)); 567 Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL)); 568 #undef TOSTR 569 #undef TOSTR2 570 Builder.defineMacro("__clang_version__", 571 "\"" CLANG_VERSION_STRING " " 572 + getClangFullRepositoryVersion() + "\""); 573 if (!LangOpts.MSVCCompat) { 574 // Currently claim to be compatible with GCC 4.2.1-5621, but only if we're 575 // not compiling for MSVC compatibility 576 Builder.defineMacro("__GNUC_MINOR__", "2"); 577 Builder.defineMacro("__GNUC_PATCHLEVEL__", "1"); 578 Builder.defineMacro("__GNUC__", "4"); 579 Builder.defineMacro("__GXX_ABI_VERSION", "1002"); 580 } 581 582 // Define macros for the C11 / C++11 memory orderings 583 Builder.defineMacro("__ATOMIC_RELAXED", "0"); 584 Builder.defineMacro("__ATOMIC_CONSUME", "1"); 585 Builder.defineMacro("__ATOMIC_ACQUIRE", "2"); 586 Builder.defineMacro("__ATOMIC_RELEASE", "3"); 587 Builder.defineMacro("__ATOMIC_ACQ_REL", "4"); 588 Builder.defineMacro("__ATOMIC_SEQ_CST", "5"); 589 590 // Define macros for the OpenCL memory scope. 591 // The values should match AtomicScopeOpenCLModel::ID enum. 592 static_assert( 593 static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 && 594 static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 && 595 static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 && 596 static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4, 597 "Invalid OpenCL memory scope enum definition"); 598 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0"); 599 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1"); 600 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2"); 601 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3"); 602 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4"); 603 604 // Support for #pragma redefine_extname (Sun compatibility) 605 Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1"); 606 607 // Previously this macro was set to a string aiming to achieve compatibility 608 // with GCC 4.2.1. Now, just return the full Clang version 609 Builder.defineMacro("__VERSION__", "\"" + 610 Twine(getClangFullCPPVersion()) + "\""); 611 612 // Initialize language-specific preprocessor defines. 613 614 // Standard conforming mode? 615 if (!LangOpts.GNUMode && !LangOpts.MSVCCompat) 616 Builder.defineMacro("__STRICT_ANSI__"); 617 618 if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus11) 619 Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__"); 620 621 if (LangOpts.ObjC) { 622 if (LangOpts.ObjCRuntime.isNonFragile()) { 623 Builder.defineMacro("__OBJC2__"); 624 625 if (LangOpts.ObjCExceptions) 626 Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS"); 627 } 628 629 if (LangOpts.getGC() != LangOptions::NonGC) 630 Builder.defineMacro("__OBJC_GC__"); 631 632 if (LangOpts.ObjCRuntime.isNeXTFamily()) 633 Builder.defineMacro("__NEXT_RUNTIME__"); 634 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"); 643 else 644 Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", 645 "1" + Twine(std::min(8U, version.getMinor().getValueOr(0)))); 646 } 647 648 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) { 649 VersionTuple tuple = LangOpts.ObjCRuntime.getVersion(); 650 651 unsigned minor = 0; 652 if (tuple.getMinor().hasValue()) 653 minor = tuple.getMinor().getValue(); 654 655 unsigned subminor = 0; 656 if (tuple.getSubminor().hasValue()) 657 subminor = tuple.getSubminor().getValue(); 658 659 Builder.defineMacro("__OBJFW_RUNTIME_ABI__", 660 Twine(tuple.getMajor() * 10000 + minor * 100 + 661 subminor)); 662 } 663 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", ""); 670 } 671 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")); 676 677 if (LangOpts.CPlusPlus) 678 InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder); 679 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__"); 684 685 if (LangOpts.ObjC) 686 Builder.defineMacro("OBJC_NEW_PROPERTIES"); 687 688 if (LangOpts.PascalStrings) 689 Builder.defineMacro("__PASCAL_STRINGS__"); 690 691 if (LangOpts.Blocks) { 692 Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))"); 693 Builder.defineMacro("__BLOCKS__"); 694 } 695 696 if (!LangOpts.MSVCCompat && LangOpts.Exceptions) 697 Builder.defineMacro("__EXCEPTIONS"); 698 if (!LangOpts.MSVCCompat && LangOpts.RTTI) 699 Builder.defineMacro("__GXX_RTTI"); 700 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__"); 708 709 if (LangOpts.Deprecated) 710 Builder.defineMacro("__DEPRECATED"); 711 712 if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus) { 713 Builder.defineMacro("__GNUG__", "4"); 714 Builder.defineMacro("__GXX_WEAK__"); 715 Builder.defineMacro("__private_extern__", "extern"); 716 } 717 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"); 723 } 724 } 725 726 if (LangOpts.Optimize) 727 Builder.defineMacro("__OPTIMIZE__"); 728 if (LangOpts.OptimizeSize) 729 Builder.defineMacro("__OPTIMIZE_SIZE__"); 730 731 if (LangOpts.FastMath) 732 Builder.defineMacro("__FAST_MATH__"); 733 734 // Initialize target-specific preprocessor defines. 735 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__"); 747 } else { 748 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__"); 749 Builder.defineMacro("__LITTLE_ENDIAN__"); 750 } 751 752 if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64 753 && TI.getIntWidth() == 32) { 754 Builder.defineMacro("_LP64"); 755 Builder.defineMacro("__LP64__"); 756 } 757 758 if (TI.getPointerWidth(0) == 32 && TI.getLongWidth() == 32 759 && TI.getIntWidth() == 32) { 760 Builder.defineMacro("_ILP32"); 761 Builder.defineMacro("__ILP32__"); 762 } 763 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())); 767 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); 777 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); 782 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); 801 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); 828 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); 833 834 if (TI.hasFloat16Type()) 835 DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16"); 836 DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F"); 837 DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), ""); 838 DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L"); 839 840 // Define a __POINTER_WIDTH__ macro for stdint.h. 841 Builder.defineMacro("__POINTER_WIDTH__", 842 Twine((int)TI.getPointerWidth(0))); 843 844 // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc. 845 Builder.defineMacro("__BIGGEST_ALIGNMENT__", 846 Twine(TI.getSuitableAlign() / TI.getCharWidth()) ); 847 848 if (!LangOpts.CharIsSigned) 849 Builder.defineMacro("__CHAR_UNSIGNED__"); 850 851 if (!TargetInfo::isTypeSigned(TI.getWCharType())) 852 Builder.defineMacro("__WCHAR_UNSIGNED__"); 853 854 if (!TargetInfo::isTypeSigned(TI.getWIntType())) 855 Builder.defineMacro("__WINT_UNSIGNED__"); 856 857 // Define exact-width integer types for stdint.h 858 DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder); 859 860 if (TI.getShortWidth() > TI.getCharWidth()) 861 DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder); 862 863 if (TI.getIntWidth() > TI.getShortWidth()) 864 DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder); 865 866 if (TI.getLongWidth() > TI.getIntWidth()) 867 DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder); 868 869 if (TI.getLongLongWidth() > TI.getLongWidth()) 870 DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder); 871 872 DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder); 873 DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder); 874 DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder); 875 876 if (TI.getShortWidth() > TI.getCharWidth()) { 877 DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder); 878 DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder); 879 DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder); 880 } 881 882 if (TI.getIntWidth() > TI.getShortWidth()) { 883 DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder); 884 DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder); 885 DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder); 886 } 887 888 if (TI.getLongWidth() > TI.getIntWidth()) { 889 DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder); 890 DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder); 891 DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder); 892 } 893 894 if (TI.getLongLongWidth() > TI.getLongWidth()) { 895 DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder); 896 DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder); 897 DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder); 898 } 899 900 DefineLeastWidthIntType(8, true, TI, Builder); 901 DefineLeastWidthIntType(8, false, TI, Builder); 902 DefineLeastWidthIntType(16, true, TI, Builder); 903 DefineLeastWidthIntType(16, false, TI, Builder); 904 DefineLeastWidthIntType(32, true, TI, Builder); 905 DefineLeastWidthIntType(32, false, TI, Builder); 906 DefineLeastWidthIntType(64, true, TI, Builder); 907 DefineLeastWidthIntType(64, false, TI, Builder); 908 909 DefineFastIntType(8, true, TI, Builder); 910 DefineFastIntType(8, false, TI, Builder); 911 DefineFastIntType(16, true, TI, Builder); 912 DefineFastIntType(16, false, TI, Builder); 913 DefineFastIntType(32, true, TI, Builder); 914 DefineFastIntType(32, false, TI, Builder); 915 DefineFastIntType(64, true, TI, Builder); 916 DefineFastIntType(64, false, TI, Builder); 917 918 char UserLabelPrefix[2] = {TI.getDataLayout().getGlobalPrefix(), 0}; 919 Builder.defineMacro("__USER_LABEL_PREFIX__", UserLabelPrefix); 920 921 if (LangOpts.FastMath || LangOpts.FiniteMathOnly) 922 Builder.defineMacro("__FINITE_MATH_ONLY__", "1"); 923 else 924 Builder.defineMacro("__FINITE_MATH_ONLY__", "0"); 925 926 if (!LangOpts.MSVCCompat) { 927 if (LangOpts.GNUInline || LangOpts.CPlusPlus) 928 Builder.defineMacro("__GNUC_GNU_INLINE__"); 929 else 930 Builder.defineMacro("__GNUC_STDC_INLINE__"); 931 932 // The value written by __atomic_test_and_set. 933 // FIXME: This is target-dependent. 934 Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1"); 935 } 936 937 auto addLockFreeMacros = [&](const llvm::Twine &Prefix) { 938 // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE. 939 unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth(); 940 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \ 941 Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE", \ 942 getLockFreeValue(TI.get##Type##Width(), \ 943 TI.get##Type##Align(), \ 944 InlineWidthBits)); 945 DEFINE_LOCK_FREE_MACRO(BOOL, Bool); 946 DEFINE_LOCK_FREE_MACRO(CHAR, Char); 947 if (LangOpts.Char8) 948 DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char. 949 DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16); 950 DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32); 951 DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar); 952 DEFINE_LOCK_FREE_MACRO(SHORT, Short); 953 DEFINE_LOCK_FREE_MACRO(INT, Int); 954 DEFINE_LOCK_FREE_MACRO(LONG, Long); 955 DEFINE_LOCK_FREE_MACRO(LLONG, LongLong); 956 Builder.defineMacro(Prefix + "POINTER_LOCK_FREE", 957 getLockFreeValue(TI.getPointerWidth(0), 958 TI.getPointerAlign(0), 959 InlineWidthBits)); 960 #undef DEFINE_LOCK_FREE_MACRO 961 }; 962 addLockFreeMacros("__CLANG_ATOMIC_"); 963 if (!LangOpts.MSVCCompat) 964 addLockFreeMacros("__GCC_ATOMIC_"); 965 966 if (LangOpts.NoInlineDefine) 967 Builder.defineMacro("__NO_INLINE__"); 968 969 if (unsigned PICLevel = LangOpts.PICLevel) { 970 Builder.defineMacro("__PIC__", Twine(PICLevel)); 971 Builder.defineMacro("__pic__", Twine(PICLevel)); 972 if (LangOpts.PIE) { 973 Builder.defineMacro("__PIE__", Twine(PICLevel)); 974 Builder.defineMacro("__pie__", Twine(PICLevel)); 975 } 976 } 977 978 // Macros to control C99 numerics and <float.h> 979 Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod())); 980 Builder.defineMacro("__FLT_RADIX__", "2"); 981 Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__"); 982 983 if (LangOpts.getStackProtector() == LangOptions::SSPOn) 984 Builder.defineMacro("__SSP__"); 985 else if (LangOpts.getStackProtector() == LangOptions::SSPStrong) 986 Builder.defineMacro("__SSP_STRONG__", "2"); 987 else if (LangOpts.getStackProtector() == LangOptions::SSPReq) 988 Builder.defineMacro("__SSP_ALL__", "3"); 989 990 // Define a macro that exists only when using the static analyzer. 991 if (FEOpts.ProgramAction == frontend::RunAnalysis) 992 Builder.defineMacro("__clang_analyzer__"); 993 994 if (LangOpts.FastRelaxedMath) 995 Builder.defineMacro("__FAST_RELAXED_MATH__"); 996 997 if (FEOpts.ProgramAction == frontend::RewriteObjC || 998 LangOpts.getGC() != LangOptions::NonGC) { 999 Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))"); 1000 Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))"); 1001 Builder.defineMacro("__autoreleasing", ""); 1002 Builder.defineMacro("__unsafe_unretained", ""); 1003 } else if (LangOpts.ObjC) { 1004 Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))"); 1005 Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))"); 1006 Builder.defineMacro("__autoreleasing", 1007 "__attribute__((objc_ownership(autoreleasing)))"); 1008 Builder.defineMacro("__unsafe_unretained", 1009 "__attribute__((objc_ownership(none)))"); 1010 } 1011 1012 // On Darwin, there are __double_underscored variants of the type 1013 // nullability qualifiers. 1014 if (TI.getTriple().isOSDarwin()) { 1015 Builder.defineMacro("__nonnull", "_Nonnull"); 1016 Builder.defineMacro("__null_unspecified", "_Null_unspecified"); 1017 Builder.defineMacro("__nullable", "_Nullable"); 1018 } 1019 1020 // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and 1021 // the corresponding simulator targets. 1022 if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment()) 1023 Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1"); 1024 1025 // OpenMP definition 1026 // OpenMP 2.2: 1027 // In implementations that support a preprocessor, the _OPENMP 1028 // macro name is defined to have the decimal value yyyymm where 1029 // yyyy and mm are the year and the month designations of the 1030 // version of the OpenMP API that the implementation support. 1031 if (!LangOpts.OpenMPSimd) { 1032 switch (LangOpts.OpenMP) { 1033 case 0: 1034 break; 1035 case 40: 1036 Builder.defineMacro("_OPENMP", "201307"); 1037 break; 1038 case 45: 1039 Builder.defineMacro("_OPENMP", "201511"); 1040 break; 1041 default: 1042 // Default version is OpenMP 3.1 1043 Builder.defineMacro("_OPENMP", "201107"); 1044 break; 1045 } 1046 } 1047 1048 // CUDA device path compilaton 1049 if (LangOpts.CUDAIsDevice && !LangOpts.HIP) { 1050 // The CUDA_ARCH value is set for the GPU target specified in the NVPTX 1051 // backend's target defines. 1052 Builder.defineMacro("__CUDA_ARCH__"); 1053 } 1054 1055 // We need to communicate this to our CUDA header wrapper, which in turn 1056 // informs the proper CUDA headers of this choice. 1057 if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) { 1058 Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__"); 1059 } 1060 1061 // Define a macro indicating that the source file is being compiled with a 1062 // SYCL device compiler which doesn't produce host binary. 1063 if (LangOpts.SYCLIsDevice) { 1064 Builder.defineMacro("__SYCL_DEVICE_ONLY__", "1"); 1065 } 1066 1067 // OpenCL definitions. 1068 if (LangOpts.OpenCL) { 1069 #define OPENCLEXT(Ext) \ 1070 if (TI.getSupportedOpenCLOpts().isSupported(#Ext, LangOpts)) \ 1071 Builder.defineMacro(#Ext); 1072 #include "clang/Basic/OpenCLExtensions.def" 1073 1074 if (TI.getTriple().isSPIR()) 1075 Builder.defineMacro("__IMAGE_SUPPORT__"); 1076 } 1077 1078 if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) { 1079 // For each extended integer type, g++ defines a macro mapping the 1080 // index of the type (0 in this case) in some list of extended types 1081 // to the type. 1082 Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128"); 1083 Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128"); 1084 } 1085 1086 // Get other target #defines. 1087 TI.getTargetDefines(LangOpts, Builder); 1088 } 1089 1090 /// InitializePreprocessor - Initialize the preprocessor getting it and the 1091 /// environment ready to process a single file. This returns true on error. 1092 /// 1093 void clang::InitializePreprocessor( 1094 Preprocessor &PP, const PreprocessorOptions &InitOpts, 1095 const PCHContainerReader &PCHContainerRdr, 1096 const FrontendOptions &FEOpts) { 1097 const LangOptions &LangOpts = PP.getLangOpts(); 1098 std::string PredefineBuffer; 1099 PredefineBuffer.reserve(4080); 1100 llvm::raw_string_ostream Predefines(PredefineBuffer); 1101 MacroBuilder Builder(Predefines); 1102 1103 // Emit line markers for various builtin sections of the file. We don't do 1104 // this in asm preprocessor mode, because "# 4" is not a line marker directive 1105 // in this mode. 1106 if (!PP.getLangOpts().AsmPreprocessor) 1107 Builder.append("# 1 \"<built-in>\" 3"); 1108 1109 // Install things like __POWERPC__, __GNUC__, etc into the macro table. 1110 if (InitOpts.UsePredefines) { 1111 // FIXME: This will create multiple definitions for most of the predefined 1112 // macros. This is not the right way to handle this. 1113 if ((LangOpts.CUDA || LangOpts.OpenMPIsDevice) && PP.getAuxTargetInfo()) 1114 InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts, 1115 Builder); 1116 1117 InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts, Builder); 1118 1119 // Install definitions to make Objective-C++ ARC work well with various 1120 // C++ Standard Library implementations. 1121 if (LangOpts.ObjC && LangOpts.CPlusPlus && 1122 (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) { 1123 switch (InitOpts.ObjCXXARCStandardLibrary) { 1124 case ARCXX_nolib: 1125 case ARCXX_libcxx: 1126 break; 1127 1128 case ARCXX_libstdcxx: 1129 AddObjCXXARCLibstdcxxDefines(LangOpts, Builder); 1130 break; 1131 } 1132 } 1133 } 1134 1135 // Even with predefines off, some macros are still predefined. 1136 // These should all be defined in the preprocessor according to the 1137 // current language configuration. 1138 InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(), 1139 FEOpts, Builder); 1140 1141 // Add on the predefines from the driver. Wrap in a #line directive to report 1142 // that they come from the command line. 1143 if (!PP.getLangOpts().AsmPreprocessor) 1144 Builder.append("# 1 \"<command line>\" 1"); 1145 1146 // Process #define's and #undef's in the order they are given. 1147 for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) { 1148 if (InitOpts.Macros[i].second) // isUndef 1149 Builder.undefineMacro(InitOpts.Macros[i].first); 1150 else 1151 DefineBuiltinMacro(Builder, InitOpts.Macros[i].first, 1152 PP.getDiagnostics()); 1153 } 1154 1155 // Exit the command line and go back to <built-in> (2 is LC_LEAVE). 1156 if (!PP.getLangOpts().AsmPreprocessor) 1157 Builder.append("# 1 \"<built-in>\" 2"); 1158 1159 // If -imacros are specified, include them now. These are processed before 1160 // any -include directives. 1161 for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i) 1162 AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]); 1163 1164 // Process -include-pch/-include-pth directives. 1165 if (!InitOpts.ImplicitPCHInclude.empty()) 1166 AddImplicitIncludePCH(Builder, PP, PCHContainerRdr, 1167 InitOpts.ImplicitPCHInclude); 1168 1169 // Process -include directives. 1170 for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) { 1171 const std::string &Path = InitOpts.Includes[i]; 1172 AddImplicitInclude(Builder, Path); 1173 } 1174 1175 // Instruct the preprocessor to skip the preamble. 1176 PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first, 1177 InitOpts.PrecompiledPreambleBytes.second); 1178 1179 // Copy PredefinedBuffer into the Preprocessor. 1180 PP.setPredefines(Predefines.str()); 1181 } 1182