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 610 /// Initialize the predefined C++ language feature test macros defined in 611 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations". 612 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts, 613 MacroBuilder &Builder) { 614 // C++98 features. 615 if (LangOpts.RTTI) 616 Builder.defineMacro("__cpp_rtti", "199711L"); 617 if (LangOpts.CXXExceptions) 618 Builder.defineMacro("__cpp_exceptions", "199711L"); 619 620 // C++11 features. 621 if (LangOpts.CPlusPlus11) { 622 Builder.defineMacro("__cpp_unicode_characters", "200704L"); 623 Builder.defineMacro("__cpp_raw_strings", "200710L"); 624 Builder.defineMacro("__cpp_unicode_literals", "200710L"); 625 Builder.defineMacro("__cpp_user_defined_literals", "200809L"); 626 Builder.defineMacro("__cpp_lambdas", "200907L"); 627 Builder.defineMacro("__cpp_constexpr", LangOpts.CPlusPlus26 ? "202306L" 628 : LangOpts.CPlusPlus23 ? "202211L" 629 : LangOpts.CPlusPlus20 ? "201907L" 630 : LangOpts.CPlusPlus17 ? "201603L" 631 : LangOpts.CPlusPlus14 ? "201304L" 632 : "200704"); 633 Builder.defineMacro("__cpp_constexpr_in_decltype", "201711L"); 634 Builder.defineMacro("__cpp_range_based_for", 635 LangOpts.CPlusPlus17 ? "201603L" : "200907"); 636 Builder.defineMacro("__cpp_static_assert", LangOpts.CPlusPlus26 ? "202306L" 637 : LangOpts.CPlusPlus17 638 ? "201411L" 639 : "200410"); 640 Builder.defineMacro("__cpp_decltype", "200707L"); 641 Builder.defineMacro("__cpp_attributes", "200809L"); 642 Builder.defineMacro("__cpp_rvalue_references", "200610L"); 643 Builder.defineMacro("__cpp_variadic_templates", "200704L"); 644 Builder.defineMacro("__cpp_initializer_lists", "200806L"); 645 Builder.defineMacro("__cpp_delegating_constructors", "200604L"); 646 Builder.defineMacro("__cpp_nsdmi", "200809L"); 647 Builder.defineMacro("__cpp_inheriting_constructors", "201511L"); 648 Builder.defineMacro("__cpp_ref_qualifiers", "200710L"); 649 Builder.defineMacro("__cpp_alias_templates", "200704L"); 650 } 651 if (LangOpts.ThreadsafeStatics) 652 Builder.defineMacro("__cpp_threadsafe_static_init", "200806L"); 653 654 // C++14 features. 655 if (LangOpts.CPlusPlus14) { 656 Builder.defineMacro("__cpp_binary_literals", "201304L"); 657 Builder.defineMacro("__cpp_digit_separators", "201309L"); 658 Builder.defineMacro("__cpp_init_captures", 659 LangOpts.CPlusPlus20 ? "201803L" : "201304L"); 660 Builder.defineMacro("__cpp_generic_lambdas", 661 LangOpts.CPlusPlus20 ? "201707L" : "201304L"); 662 Builder.defineMacro("__cpp_decltype_auto", "201304L"); 663 Builder.defineMacro("__cpp_return_type_deduction", "201304L"); 664 Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L"); 665 Builder.defineMacro("__cpp_variable_templates", "201304L"); 666 } 667 if (LangOpts.SizedDeallocation) 668 Builder.defineMacro("__cpp_sized_deallocation", "201309L"); 669 670 // C++17 features. 671 if (LangOpts.CPlusPlus17) { 672 Builder.defineMacro("__cpp_hex_float", "201603L"); 673 Builder.defineMacro("__cpp_inline_variables", "201606L"); 674 Builder.defineMacro("__cpp_noexcept_function_type", "201510L"); 675 Builder.defineMacro("__cpp_capture_star_this", "201603L"); 676 Builder.defineMacro("__cpp_if_constexpr", "201606L"); 677 Builder.defineMacro("__cpp_deduction_guides", "201703L"); // (not latest) 678 Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name) 679 Builder.defineMacro("__cpp_namespace_attributes", "201411L"); 680 Builder.defineMacro("__cpp_enumerator_attributes", "201411L"); 681 Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L"); 682 Builder.defineMacro("__cpp_variadic_using", "201611L"); 683 Builder.defineMacro("__cpp_aggregate_bases", "201603L"); 684 Builder.defineMacro("__cpp_structured_bindings", "201606L"); 685 Builder.defineMacro("__cpp_nontype_template_args", 686 "201411L"); // (not latest) 687 Builder.defineMacro("__cpp_fold_expressions", "201603L"); 688 Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L"); 689 Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L"); 690 } 691 if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable) 692 Builder.defineMacro("__cpp_aligned_new", "201606L"); 693 if (LangOpts.RelaxedTemplateTemplateArgs) 694 Builder.defineMacro("__cpp_template_template_args", "201611L"); 695 696 // C++20 features. 697 if (LangOpts.CPlusPlus20) { 698 Builder.defineMacro("__cpp_aggregate_paren_init", "201902L"); 699 700 // P0848 is implemented, but we're still waiting for other concepts 701 // issues to be addressed before bumping __cpp_concepts up to 202002L. 702 // Refer to the discussion of this at https://reviews.llvm.org/D128619. 703 Builder.defineMacro("__cpp_concepts", "201907L"); 704 Builder.defineMacro("__cpp_conditional_explicit", "201806L"); 705 Builder.defineMacro("__cpp_consteval", "202211L"); 706 Builder.defineMacro("__cpp_constexpr_dynamic_alloc", "201907L"); 707 Builder.defineMacro("__cpp_constinit", "201907L"); 708 Builder.defineMacro("__cpp_impl_coroutine", "201902L"); 709 Builder.defineMacro("__cpp_designated_initializers", "201707L"); 710 Builder.defineMacro("__cpp_impl_three_way_comparison", "201907L"); 711 //Builder.defineMacro("__cpp_modules", "201907L"); 712 Builder.defineMacro("__cpp_using_enum", "201907L"); 713 } 714 // C++23 features. 715 if (LangOpts.CPlusPlus23) { 716 Builder.defineMacro("__cpp_implicit_move", "202011L"); 717 Builder.defineMacro("__cpp_size_t_suffix", "202011L"); 718 Builder.defineMacro("__cpp_if_consteval", "202106L"); 719 Builder.defineMacro("__cpp_multidimensional_subscript", "202211L"); 720 } 721 722 // We provide those C++23 features as extensions in earlier language modes, so 723 // we also define their feature test macros. 724 if (LangOpts.CPlusPlus11) 725 Builder.defineMacro("__cpp_static_call_operator", "202207L"); 726 Builder.defineMacro("__cpp_named_character_escapes", "202207L"); 727 Builder.defineMacro("__cpp_placeholder_variables", "202306L"); 728 729 if (LangOpts.Char8) 730 Builder.defineMacro("__cpp_char8_t", "202207L"); 731 Builder.defineMacro("__cpp_impl_destroying_delete", "201806L"); 732 } 733 734 /// InitializeOpenCLFeatureTestMacros - Define OpenCL macros based on target 735 /// settings and language version 736 void InitializeOpenCLFeatureTestMacros(const TargetInfo &TI, 737 const LangOptions &Opts, 738 MacroBuilder &Builder) { 739 const llvm::StringMap<bool> &OpenCLFeaturesMap = TI.getSupportedOpenCLOpts(); 740 // FIXME: OpenCL options which affect language semantics/syntax 741 // should be moved into LangOptions. 742 auto defineOpenCLExtMacro = [&](llvm::StringRef Name, auto... OptArgs) { 743 // Check if extension is supported by target and is available in this 744 // OpenCL version 745 if (TI.hasFeatureEnabled(OpenCLFeaturesMap, Name) && 746 OpenCLOptions::isOpenCLOptionAvailableIn(Opts, OptArgs...)) 747 Builder.defineMacro(Name); 748 }; 749 #define OPENCL_GENERIC_EXTENSION(Ext, ...) \ 750 defineOpenCLExtMacro(#Ext, __VA_ARGS__); 751 #include "clang/Basic/OpenCLExtensions.def" 752 753 // Assume compiling for FULL profile 754 Builder.defineMacro("__opencl_c_int64"); 755 } 756 757 static void InitializePredefinedMacros(const TargetInfo &TI, 758 const LangOptions &LangOpts, 759 const FrontendOptions &FEOpts, 760 const PreprocessorOptions &PPOpts, 761 MacroBuilder &Builder) { 762 // Compiler version introspection macros. 763 Builder.defineMacro("__llvm__"); // LLVM Backend 764 Builder.defineMacro("__clang__"); // Clang Frontend 765 #define TOSTR2(X) #X 766 #define TOSTR(X) TOSTR2(X) 767 Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR)); 768 Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR)); 769 Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL)); 770 #undef TOSTR 771 #undef TOSTR2 772 Builder.defineMacro("__clang_version__", 773 "\"" CLANG_VERSION_STRING " " 774 + getClangFullRepositoryVersion() + "\""); 775 776 if (LangOpts.GNUCVersion != 0) { 777 // Major, minor, patch, are given two decimal places each, so 4.2.1 becomes 778 // 40201. 779 unsigned GNUCMajor = LangOpts.GNUCVersion / 100 / 100; 780 unsigned GNUCMinor = LangOpts.GNUCVersion / 100 % 100; 781 unsigned GNUCPatch = LangOpts.GNUCVersion % 100; 782 Builder.defineMacro("__GNUC__", Twine(GNUCMajor)); 783 Builder.defineMacro("__GNUC_MINOR__", Twine(GNUCMinor)); 784 Builder.defineMacro("__GNUC_PATCHLEVEL__", Twine(GNUCPatch)); 785 Builder.defineMacro("__GXX_ABI_VERSION", "1002"); 786 787 if (LangOpts.CPlusPlus) { 788 Builder.defineMacro("__GNUG__", Twine(GNUCMajor)); 789 Builder.defineMacro("__GXX_WEAK__"); 790 } 791 } 792 793 // Define macros for the C11 / C++11 memory orderings 794 Builder.defineMacro("__ATOMIC_RELAXED", "0"); 795 Builder.defineMacro("__ATOMIC_CONSUME", "1"); 796 Builder.defineMacro("__ATOMIC_ACQUIRE", "2"); 797 Builder.defineMacro("__ATOMIC_RELEASE", "3"); 798 Builder.defineMacro("__ATOMIC_ACQ_REL", "4"); 799 Builder.defineMacro("__ATOMIC_SEQ_CST", "5"); 800 801 // Define macros for the OpenCL memory scope. 802 // The values should match AtomicScopeOpenCLModel::ID enum. 803 static_assert( 804 static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 && 805 static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 && 806 static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 && 807 static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4, 808 "Invalid OpenCL memory scope enum definition"); 809 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0"); 810 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1"); 811 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2"); 812 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3"); 813 Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4"); 814 815 // Define macros for floating-point data classes, used in __builtin_isfpclass. 816 Builder.defineMacro("__FPCLASS_SNAN", "0x0001"); 817 Builder.defineMacro("__FPCLASS_QNAN", "0x0002"); 818 Builder.defineMacro("__FPCLASS_NEGINF", "0x0004"); 819 Builder.defineMacro("__FPCLASS_NEGNORMAL", "0x0008"); 820 Builder.defineMacro("__FPCLASS_NEGSUBNORMAL", "0x0010"); 821 Builder.defineMacro("__FPCLASS_NEGZERO", "0x0020"); 822 Builder.defineMacro("__FPCLASS_POSZERO", "0x0040"); 823 Builder.defineMacro("__FPCLASS_POSSUBNORMAL", "0x0080"); 824 Builder.defineMacro("__FPCLASS_POSNORMAL", "0x0100"); 825 Builder.defineMacro("__FPCLASS_POSINF", "0x0200"); 826 827 // Support for #pragma redefine_extname (Sun compatibility) 828 Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1"); 829 830 // Previously this macro was set to a string aiming to achieve compatibility 831 // with GCC 4.2.1. Now, just return the full Clang version 832 Builder.defineMacro("__VERSION__", "\"" + 833 Twine(getClangFullCPPVersion()) + "\""); 834 835 // Initialize language-specific preprocessor defines. 836 837 // Standard conforming mode? 838 if (!LangOpts.GNUMode && !LangOpts.MSVCCompat) 839 Builder.defineMacro("__STRICT_ANSI__"); 840 841 if (LangOpts.GNUCVersion && LangOpts.CPlusPlus11) 842 Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__"); 843 844 if (LangOpts.ObjC) { 845 if (LangOpts.ObjCRuntime.isNonFragile()) { 846 Builder.defineMacro("__OBJC2__"); 847 848 if (LangOpts.ObjCExceptions) 849 Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS"); 850 } 851 852 if (LangOpts.getGC() != LangOptions::NonGC) 853 Builder.defineMacro("__OBJC_GC__"); 854 855 if (LangOpts.ObjCRuntime.isNeXTFamily()) 856 Builder.defineMacro("__NEXT_RUNTIME__"); 857 858 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) { 859 auto version = LangOpts.ObjCRuntime.getVersion(); 860 std::string versionString = "1"; 861 // Don't rely on the tuple argument, because we can be asked to target 862 // later ABIs than we actually support, so clamp these values to those 863 // currently supported 864 if (version >= VersionTuple(2, 0)) 865 Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", "20"); 866 else 867 Builder.defineMacro( 868 "__OBJC_GNUSTEP_RUNTIME_ABI__", 869 "1" + Twine(std::min(8U, version.getMinor().value_or(0)))); 870 } 871 872 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) { 873 VersionTuple tuple = LangOpts.ObjCRuntime.getVersion(); 874 unsigned minor = tuple.getMinor().value_or(0); 875 unsigned subminor = tuple.getSubminor().value_or(0); 876 Builder.defineMacro("__OBJFW_RUNTIME_ABI__", 877 Twine(tuple.getMajor() * 10000 + minor * 100 + 878 subminor)); 879 } 880 881 Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))"); 882 Builder.defineMacro("IBOutletCollection(ClassName)", 883 "__attribute__((iboutletcollection(ClassName)))"); 884 Builder.defineMacro("IBAction", "void)__attribute__((ibaction)"); 885 Builder.defineMacro("IBInspectable", ""); 886 Builder.defineMacro("IB_DESIGNABLE", ""); 887 } 888 889 // Define a macro that describes the Objective-C boolean type even for C 890 // and C++ since BOOL can be used from non Objective-C code. 891 Builder.defineMacro("__OBJC_BOOL_IS_BOOL", 892 Twine(TI.useSignedCharForObjCBool() ? "0" : "1")); 893 894 if (LangOpts.CPlusPlus) 895 InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder); 896 897 // darwin_constant_cfstrings controls this. This is also dependent 898 // on other things like the runtime I believe. This is set even for C code. 899 if (!LangOpts.NoConstantCFStrings) 900 Builder.defineMacro("__CONSTANT_CFSTRINGS__"); 901 902 if (LangOpts.ObjC) 903 Builder.defineMacro("OBJC_NEW_PROPERTIES"); 904 905 if (LangOpts.PascalStrings) 906 Builder.defineMacro("__PASCAL_STRINGS__"); 907 908 if (LangOpts.Blocks) { 909 Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))"); 910 Builder.defineMacro("__BLOCKS__"); 911 } 912 913 if (!LangOpts.MSVCCompat && LangOpts.Exceptions) 914 Builder.defineMacro("__EXCEPTIONS"); 915 if (LangOpts.GNUCVersion && LangOpts.RTTI) 916 Builder.defineMacro("__GXX_RTTI"); 917 918 if (LangOpts.hasSjLjExceptions()) 919 Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__"); 920 else if (LangOpts.hasSEHExceptions()) 921 Builder.defineMacro("__SEH__"); 922 else if (LangOpts.hasDWARFExceptions() && 923 (TI.getTriple().isThumb() || TI.getTriple().isARM())) 924 Builder.defineMacro("__ARM_DWARF_EH__"); 925 926 if (LangOpts.Deprecated) 927 Builder.defineMacro("__DEPRECATED"); 928 929 if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus) 930 Builder.defineMacro("__private_extern__", "extern"); 931 932 if (LangOpts.MicrosoftExt) { 933 if (LangOpts.WChar) { 934 // wchar_t supported as a keyword. 935 Builder.defineMacro("_WCHAR_T_DEFINED"); 936 Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED"); 937 } 938 } 939 940 // Macros to help identify the narrow and wide character sets 941 // FIXME: clang currently ignores -fexec-charset=. If this changes, 942 // then this may need to be updated. 943 Builder.defineMacro("__clang_literal_encoding__", "\"UTF-8\""); 944 if (TI.getTypeWidth(TI.getWCharType()) >= 32) { 945 // FIXME: 32-bit wchar_t signals UTF-32. This may change 946 // if -fwide-exec-charset= is ever supported. 947 Builder.defineMacro("__clang_wide_literal_encoding__", "\"UTF-32\""); 948 } else { 949 // FIXME: Less-than 32-bit wchar_t generally means UTF-16 950 // (e.g., Windows, 32-bit IBM). This may need to be 951 // updated if -fwide-exec-charset= is ever supported. 952 Builder.defineMacro("__clang_wide_literal_encoding__", "\"UTF-16\""); 953 } 954 955 if (LangOpts.Optimize) 956 Builder.defineMacro("__OPTIMIZE__"); 957 if (LangOpts.OptimizeSize) 958 Builder.defineMacro("__OPTIMIZE_SIZE__"); 959 960 if (LangOpts.FastMath) 961 Builder.defineMacro("__FAST_MATH__"); 962 963 // Initialize target-specific preprocessor defines. 964 965 // __BYTE_ORDER__ was added in GCC 4.6. It's analogous 966 // to the macro __BYTE_ORDER (no trailing underscores) 967 // from glibc's <endian.h> header. 968 // We don't support the PDP-11 as a target, but include 969 // the define so it can still be compared against. 970 Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234"); 971 Builder.defineMacro("__ORDER_BIG_ENDIAN__", "4321"); 972 Builder.defineMacro("__ORDER_PDP_ENDIAN__", "3412"); 973 if (TI.isBigEndian()) { 974 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__"); 975 Builder.defineMacro("__BIG_ENDIAN__"); 976 } else { 977 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__"); 978 Builder.defineMacro("__LITTLE_ENDIAN__"); 979 } 980 981 if (TI.getPointerWidth(LangAS::Default) == 64 && TI.getLongWidth() == 64 && 982 TI.getIntWidth() == 32) { 983 Builder.defineMacro("_LP64"); 984 Builder.defineMacro("__LP64__"); 985 } 986 987 if (TI.getPointerWidth(LangAS::Default) == 32 && TI.getLongWidth() == 32 && 988 TI.getIntWidth() == 32) { 989 Builder.defineMacro("_ILP32"); 990 Builder.defineMacro("__ILP32__"); 991 } 992 993 // Define type sizing macros based on the target properties. 994 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far"); 995 Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth())); 996 997 Builder.defineMacro("__BOOL_WIDTH__", Twine(TI.getBoolWidth())); 998 Builder.defineMacro("__SHRT_WIDTH__", Twine(TI.getShortWidth())); 999 Builder.defineMacro("__INT_WIDTH__", Twine(TI.getIntWidth())); 1000 Builder.defineMacro("__LONG_WIDTH__", Twine(TI.getLongWidth())); 1001 Builder.defineMacro("__LLONG_WIDTH__", Twine(TI.getLongLongWidth())); 1002 1003 size_t BitIntMaxWidth = TI.getMaxBitIntWidth(); 1004 assert(BitIntMaxWidth <= llvm::IntegerType::MAX_INT_BITS && 1005 "Target defined a max bit width larger than LLVM can support!"); 1006 assert(BitIntMaxWidth >= TI.getLongLongWidth() && 1007 "Target defined a max bit width smaller than the C standard allows!"); 1008 Builder.defineMacro("__BITINT_MAXWIDTH__", Twine(BitIntMaxWidth)); 1009 1010 DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder); 1011 DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder); 1012 DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder); 1013 DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder); 1014 DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder); 1015 DefineTypeSizeAndWidth("__WCHAR", TI.getWCharType(), TI, Builder); 1016 DefineTypeSizeAndWidth("__WINT", TI.getWIntType(), TI, Builder); 1017 DefineTypeSizeAndWidth("__INTMAX", TI.getIntMaxType(), TI, Builder); 1018 DefineTypeSizeAndWidth("__SIZE", TI.getSizeType(), TI, Builder); 1019 1020 DefineTypeSizeAndWidth("__UINTMAX", TI.getUIntMaxType(), TI, Builder); 1021 DefineTypeSizeAndWidth("__PTRDIFF", TI.getPtrDiffType(LangAS::Default), TI, 1022 Builder); 1023 DefineTypeSizeAndWidth("__INTPTR", TI.getIntPtrType(), TI, Builder); 1024 DefineTypeSizeAndWidth("__UINTPTR", TI.getUIntPtrType(), TI, Builder); 1025 1026 DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder); 1027 DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder); 1028 DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder); 1029 DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder); 1030 DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder); 1031 DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder); 1032 DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(LangAS::Default), 1033 TI, Builder); 1034 DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder); 1035 DefineTypeSizeof("__SIZEOF_PTRDIFF_T__", 1036 TI.getTypeWidth(TI.getPtrDiffType(LangAS::Default)), TI, 1037 Builder); 1038 DefineTypeSizeof("__SIZEOF_SIZE_T__", 1039 TI.getTypeWidth(TI.getSizeType()), TI, Builder); 1040 DefineTypeSizeof("__SIZEOF_WCHAR_T__", 1041 TI.getTypeWidth(TI.getWCharType()), TI, Builder); 1042 DefineTypeSizeof("__SIZEOF_WINT_T__", 1043 TI.getTypeWidth(TI.getWIntType()), TI, Builder); 1044 if (TI.hasInt128Type()) 1045 DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder); 1046 1047 DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder); 1048 DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder); 1049 Builder.defineMacro("__INTMAX_C_SUFFIX__", 1050 TI.getTypeConstantSuffix(TI.getIntMaxType())); 1051 DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder); 1052 DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder); 1053 Builder.defineMacro("__UINTMAX_C_SUFFIX__", 1054 TI.getTypeConstantSuffix(TI.getUIntMaxType())); 1055 DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(LangAS::Default), Builder); 1056 DefineFmt("__PTRDIFF", TI.getPtrDiffType(LangAS::Default), TI, Builder); 1057 DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder); 1058 DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder); 1059 DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder); 1060 DefineFmt("__SIZE", TI.getSizeType(), TI, Builder); 1061 DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder); 1062 DefineType("__WINT_TYPE__", TI.getWIntType(), Builder); 1063 DefineTypeSizeAndWidth("__SIG_ATOMIC", TI.getSigAtomicType(), TI, Builder); 1064 DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder); 1065 DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder); 1066 1067 DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder); 1068 DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder); 1069 1070 // The C standard requires the width of uintptr_t and intptr_t to be the same, 1071 // per 7.20.2.4p1. Same for intmax_t and uintmax_t, per 7.20.2.5p1. 1072 assert(TI.getTypeWidth(TI.getUIntPtrType()) == 1073 TI.getTypeWidth(TI.getIntPtrType()) && 1074 "uintptr_t and intptr_t have different widths?"); 1075 assert(TI.getTypeWidth(TI.getUIntMaxType()) == 1076 TI.getTypeWidth(TI.getIntMaxType()) && 1077 "uintmax_t and intmax_t have different widths?"); 1078 1079 if (TI.hasFloat16Type()) 1080 DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16"); 1081 DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F"); 1082 DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), ""); 1083 DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L"); 1084 if (TI.hasFloat128Type()) 1085 DefineFloatMacros(Builder, "FLT128", &TI.getFloat128Format(), "Q"); 1086 1087 // Define a __POINTER_WIDTH__ macro for stdint.h. 1088 Builder.defineMacro("__POINTER_WIDTH__", 1089 Twine((int)TI.getPointerWidth(LangAS::Default))); 1090 1091 // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc. 1092 Builder.defineMacro("__BIGGEST_ALIGNMENT__", 1093 Twine(TI.getSuitableAlign() / TI.getCharWidth()) ); 1094 1095 if (!LangOpts.CharIsSigned) 1096 Builder.defineMacro("__CHAR_UNSIGNED__"); 1097 1098 if (!TargetInfo::isTypeSigned(TI.getWCharType())) 1099 Builder.defineMacro("__WCHAR_UNSIGNED__"); 1100 1101 if (!TargetInfo::isTypeSigned(TI.getWIntType())) 1102 Builder.defineMacro("__WINT_UNSIGNED__"); 1103 1104 // Define exact-width integer types for stdint.h 1105 DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder); 1106 1107 if (TI.getShortWidth() > TI.getCharWidth()) 1108 DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder); 1109 1110 if (TI.getIntWidth() > TI.getShortWidth()) 1111 DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder); 1112 1113 if (TI.getLongWidth() > TI.getIntWidth()) 1114 DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder); 1115 1116 if (TI.getLongLongWidth() > TI.getLongWidth()) 1117 DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder); 1118 1119 DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder); 1120 DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder); 1121 DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder); 1122 1123 if (TI.getShortWidth() > TI.getCharWidth()) { 1124 DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder); 1125 DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder); 1126 DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder); 1127 } 1128 1129 if (TI.getIntWidth() > TI.getShortWidth()) { 1130 DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder); 1131 DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder); 1132 DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder); 1133 } 1134 1135 if (TI.getLongWidth() > TI.getIntWidth()) { 1136 DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder); 1137 DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder); 1138 DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder); 1139 } 1140 1141 if (TI.getLongLongWidth() > TI.getLongWidth()) { 1142 DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder); 1143 DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder); 1144 DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder); 1145 } 1146 1147 DefineLeastWidthIntType(8, true, TI, Builder); 1148 DefineLeastWidthIntType(8, false, TI, Builder); 1149 DefineLeastWidthIntType(16, true, TI, Builder); 1150 DefineLeastWidthIntType(16, false, TI, Builder); 1151 DefineLeastWidthIntType(32, true, TI, Builder); 1152 DefineLeastWidthIntType(32, false, TI, Builder); 1153 DefineLeastWidthIntType(64, true, TI, Builder); 1154 DefineLeastWidthIntType(64, false, TI, Builder); 1155 1156 DefineFastIntType(8, true, TI, Builder); 1157 DefineFastIntType(8, false, TI, Builder); 1158 DefineFastIntType(16, true, TI, Builder); 1159 DefineFastIntType(16, false, TI, Builder); 1160 DefineFastIntType(32, true, TI, Builder); 1161 DefineFastIntType(32, false, TI, Builder); 1162 DefineFastIntType(64, true, TI, Builder); 1163 DefineFastIntType(64, false, TI, Builder); 1164 1165 Builder.defineMacro("__USER_LABEL_PREFIX__", TI.getUserLabelPrefix()); 1166 1167 if (!LangOpts.MathErrno) 1168 Builder.defineMacro("__NO_MATH_ERRNO__"); 1169 1170 if (LangOpts.FastMath || LangOpts.FiniteMathOnly) 1171 Builder.defineMacro("__FINITE_MATH_ONLY__", "1"); 1172 else 1173 Builder.defineMacro("__FINITE_MATH_ONLY__", "0"); 1174 1175 if (LangOpts.GNUCVersion) { 1176 if (LangOpts.GNUInline || LangOpts.CPlusPlus) 1177 Builder.defineMacro("__GNUC_GNU_INLINE__"); 1178 else 1179 Builder.defineMacro("__GNUC_STDC_INLINE__"); 1180 1181 // The value written by __atomic_test_and_set. 1182 // FIXME: This is target-dependent. 1183 Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1"); 1184 } 1185 1186 auto addLockFreeMacros = [&](const llvm::Twine &Prefix) { 1187 // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE. 1188 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \ 1189 Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE", \ 1190 getLockFreeValue(TI.get##Type##Width(), TI)); 1191 DEFINE_LOCK_FREE_MACRO(BOOL, Bool); 1192 DEFINE_LOCK_FREE_MACRO(CHAR, Char); 1193 if (LangOpts.Char8) 1194 DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char. 1195 DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16); 1196 DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32); 1197 DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar); 1198 DEFINE_LOCK_FREE_MACRO(SHORT, Short); 1199 DEFINE_LOCK_FREE_MACRO(INT, Int); 1200 DEFINE_LOCK_FREE_MACRO(LONG, Long); 1201 DEFINE_LOCK_FREE_MACRO(LLONG, LongLong); 1202 Builder.defineMacro( 1203 Prefix + "POINTER_LOCK_FREE", 1204 getLockFreeValue(TI.getPointerWidth(LangAS::Default), TI)); 1205 #undef DEFINE_LOCK_FREE_MACRO 1206 }; 1207 addLockFreeMacros("__CLANG_ATOMIC_"); 1208 if (LangOpts.GNUCVersion) 1209 addLockFreeMacros("__GCC_ATOMIC_"); 1210 1211 if (LangOpts.NoInlineDefine) 1212 Builder.defineMacro("__NO_INLINE__"); 1213 1214 if (unsigned PICLevel = LangOpts.PICLevel) { 1215 Builder.defineMacro("__PIC__", Twine(PICLevel)); 1216 Builder.defineMacro("__pic__", Twine(PICLevel)); 1217 if (LangOpts.PIE) { 1218 Builder.defineMacro("__PIE__", Twine(PICLevel)); 1219 Builder.defineMacro("__pie__", Twine(PICLevel)); 1220 } 1221 } 1222 1223 // Macros to control C99 numerics and <float.h> 1224 Builder.defineMacro("__FLT_RADIX__", "2"); 1225 Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__"); 1226 1227 if (LangOpts.getStackProtector() == LangOptions::SSPOn) 1228 Builder.defineMacro("__SSP__"); 1229 else if (LangOpts.getStackProtector() == LangOptions::SSPStrong) 1230 Builder.defineMacro("__SSP_STRONG__", "2"); 1231 else if (LangOpts.getStackProtector() == LangOptions::SSPReq) 1232 Builder.defineMacro("__SSP_ALL__", "3"); 1233 1234 if (PPOpts.SetUpStaticAnalyzer) 1235 Builder.defineMacro("__clang_analyzer__"); 1236 1237 if (LangOpts.FastRelaxedMath) 1238 Builder.defineMacro("__FAST_RELAXED_MATH__"); 1239 1240 if (FEOpts.ProgramAction == frontend::RewriteObjC || 1241 LangOpts.getGC() != LangOptions::NonGC) { 1242 Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))"); 1243 Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))"); 1244 Builder.defineMacro("__autoreleasing", ""); 1245 Builder.defineMacro("__unsafe_unretained", ""); 1246 } else if (LangOpts.ObjC) { 1247 Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))"); 1248 Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))"); 1249 Builder.defineMacro("__autoreleasing", 1250 "__attribute__((objc_ownership(autoreleasing)))"); 1251 Builder.defineMacro("__unsafe_unretained", 1252 "__attribute__((objc_ownership(none)))"); 1253 } 1254 1255 // On Darwin, there are __double_underscored variants of the type 1256 // nullability qualifiers. 1257 if (TI.getTriple().isOSDarwin()) { 1258 Builder.defineMacro("__nonnull", "_Nonnull"); 1259 Builder.defineMacro("__null_unspecified", "_Null_unspecified"); 1260 Builder.defineMacro("__nullable", "_Nullable"); 1261 } 1262 1263 // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and 1264 // the corresponding simulator targets. 1265 if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment()) 1266 Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1"); 1267 1268 // OpenMP definition 1269 // OpenMP 2.2: 1270 // In implementations that support a preprocessor, the _OPENMP 1271 // macro name is defined to have the decimal value yyyymm where 1272 // yyyy and mm are the year and the month designations of the 1273 // version of the OpenMP API that the implementation support. 1274 if (!LangOpts.OpenMPSimd) { 1275 switch (LangOpts.OpenMP) { 1276 case 0: 1277 break; 1278 case 31: 1279 Builder.defineMacro("_OPENMP", "201107"); 1280 break; 1281 case 40: 1282 Builder.defineMacro("_OPENMP", "201307"); 1283 break; 1284 case 45: 1285 Builder.defineMacro("_OPENMP", "201511"); 1286 break; 1287 case 50: 1288 Builder.defineMacro("_OPENMP", "201811"); 1289 break; 1290 case 52: 1291 Builder.defineMacro("_OPENMP", "202111"); 1292 break; 1293 default: // case 51: 1294 // Default version is OpenMP 5.1 1295 Builder.defineMacro("_OPENMP", "202011"); 1296 break; 1297 } 1298 } 1299 1300 // CUDA device path compilaton 1301 if (LangOpts.CUDAIsDevice && !LangOpts.HIP) { 1302 // The CUDA_ARCH value is set for the GPU target specified in the NVPTX 1303 // backend's target defines. 1304 Builder.defineMacro("__CUDA_ARCH__"); 1305 } 1306 1307 // We need to communicate this to our CUDA/HIP header wrapper, which in turn 1308 // informs the proper CUDA/HIP headers of this choice. 1309 if (LangOpts.GPUDeviceApproxTranscendentals) 1310 Builder.defineMacro("__CLANG_GPU_APPROX_TRANSCENDENTALS__"); 1311 1312 // Define a macro indicating that the source file is being compiled with a 1313 // SYCL device compiler which doesn't produce host binary. 1314 if (LangOpts.SYCLIsDevice) { 1315 Builder.defineMacro("__SYCL_DEVICE_ONLY__", "1"); 1316 } 1317 1318 // OpenCL definitions. 1319 if (LangOpts.OpenCL) { 1320 InitializeOpenCLFeatureTestMacros(TI, LangOpts, Builder); 1321 1322 if (TI.getTriple().isSPIR() || TI.getTriple().isSPIRV()) 1323 Builder.defineMacro("__IMAGE_SUPPORT__"); 1324 } 1325 1326 if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) { 1327 // For each extended integer type, g++ defines a macro mapping the 1328 // index of the type (0 in this case) in some list of extended types 1329 // to the type. 1330 Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128"); 1331 Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128"); 1332 } 1333 1334 // ELF targets define __ELF__ 1335 if (TI.getTriple().isOSBinFormatELF()) 1336 Builder.defineMacro("__ELF__"); 1337 1338 // Get other target #defines. 1339 TI.getTargetDefines(LangOpts, Builder); 1340 } 1341 1342 /// InitializePreprocessor - Initialize the preprocessor getting it and the 1343 /// environment ready to process a single file. 1344 void clang::InitializePreprocessor( 1345 Preprocessor &PP, const PreprocessorOptions &InitOpts, 1346 const PCHContainerReader &PCHContainerRdr, 1347 const FrontendOptions &FEOpts) { 1348 const LangOptions &LangOpts = PP.getLangOpts(); 1349 std::string PredefineBuffer; 1350 PredefineBuffer.reserve(4080); 1351 llvm::raw_string_ostream Predefines(PredefineBuffer); 1352 MacroBuilder Builder(Predefines); 1353 1354 // Emit line markers for various builtin sections of the file. The 3 here 1355 // marks <built-in> as being a system header, which suppresses warnings when 1356 // the same macro is defined multiple times. 1357 Builder.append("# 1 \"<built-in>\" 3"); 1358 1359 // Install things like __POWERPC__, __GNUC__, etc into the macro table. 1360 if (InitOpts.UsePredefines) { 1361 // FIXME: This will create multiple definitions for most of the predefined 1362 // macros. This is not the right way to handle this. 1363 if ((LangOpts.CUDA || LangOpts.OpenMPIsTargetDevice || 1364 LangOpts.SYCLIsDevice) && 1365 PP.getAuxTargetInfo()) 1366 InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts, 1367 PP.getPreprocessorOpts(), Builder); 1368 1369 InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts, 1370 PP.getPreprocessorOpts(), Builder); 1371 1372 // Install definitions to make Objective-C++ ARC work well with various 1373 // C++ Standard Library implementations. 1374 if (LangOpts.ObjC && LangOpts.CPlusPlus && 1375 (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) { 1376 switch (InitOpts.ObjCXXARCStandardLibrary) { 1377 case ARCXX_nolib: 1378 case ARCXX_libcxx: 1379 break; 1380 1381 case ARCXX_libstdcxx: 1382 AddObjCXXARCLibstdcxxDefines(LangOpts, Builder); 1383 break; 1384 } 1385 } 1386 } 1387 1388 // Even with predefines off, some macros are still predefined. 1389 // These should all be defined in the preprocessor according to the 1390 // current language configuration. 1391 InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(), 1392 FEOpts, Builder); 1393 1394 // Add on the predefines from the driver. Wrap in a #line directive to report 1395 // that they come from the command line. 1396 Builder.append("# 1 \"<command line>\" 1"); 1397 1398 // Process #define's and #undef's in the order they are given. 1399 for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) { 1400 if (InitOpts.Macros[i].second) // isUndef 1401 Builder.undefineMacro(InitOpts.Macros[i].first); 1402 else 1403 DefineBuiltinMacro(Builder, InitOpts.Macros[i].first, 1404 PP.getDiagnostics()); 1405 } 1406 1407 // Exit the command line and go back to <built-in> (2 is LC_LEAVE). 1408 Builder.append("# 1 \"<built-in>\" 2"); 1409 1410 // If -imacros are specified, include them now. These are processed before 1411 // any -include directives. 1412 for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i) 1413 AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]); 1414 1415 // Process -include-pch/-include-pth directives. 1416 if (!InitOpts.ImplicitPCHInclude.empty()) 1417 AddImplicitIncludePCH(Builder, PP, PCHContainerRdr, 1418 InitOpts.ImplicitPCHInclude); 1419 1420 // Process -include directives. 1421 for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) { 1422 const std::string &Path = InitOpts.Includes[i]; 1423 AddImplicitInclude(Builder, Path); 1424 } 1425 1426 // Instruct the preprocessor to skip the preamble. 1427 PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first, 1428 InitOpts.PrecompiledPreambleBytes.second); 1429 1430 // Copy PredefinedBuffer into the Preprocessor. 1431 PP.setPredefines(std::move(PredefineBuffer)); 1432 } 1433