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