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