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