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