contrib/llvm-project/clang/lib/Frontend/InitPreprocessor.cpp

   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/MacroBuilder.h"
  15 #include "clang/Basic/SourceManager.h"
  16 #include "clang/Basic/SyncScope.h"
  17 #include "clang/Basic/TargetInfo.h"
  18 #include "clang/Basic/Version.h"
  19 #include "clang/Frontend/FrontendDiagnostic.h"
  20 #include "clang/Frontend/FrontendOptions.h"
  21 #include "clang/Frontend/Utils.h"
  22 #include "clang/Lex/HeaderSearch.h"
  23 #include "clang/Lex/Preprocessor.h"
  24 #include "clang/Lex/PreprocessorOptions.h"
  25 #include "clang/Serialization/ASTReader.h"
  26 #include "llvm/ADT/APFloat.h"
  27 #include "llvm/IR/DataLayout.h"
  28 using namespace clang;
  29
  30 static bool MacroBodyEndsInBackslash(StringRef MacroBody) {
  31   while (!MacroBody.empty() && isWhitespace(MacroBody.back()))
  32     MacroBody = MacroBody.drop_back();
  33   return !MacroBody.empty() && MacroBody.back() == '\\';
  34 }
  35
  36 // Append a #define line to Buf for Macro.  Macro should be of the form XXX,
  37 // in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
  38 // "#define XXX Y z W".  To get a #define with no value, use "XXX=".
  39 static void DefineBuiltinMacro(MacroBuilder &Builder, StringRef Macro,
  40                                DiagnosticsEngine &Diags) {
  41   std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
  42   StringRef MacroName = MacroPair.first;
  43   StringRef MacroBody = MacroPair.second;
  44   if (MacroName.size() != Macro.size()) {
  45     // Per GCC -D semantics, the macro ends at \n if it exists.
  46     StringRef::size_type End = MacroBody.find_first_of("\n\r");
  47     if (End != StringRef::npos)
  48       Diags.Report(diag::warn_fe_macro_contains_embedded_newline)
  49         << MacroName;
  50     MacroBody = MacroBody.substr(0, End);
  51     // We handle macro bodies which end in a backslash by appending an extra
  52     // backslash+newline.  This makes sure we don't accidentally treat the
  53     // backslash as a line continuation marker.
  54     if (MacroBodyEndsInBackslash(MacroBody))
  55       Builder.defineMacro(MacroName, Twine(MacroBody) + "\\\n");
  56     else
  57       Builder.defineMacro(MacroName, MacroBody);
  58   } else {
  59     // Push "macroname 1".
  60     Builder.defineMacro(Macro);
  61   }
  62 }
  63
  64 /// AddImplicitInclude - Add an implicit \#include of the specified file to the
  65 /// predefines buffer.
  66 /// As these includes are generated by -include arguments the header search
  67 /// logic is going to search relatively to the current working directory.
  68 static void AddImplicitInclude(MacroBuilder &Builder, StringRef File) {
  69   Builder.append(Twine("#include \"") + File + "\"");
  70 }
  71
  72 static void AddImplicitIncludeMacros(MacroBuilder &Builder, StringRef File) {
  73   Builder.append(Twine("#__include_macros \"") + File + "\"");
  74   // Marker token to stop the __include_macros fetch loop.
  75   Builder.append("##"); // ##?
  76 }
  77
  78 /// Add an implicit \#include using the original file used to generate
  79 /// a PCH file.
  80 static void AddImplicitIncludePCH(MacroBuilder &Builder, Preprocessor &PP,
  81                                   const PCHContainerReader &PCHContainerRdr,
  82                                   StringRef ImplicitIncludePCH) {
  83   std::string OriginalFile =
  84       ASTReader::getOriginalSourceFile(ImplicitIncludePCH, PP.getFileManager(),
  85                                        PCHContainerRdr, PP.getDiagnostics());
  86   if (OriginalFile.empty())
  87     return;
  88
  89   AddImplicitInclude(Builder, OriginalFile);
  90 }
  91
  92 /// PickFP - This is used to pick a value based on the FP semantics of the
  93 /// specified FP model.
  94 template <typename T>
  95 static T PickFP(const llvm::fltSemantics *Sem, T IEEEHalfVal, T IEEESingleVal,
  96                 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
  97                 T IEEEQuadVal) {
  98   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEhalf())
  99     return IEEEHalfVal;
 100   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle())
 101     return IEEESingleVal;
 102   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble())
 103     return IEEEDoubleVal;
 104   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended())
 105     return X87DoubleExtendedVal;
 106   if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble())
 107     return PPCDoubleDoubleVal;
 108   assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad());
 109   return IEEEQuadVal;
 110 }
 111
 112 static void DefineFloatMacros(MacroBuilder &Builder, StringRef Prefix,
 113                               const llvm::fltSemantics *Sem, StringRef Ext) {
 114   const char *DenormMin, *Epsilon, *Max, *Min;
 115   DenormMin = PickFP(Sem, "5.9604644775390625e-8", "1.40129846e-45",
 116                      "4.9406564584124654e-324", "3.64519953188247460253e-4951",
 117                      "4.94065645841246544176568792868221e-324",
 118                      "6.47517511943802511092443895822764655e-4966");
 119   int Digits = PickFP(Sem, 3, 6, 15, 18, 31, 33);
 120   int DecimalDigits = PickFP(Sem, 5, 9, 17, 21, 33, 36);
 121   Epsilon = PickFP(Sem, "9.765625e-4", "1.19209290e-7",
 122                    "2.2204460492503131e-16", "1.08420217248550443401e-19",
 123                    "4.94065645841246544176568792868221e-324",
 124                    "1.92592994438723585305597794258492732e-34");
 125   int MantissaDigits = PickFP(Sem, 11, 24, 53, 64, 106, 113);
 126   int Min10Exp = PickFP(Sem, -4, -37, -307, -4931, -291, -4931);
 127   int Max10Exp = PickFP(Sem, 4, 38, 308, 4932, 308, 4932);
 128   int MinExp = PickFP(Sem, -13, -125, -1021, -16381, -968, -16381);
 129   int MaxExp = PickFP(Sem, 16, 128, 1024, 16384, 1024, 16384);
 130   Min = PickFP(Sem, "6.103515625e-5", "1.17549435e-38", "2.2250738585072014e-308",
 131                "3.36210314311209350626e-4932",
 132                "2.00416836000897277799610805135016e-292",
 133                "3.36210314311209350626267781732175260e-4932");
 134   Max = PickFP(Sem, "6.5504e+4", "3.40282347e+38", "1.7976931348623157e+308",
 135                "1.18973149535723176502e+4932",
 136                "1.79769313486231580793728971405301e+308",
 137                "1.18973149535723176508575932662800702e+4932");
 138
 139   SmallString<32> DefPrefix;
 140   DefPrefix = "__";
 141   DefPrefix += Prefix;
 142   DefPrefix += "_";
 143
 144   Builder.defineMacro(DefPrefix + "DENORM_MIN__", Twine(DenormMin)+Ext);
 145   Builder.defineMacro(DefPrefix + "HAS_DENORM__");
 146   Builder.defineMacro(DefPrefix + "DIG__", Twine(Digits));
 147   Builder.defineMacro(DefPrefix + "DECIMAL_DIG__", Twine(DecimalDigits));
 148   Builder.defineMacro(DefPrefix + "EPSILON__", Twine(Epsilon)+Ext);
 149   Builder.defineMacro(DefPrefix + "HAS_INFINITY__");
 150   Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__");
 151   Builder.defineMacro(DefPrefix + "MANT_DIG__", Twine(MantissaDigits));
 152
 153   Builder.defineMacro(DefPrefix + "MAX_10_EXP__", Twine(Max10Exp));
 154   Builder.defineMacro(DefPrefix + "MAX_EXP__", Twine(MaxExp));
 155   Builder.defineMacro(DefPrefix + "MAX__", Twine(Max)+Ext);
 156
 157   Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+Twine(Min10Exp)+")");
 158   Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+Twine(MinExp)+")");
 159   Builder.defineMacro(DefPrefix + "MIN__", Twine(Min)+Ext);
 160 }
 161
 162
 163 /// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
 164 /// named MacroName with the max value for a type with width 'TypeWidth' a
 165 /// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
 166 static void DefineTypeSize(const Twine &MacroName, unsigned TypeWidth,
 167                            StringRef ValSuffix, bool isSigned,
 168                            MacroBuilder &Builder) {
 169   llvm::APInt MaxVal = isSigned ? llvm::APInt::getSignedMaxValue(TypeWidth)
 170                                 : llvm::APInt::getMaxValue(TypeWidth);
 171   Builder.defineMacro(MacroName, MaxVal.toString(10, isSigned) + ValSuffix);
 172 }
 173
 174 /// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
 175 /// the width, suffix, and signedness of the given type
 176 static void DefineTypeSize(const Twine &MacroName, TargetInfo::IntType Ty,
 177                            const TargetInfo &TI, MacroBuilder &Builder) {
 178   DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
 179                  TI.isTypeSigned(Ty), Builder);
 180 }
 181
 182 static void DefineFmt(const Twine &Prefix, TargetInfo::IntType Ty,
 183                       const TargetInfo &TI, MacroBuilder &Builder) {
 184   bool IsSigned = TI.isTypeSigned(Ty);
 185   StringRef FmtModifier = TI.getTypeFormatModifier(Ty);
 186   for (const char *Fmt = IsSigned ? "di" : "ouxX"; *Fmt; ++Fmt) {
 187     Builder.defineMacro(Prefix + "_FMT" + Twine(*Fmt) + "__",
 188                         Twine("\"") + FmtModifier + Twine(*Fmt) + "\"");
 189   }
 190 }
 191
 192 static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty,
 193                        MacroBuilder &Builder) {
 194   Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
 195 }
 196
 197 static void DefineTypeWidth(StringRef MacroName, TargetInfo::IntType Ty,
 198                             const TargetInfo &TI, MacroBuilder &Builder) {
 199   Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty)));
 200 }
 201
 202 static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth,
 203                              const TargetInfo &TI, MacroBuilder &Builder) {
 204   Builder.defineMacro(MacroName,
 205                       Twine(BitWidth / TI.getCharWidth()));
 206 }
 207
 208 static void DefineExactWidthIntType(TargetInfo::IntType Ty,
 209                                     const TargetInfo &TI,
 210                                     MacroBuilder &Builder) {
 211   int TypeWidth = TI.getTypeWidth(Ty);
 212   bool IsSigned = TI.isTypeSigned(Ty);
 213
 214   // Use the target specified int64 type, when appropriate, so that [u]int64_t
 215   // ends up being defined in terms of the correct type.
 216   if (TypeWidth == 64)
 217     Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
 218
 219   const char *Prefix = IsSigned ? "__INT" : "__UINT";
 220
 221   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
 222   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
 223
 224   StringRef ConstSuffix(TI.getTypeConstantSuffix(Ty));
 225   Builder.defineMacro(Prefix + Twine(TypeWidth) + "_C_SUFFIX__", ConstSuffix);
 226 }
 227
 228 static void DefineExactWidthIntTypeSize(TargetInfo::IntType Ty,
 229                                         const TargetInfo &TI,
 230                                         MacroBuilder &Builder) {
 231   int TypeWidth = TI.getTypeWidth(Ty);
 232   bool IsSigned = TI.isTypeSigned(Ty);
 233
 234   // Use the target specified int64 type, when appropriate, so that [u]int64_t
 235   // ends up being defined in terms of the correct type.
 236   if (TypeWidth == 64)
 237     Ty = IsSigned ? TI.getInt64Type() : TI.getUInt64Type();
 238
 239   const char *Prefix = IsSigned ? "__INT" : "__UINT";
 240   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
 241 }
 242
 243 static void DefineLeastWidthIntType(unsigned TypeWidth, bool IsSigned,
 244                                     const TargetInfo &TI,
 245                                     MacroBuilder &Builder) {
 246   TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
 247   if (Ty == TargetInfo::NoInt)
 248     return;
 249
 250   const char *Prefix = IsSigned ? "__INT_LEAST" : "__UINT_LEAST";
 251   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
 252   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
 253   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
 254 }
 255
 256 static void DefineFastIntType(unsigned TypeWidth, bool IsSigned,
 257                               const TargetInfo &TI, MacroBuilder &Builder) {
 258   // stdint.h currently defines the fast int types as equivalent to the least
 259   // types.
 260   TargetInfo::IntType Ty = TI.getLeastIntTypeByWidth(TypeWidth, IsSigned);
 261   if (Ty == TargetInfo::NoInt)
 262     return;
 263
 264   const char *Prefix = IsSigned ? "__INT_FAST" : "__UINT_FAST";
 265   DefineType(Prefix + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
 266   DefineTypeSize(Prefix + Twine(TypeWidth) + "_MAX__", Ty, TI, Builder);
 267
 268   DefineFmt(Prefix + Twine(TypeWidth), Ty, TI, Builder);
 269 }
 270
 271
 272 /// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with
 273 /// the specified properties.
 274 static const char *getLockFreeValue(unsigned TypeWidth, unsigned TypeAlign,
 275                                     unsigned InlineWidth) {
 276   // Fully-aligned, power-of-2 sizes no larger than the inline
 277   // width will be inlined as lock-free operations.
 278   if (TypeWidth == TypeAlign && (TypeWidth & (TypeWidth - 1)) == 0 &&
 279       TypeWidth <= InlineWidth)
 280     return "2"; // "always lock free"
 281   // We cannot be certain what operations the lib calls might be
 282   // able to implement as lock-free on future processors.
 283   return "1"; // "sometimes lock free"
 284 }
 285
 286 /// Add definitions required for a smooth interaction between
 287 /// Objective-C++ automated reference counting and libstdc++ (4.2).
 288 static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts,
 289                                          MacroBuilder &Builder) {
 290   Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR");
 291
 292   std::string Result;
 293   {
 294     // Provide specializations for the __is_scalar type trait so that
 295     // lifetime-qualified objects are not considered "scalar" types, which
 296     // libstdc++ uses as an indicator of the presence of trivial copy, assign,
 297     // default-construct, and destruct semantics (none of which hold for
 298     // lifetime-qualified objects in ARC).
 299     llvm::raw_string_ostream Out(Result);
 300
 301     Out << "namespace std {\n"
 302         << "\n"
 303         << "struct __true_type;\n"
 304         << "struct __false_type;\n"
 305         << "\n";
 306
 307     Out << "template<typename _Tp> struct __is_scalar;\n"
 308         << "\n";
 309
 310     if (LangOpts.ObjCAutoRefCount) {
 311       Out << "template<typename _Tp>\n"
 312           << "struct __is_scalar<__attribute__((objc_ownership(strong))) _Tp> {\n"
 313           << "  enum { __value = 0 };\n"
 314           << "  typedef __false_type __type;\n"
 315           << "};\n"
 316           << "\n";
 317     }
 318
 319     if (LangOpts.ObjCWeak) {
 320       Out << "template<typename _Tp>\n"
 321           << "struct __is_scalar<__attribute__((objc_ownership(weak))) _Tp> {\n"
 322           << "  enum { __value = 0 };\n"
 323           << "  typedef __false_type __type;\n"
 324           << "};\n"
 325           << "\n";
 326     }
 327
 328     if (LangOpts.ObjCAutoRefCount) {
 329       Out << "template<typename _Tp>\n"
 330           << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))"
 331           << " _Tp> {\n"
 332           << "  enum { __value = 0 };\n"
 333           << "  typedef __false_type __type;\n"
 334           << "};\n"
 335           << "\n";
 336     }
 337
 338     Out << "}\n";
 339   }
 340   Builder.append(Result);
 341 }
 342
 343 static void InitializeStandardPredefinedMacros(const TargetInfo &TI,
 344                                                const LangOptions &LangOpts,
 345                                                const FrontendOptions &FEOpts,
 346                                                MacroBuilder &Builder) {
 347   // C++ [cpp.predefined]p1:
 348   //   The following macro names shall be defined by the implementation:
 349
 350   //   -- __STDC__
 351   //      [C++] Whether __STDC__ is predefined and if so, what its value is,
 352   //      are implementation-defined.
 353   // (Removed in C++20.)
 354   if (!LangOpts.MSVCCompat && !LangOpts.TraditionalCPP)
 355     Builder.defineMacro("__STDC__");
 356   //   -- __STDC_HOSTED__
 357   //      The integer literal 1 if the implementation is a hosted
 358   //      implementation or the integer literal 0 if it is not.
 359   if (LangOpts.Freestanding)
 360     Builder.defineMacro("__STDC_HOSTED__", "0");
 361   else
 362     Builder.defineMacro("__STDC_HOSTED__");
 363
 364   //   -- __STDC_VERSION__
 365   //      [C++] Whether __STDC_VERSION__ is predefined and if so, what its
 366   //      value is, are implementation-defined.
 367   // (Removed in C++20.)
 368   if (!LangOpts.CPlusPlus) {
 369     if (LangOpts.C17)
 370       Builder.defineMacro("__STDC_VERSION__", "201710L");
 371     else if (LangOpts.C11)
 372       Builder.defineMacro("__STDC_VERSION__", "201112L");
 373     else if (LangOpts.C99)
 374       Builder.defineMacro("__STDC_VERSION__", "199901L");
 375     else if (!LangOpts.GNUMode && LangOpts.Digraphs)
 376       Builder.defineMacro("__STDC_VERSION__", "199409L");
 377   } else {
 378     //   -- __cplusplus
 379     //      [C++20] The integer literal 202002L.
 380     if (LangOpts.CPlusPlus2a)
 381       Builder.defineMacro("__cplusplus", "202002L");
 382     //      [C++17] The integer literal 201703L.
 383     else if (LangOpts.CPlusPlus17)
 384       Builder.defineMacro("__cplusplus", "201703L");
 385     //      [C++14] The name __cplusplus is defined to the value 201402L when
 386     //      compiling a C++ translation unit.
 387     else if (LangOpts.CPlusPlus14)
 388       Builder.defineMacro("__cplusplus", "201402L");
 389     //      [C++11] The name __cplusplus is defined to the value 201103L when
 390     //      compiling a C++ translation unit.
 391     else if (LangOpts.CPlusPlus11)
 392       Builder.defineMacro("__cplusplus", "201103L");
 393     //      [C++03] The name __cplusplus is defined to the value 199711L when
 394     //      compiling a C++ translation unit.
 395     else
 396       Builder.defineMacro("__cplusplus", "199711L");
 397
 398     //   -- __STDCPP_DEFAULT_NEW_ALIGNMENT__
 399     //      [C++17] An integer literal of type std::size_t whose value is the
 400     //      alignment guaranteed by a call to operator new(std::size_t)
 401     //
 402     // We provide this in all language modes, since it seems generally useful.
 403     Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__",
 404                         Twine(TI.getNewAlign() / TI.getCharWidth()) +
 405                             TI.getTypeConstantSuffix(TI.getSizeType()));
 406   }
 407
 408   // In C11 these are environment macros. In C++11 they are only defined
 409   // as part of <cuchar>. To prevent breakage when mixing C and C++
 410   // code, define these macros unconditionally. We can define them
 411   // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
 412   // and 32-bit character literals.
 413   Builder.defineMacro("__STDC_UTF_16__", "1");
 414   Builder.defineMacro("__STDC_UTF_32__", "1");
 415
 416   if (LangOpts.ObjC)
 417     Builder.defineMacro("__OBJC__");
 418
 419   // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros.
 420   if (LangOpts.OpenCL) {
 421     if (LangOpts.CPlusPlus) {
 422       if (LangOpts.OpenCLCPlusPlusVersion == 100)
 423         Builder.defineMacro("__OPENCL_CPP_VERSION__", "100");
 424       else
 425         llvm_unreachable("Unsupported C++ version for OpenCL");
 426       Builder.defineMacro("__CL_CPP_VERSION_1_0__", "100");
 427     } else {
 428       // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the
 429       // language standard with which the program is compiled. __OPENCL_VERSION__
 430       // is for the OpenCL version supported by the OpenCL device, which is not
 431       // necessarily the language standard with which the program is compiled.
 432       // A shared OpenCL header file requires a macro to indicate the language
 433       // standard. As a workaround, __OPENCL_C_VERSION__ is defined for
 434       // OpenCL v1.0 and v1.1.
 435       switch (LangOpts.OpenCLVersion) {
 436       case 100:
 437         Builder.defineMacro("__OPENCL_C_VERSION__", "100");
 438         break;
 439       case 110:
 440         Builder.defineMacro("__OPENCL_C_VERSION__", "110");
 441         break;
 442       case 120:
 443         Builder.defineMacro("__OPENCL_C_VERSION__", "120");
 444         break;
 445       case 200:
 446         Builder.defineMacro("__OPENCL_C_VERSION__", "200");
 447         break;
 448       default:
 449         llvm_unreachable("Unsupported OpenCL version");
 450       }
 451     }
 452     Builder.defineMacro("CL_VERSION_1_0", "100");
 453     Builder.defineMacro("CL_VERSION_1_1", "110");
 454     Builder.defineMacro("CL_VERSION_1_2", "120");
 455     Builder.defineMacro("CL_VERSION_2_0", "200");
 456
 457     if (TI.isLittleEndian())
 458       Builder.defineMacro("__ENDIAN_LITTLE__");
 459
 460     if (LangOpts.FastRelaxedMath)
 461       Builder.defineMacro("__FAST_RELAXED_MATH__");
 462   }
 463   // Not "standard" per se, but available even with the -undef flag.
 464   if (LangOpts.AsmPreprocessor)
 465     Builder.defineMacro("__ASSEMBLER__");
 466   if (LangOpts.CUDA && !LangOpts.HIP)
 467     Builder.defineMacro("__CUDA__");
 468   if (LangOpts.HIP) {
 469     Builder.defineMacro("__HIP__");
 470     Builder.defineMacro("__HIPCC__");
 471     if (LangOpts.CUDAIsDevice)
 472       Builder.defineMacro("__HIP_DEVICE_COMPILE__");
 473   }
 474 }
 475
 476 /// Initialize the predefined C++ language feature test macros defined in
 477 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
 478 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
 479                                                  MacroBuilder &Builder) {
 480   // C++98 features.
 481   if (LangOpts.RTTI)
 482     Builder.defineMacro("__cpp_rtti", "199711L");
 483   if (LangOpts.CXXExceptions)
 484     Builder.defineMacro("__cpp_exceptions", "199711L");
 485
 486   // C++11 features.
 487   if (LangOpts.CPlusPlus11) {
 488     Builder.defineMacro("__cpp_unicode_characters", "200704L");
 489     Builder.defineMacro("__cpp_raw_strings", "200710L");
 490     Builder.defineMacro("__cpp_unicode_literals", "200710L");
 491     Builder.defineMacro("__cpp_user_defined_literals", "200809L");
 492     Builder.defineMacro("__cpp_lambdas", "200907L");
 493     Builder.defineMacro("__cpp_constexpr",
 494                         LangOpts.CPlusPlus2a ? "201907L" :
 495                         LangOpts.CPlusPlus17 ? "201603L" :
 496                         LangOpts.CPlusPlus14 ? "201304L" : "200704");
 497     Builder.defineMacro("__cpp_constexpr_in_decltype", "201711L");
 498     Builder.defineMacro("__cpp_range_based_for",
 499                         LangOpts.CPlusPlus17 ? "201603L" : "200907");
 500     Builder.defineMacro("__cpp_static_assert",
 501                         LangOpts.CPlusPlus17 ? "201411L" : "200410");
 502     Builder.defineMacro("__cpp_decltype", "200707L");
 503     Builder.defineMacro("__cpp_attributes", "200809L");
 504     Builder.defineMacro("__cpp_rvalue_references", "200610L");
 505     Builder.defineMacro("__cpp_variadic_templates", "200704L");
 506     Builder.defineMacro("__cpp_initializer_lists", "200806L");
 507     Builder.defineMacro("__cpp_delegating_constructors", "200604L");
 508     Builder.defineMacro("__cpp_nsdmi", "200809L");
 509     Builder.defineMacro("__cpp_inheriting_constructors", "201511L");
 510     Builder.defineMacro("__cpp_ref_qualifiers", "200710L");
 511     Builder.defineMacro("__cpp_alias_templates", "200704L");
 512   }
 513   if (LangOpts.ThreadsafeStatics)
 514     Builder.defineMacro("__cpp_threadsafe_static_init", "200806L");
 515
 516   // C++14 features.
 517   if (LangOpts.CPlusPlus14) {
 518     Builder.defineMacro("__cpp_binary_literals", "201304L");
 519     Builder.defineMacro("__cpp_digit_separators", "201309L");
 520     Builder.defineMacro("__cpp_init_captures",
 521                         LangOpts.CPlusPlus2a ? "201803L" : "201304L");
 522     Builder.defineMacro("__cpp_generic_lambdas",
 523                         LangOpts.CPlusPlus2a ? "201707L" : "201304L");
 524     Builder.defineMacro("__cpp_decltype_auto", "201304L");
 525     Builder.defineMacro("__cpp_return_type_deduction", "201304L");
 526     Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L");
 527     Builder.defineMacro("__cpp_variable_templates", "201304L");
 528   }
 529   if (LangOpts.SizedDeallocation)
 530     Builder.defineMacro("__cpp_sized_deallocation", "201309L");
 531
 532   // C++17 features.
 533   if (LangOpts.CPlusPlus17) {
 534     Builder.defineMacro("__cpp_hex_float", "201603L");
 535     Builder.defineMacro("__cpp_inline_variables", "201606L");
 536     Builder.defineMacro("__cpp_noexcept_function_type", "201510L");
 537     Builder.defineMacro("__cpp_capture_star_this", "201603L");
 538     Builder.defineMacro("__cpp_if_constexpr", "201606L");
 539     Builder.defineMacro("__cpp_deduction_guides", "201703L"); // (not latest)
 540     Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name)
 541     Builder.defineMacro("__cpp_namespace_attributes", "201411L");
 542     Builder.defineMacro("__cpp_enumerator_attributes", "201411L");
 543     Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L");
 544     Builder.defineMacro("__cpp_variadic_using", "201611L");
 545     Builder.defineMacro("__cpp_aggregate_bases", "201603L");
 546     Builder.defineMacro("__cpp_structured_bindings", "201606L");
 547     Builder.defineMacro("__cpp_nontype_template_args",
 548                         "201411L"); // (not latest)
 549     Builder.defineMacro("__cpp_fold_expressions", "201603L");
 550     Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L");
 551     Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L");
 552   }
 553   if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable)
 554     Builder.defineMacro("__cpp_aligned_new", "201606L");
 555   if (LangOpts.RelaxedTemplateTemplateArgs)
 556     Builder.defineMacro("__cpp_template_template_args", "201611L");
 557
 558   // C++20 features.
 559   if (LangOpts.CPlusPlus2a) {
 560     //Builder.defineMacro("__cpp_aggregate_paren_init", "201902L");
 561     Builder.defineMacro("__cpp_concepts", "201907L");
 562     Builder.defineMacro("__cpp_conditional_explicit", "201806L");
 563     //Builder.defineMacro("__cpp_consteval", "201811L");
 564     Builder.defineMacro("__cpp_constexpr_dynamic_alloc", "201907L");
 565     Builder.defineMacro("__cpp_constinit", "201907L");
 566     //Builder.defineMacro("__cpp_coroutines", "201902L");
 567     Builder.defineMacro("__cpp_designated_initializers", "201707L");
 568     Builder.defineMacro("__cpp_impl_three_way_comparison", "201907L");
 569     //Builder.defineMacro("__cpp_modules", "201907L");
 570     //Builder.defineMacro("__cpp_using_enum", "201907L");
 571   }
 572   if (LangOpts.Char8)
 573     Builder.defineMacro("__cpp_char8_t", "201811L");
 574   Builder.defineMacro("__cpp_impl_destroying_delete", "201806L");
 575
 576   // TS features.
 577   if (LangOpts.Coroutines)
 578     Builder.defineMacro("__cpp_coroutines", "201703L");
 579 }
 580
 581 static void InitializePredefinedMacros(const TargetInfo &TI,
 582                                        const LangOptions &LangOpts,
 583                                        const FrontendOptions &FEOpts,
 584                                        const PreprocessorOptions &PPOpts,
 585                                        MacroBuilder &Builder) {
 586   // Compiler version introspection macros.
 587   Builder.defineMacro("__llvm__");  // LLVM Backend
 588   Builder.defineMacro("__clang__"); // Clang Frontend
 589 #define TOSTR2(X) #X
 590 #define TOSTR(X) TOSTR2(X)
 591   Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
 592   Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
 593   Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
 594 #undef TOSTR
 595 #undef TOSTR2
 596   Builder.defineMacro("__clang_version__",
 597                       "\"" CLANG_VERSION_STRING " "
 598                       + getClangFullRepositoryVersion() + "\"");
 599
 600   if (LangOpts.GNUCVersion != 0) {
 601     // Major, minor, patch, are given two decimal places each, so 4.2.1 becomes
 602     // 40201.
 603     unsigned GNUCMajor = LangOpts.GNUCVersion / 100 / 100;
 604     unsigned GNUCMinor = LangOpts.GNUCVersion / 100 % 100;
 605     unsigned GNUCPatch = LangOpts.GNUCVersion % 100;
 606     Builder.defineMacro("__GNUC__", Twine(GNUCMajor));
 607     Builder.defineMacro("__GNUC_MINOR__", Twine(GNUCMinor));
 608     Builder.defineMacro("__GNUC_PATCHLEVEL__", Twine(GNUCPatch));
 609     Builder.defineMacro("__GXX_ABI_VERSION", "1002");
 610
 611     if (LangOpts.CPlusPlus) {
 612       Builder.defineMacro("__GNUG__", Twine(GNUCMajor));
 613       Builder.defineMacro("__GXX_WEAK__");
 614     }
 615   }
 616
 617   // Define macros for the C11 / C++11 memory orderings
 618   Builder.defineMacro("__ATOMIC_RELAXED", "0");
 619   Builder.defineMacro("__ATOMIC_CONSUME", "1");
 620   Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
 621   Builder.defineMacro("__ATOMIC_RELEASE", "3");
 622   Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
 623   Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
 624
 625   // Define macros for the OpenCL memory scope.
 626   // The values should match AtomicScopeOpenCLModel::ID enum.
 627   static_assert(
 628       static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 &&
 629           static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 &&
 630           static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 &&
 631           static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4,
 632       "Invalid OpenCL memory scope enum definition");
 633   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0");
 634   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1");
 635   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2");
 636   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3");
 637   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4");
 638
 639   // Support for #pragma redefine_extname (Sun compatibility)
 640   Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
 641
 642   // Previously this macro was set to a string aiming to achieve compatibility
 643   // with GCC 4.2.1. Now, just return the full Clang version
 644   Builder.defineMacro("__VERSION__", "\"" +
 645                       Twine(getClangFullCPPVersion()) + "\"");
 646
 647   // Initialize language-specific preprocessor defines.
 648
 649   // Standard conforming mode?
 650   if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
 651     Builder.defineMacro("__STRICT_ANSI__");
 652
 653   if (LangOpts.GNUCVersion && LangOpts.CPlusPlus11)
 654     Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
 655
 656   if (LangOpts.ObjC) {
 657     if (LangOpts.ObjCRuntime.isNonFragile()) {
 658       Builder.defineMacro("__OBJC2__");
 659
 660       if (LangOpts.ObjCExceptions)
 661         Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
 662     }
 663
 664     if (LangOpts.getGC() != LangOptions::NonGC)
 665       Builder.defineMacro("__OBJC_GC__");
 666
 667     if (LangOpts.ObjCRuntime.isNeXTFamily())
 668       Builder.defineMacro("__NEXT_RUNTIME__");
 669
 670     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) {
 671       auto version = LangOpts.ObjCRuntime.getVersion();
 672       std::string versionString = "1";
 673       // Don't rely on the tuple argument, because we can be asked to target
 674       // later ABIs than we actually support, so clamp these values to those
 675       // currently supported
 676       if (version >= VersionTuple(2, 0))
 677         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", "20");
 678       else
 679         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__",
 680             "1" + Twine(std::min(8U, version.getMinor().getValueOr(0))));
 681     }
 682
 683     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
 684       VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
 685
 686       unsigned minor = 0;
 687       if (tuple.getMinor().hasValue())
 688         minor = tuple.getMinor().getValue();
 689
 690       unsigned subminor = 0;
 691       if (tuple.getSubminor().hasValue())
 692         subminor = tuple.getSubminor().getValue();
 693
 694       Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
 695                           Twine(tuple.getMajor() * 10000 + minor * 100 +
 696                                 subminor));
 697     }
 698
 699     Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
 700     Builder.defineMacro("IBOutletCollection(ClassName)",
 701                         "__attribute__((iboutletcollection(ClassName)))");
 702     Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
 703     Builder.defineMacro("IBInspectable", "");
 704     Builder.defineMacro("IB_DESIGNABLE", "");
 705   }
 706
 707   // Define a macro that describes the Objective-C boolean type even for C
 708   // and C++ since BOOL can be used from non Objective-C code.
 709   Builder.defineMacro("__OBJC_BOOL_IS_BOOL",
 710                       Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
 711
 712   if (LangOpts.CPlusPlus)
 713     InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
 714
 715   // darwin_constant_cfstrings controls this. This is also dependent
 716   // on other things like the runtime I believe.  This is set even for C code.
 717   if (!LangOpts.NoConstantCFStrings)
 718       Builder.defineMacro("__CONSTANT_CFSTRINGS__");
 719
 720   if (LangOpts.ObjC)
 721     Builder.defineMacro("OBJC_NEW_PROPERTIES");
 722
 723   if (LangOpts.PascalStrings)
 724     Builder.defineMacro("__PASCAL_STRINGS__");
 725
 726   if (LangOpts.Blocks) {
 727     Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
 728     Builder.defineMacro("__BLOCKS__");
 729   }
 730
 731   if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
 732     Builder.defineMacro("__EXCEPTIONS");
 733   if (LangOpts.GNUCVersion && LangOpts.RTTI)
 734     Builder.defineMacro("__GXX_RTTI");
 735
 736   if (LangOpts.SjLjExceptions)
 737     Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
 738   else if (LangOpts.SEHExceptions)
 739     Builder.defineMacro("__SEH__");
 740   else if (LangOpts.DWARFExceptions &&
 741           (TI.getTriple().isThumb() || TI.getTriple().isARM()))
 742     Builder.defineMacro("__ARM_DWARF_EH__");
 743
 744   if (LangOpts.Deprecated)
 745     Builder.defineMacro("__DEPRECATED");
 746
 747   if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus)
 748     Builder.defineMacro("__private_extern__", "extern");
 749
 750   if (LangOpts.MicrosoftExt) {
 751     if (LangOpts.WChar) {
 752       // wchar_t supported as a keyword.
 753       Builder.defineMacro("_WCHAR_T_DEFINED");
 754       Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
 755     }
 756   }
 757
 758   if (LangOpts.Optimize)
 759     Builder.defineMacro("__OPTIMIZE__");
 760   if (LangOpts.OptimizeSize)
 761     Builder.defineMacro("__OPTIMIZE_SIZE__");
 762
 763   if (LangOpts.FastMath)
 764     Builder.defineMacro("__FAST_MATH__");
 765
 766   // Initialize target-specific preprocessor defines.
 767
 768   // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
 769   // to the macro __BYTE_ORDER (no trailing underscores)
 770   // from glibc's <endian.h> header.
 771   // We don't support the PDP-11 as a target, but include
 772   // the define so it can still be compared against.
 773   Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
 774   Builder.defineMacro("__ORDER_BIG_ENDIAN__",    "4321");
 775   Builder.defineMacro("__ORDER_PDP_ENDIAN__",    "3412");
 776   if (TI.isBigEndian()) {
 777     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
 778     Builder.defineMacro("__BIG_ENDIAN__");
 779   } else {
 780     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
 781     Builder.defineMacro("__LITTLE_ENDIAN__");
 782   }
 783
 784   if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
 785       && TI.getIntWidth() == 32) {
 786     Builder.defineMacro("_LP64");
 787     Builder.defineMacro("__LP64__");
 788   }
 789
 790   if (TI.getPointerWidth(0) == 32 && TI.getLongWidth() == 32
 791       && TI.getIntWidth() == 32) {
 792     Builder.defineMacro("_ILP32");
 793     Builder.defineMacro("__ILP32__");
 794   }
 795
 796   // Define type sizing macros based on the target properties.
 797   assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
 798   Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth()));
 799
 800   DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
 801   DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
 802   DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
 803   DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
 804   DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
 805   DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
 806   DefineTypeSize("__WINT_MAX__", TI.getWIntType(), TI, Builder);
 807   DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
 808   DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
 809
 810   DefineTypeSize("__UINTMAX_MAX__", TI.getUIntMaxType(), TI, Builder);
 811   DefineTypeSize("__PTRDIFF_MAX__", TI.getPtrDiffType(0), TI, Builder);
 812   DefineTypeSize("__INTPTR_MAX__", TI.getIntPtrType(), TI, Builder);
 813   DefineTypeSize("__UINTPTR_MAX__", TI.getUIntPtrType(), TI, Builder);
 814
 815   DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
 816   DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
 817   DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
 818   DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
 819   DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
 820   DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
 821   DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
 822   DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
 823   DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
 824                    TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
 825   DefineTypeSizeof("__SIZEOF_SIZE_T__",
 826                    TI.getTypeWidth(TI.getSizeType()), TI, Builder);
 827   DefineTypeSizeof("__SIZEOF_WCHAR_T__",
 828                    TI.getTypeWidth(TI.getWCharType()), TI, Builder);
 829   DefineTypeSizeof("__SIZEOF_WINT_T__",
 830                    TI.getTypeWidth(TI.getWIntType()), TI, Builder);
 831   if (TI.hasInt128Type())
 832     DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
 833
 834   DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
 835   DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder);
 836   Builder.defineMacro("__INTMAX_C_SUFFIX__",
 837                       TI.getTypeConstantSuffix(TI.getIntMaxType()));
 838   DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
 839   DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
 840   Builder.defineMacro("__UINTMAX_C_SUFFIX__",
 841                       TI.getTypeConstantSuffix(TI.getUIntMaxType()));
 842   DefineTypeWidth("__INTMAX_WIDTH__",  TI.getIntMaxType(), TI, Builder);
 843   DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
 844   DefineFmt("__PTRDIFF", TI.getPtrDiffType(0), TI, Builder);
 845   DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
 846   DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
 847   DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder);
 848   DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
 849   DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
 850   DefineFmt("__SIZE", TI.getSizeType(), TI, Builder);
 851   DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
 852   DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
 853   DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
 854   DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
 855   DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
 856   DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
 857   DefineTypeSize("__SIG_ATOMIC_MAX__", TI.getSigAtomicType(), TI, Builder);
 858   DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
 859   DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
 860
 861   DefineTypeWidth("__UINTMAX_WIDTH__",  TI.getUIntMaxType(), TI, Builder);
 862   DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder);
 863   DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
 864   DefineTypeWidth("__UINTPTR_WIDTH__", TI.getUIntPtrType(), TI, Builder);
 865
 866   if (TI.hasFloat16Type())
 867     DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16");
 868   DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
 869   DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
 870   DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
 871
 872   // Define a __POINTER_WIDTH__ macro for stdint.h.
 873   Builder.defineMacro("__POINTER_WIDTH__",
 874                       Twine((int)TI.getPointerWidth(0)));
 875
 876   // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
 877   Builder.defineMacro("__BIGGEST_ALIGNMENT__",
 878                       Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
 879
 880   if (!LangOpts.CharIsSigned)
 881     Builder.defineMacro("__CHAR_UNSIGNED__");
 882
 883   if (!TargetInfo::isTypeSigned(TI.getWCharType()))
 884     Builder.defineMacro("__WCHAR_UNSIGNED__");
 885
 886   if (!TargetInfo::isTypeSigned(TI.getWIntType()))
 887     Builder.defineMacro("__WINT_UNSIGNED__");
 888
 889   // Define exact-width integer types for stdint.h
 890   DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder);
 891
 892   if (TI.getShortWidth() > TI.getCharWidth())
 893     DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
 894
 895   if (TI.getIntWidth() > TI.getShortWidth())
 896     DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
 897
 898   if (TI.getLongWidth() > TI.getIntWidth())
 899     DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
 900
 901   if (TI.getLongLongWidth() > TI.getLongWidth())
 902     DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
 903
 904   DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder);
 905   DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder);
 906   DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder);
 907
 908   if (TI.getShortWidth() > TI.getCharWidth()) {
 909     DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder);
 910     DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder);
 911     DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder);
 912   }
 913
 914   if (TI.getIntWidth() > TI.getShortWidth()) {
 915     DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder);
 916     DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder);
 917     DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder);
 918   }
 919
 920   if (TI.getLongWidth() > TI.getIntWidth()) {
 921     DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder);
 922     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder);
 923     DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder);
 924   }
 925
 926   if (TI.getLongLongWidth() > TI.getLongWidth()) {
 927     DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder);
 928     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder);
 929     DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder);
 930   }
 931
 932   DefineLeastWidthIntType(8, true, TI, Builder);
 933   DefineLeastWidthIntType(8, false, TI, Builder);
 934   DefineLeastWidthIntType(16, true, TI, Builder);
 935   DefineLeastWidthIntType(16, false, TI, Builder);
 936   DefineLeastWidthIntType(32, true, TI, Builder);
 937   DefineLeastWidthIntType(32, false, TI, Builder);
 938   DefineLeastWidthIntType(64, true, TI, Builder);
 939   DefineLeastWidthIntType(64, false, TI, Builder);
 940
 941   DefineFastIntType(8, true, TI, Builder);
 942   DefineFastIntType(8, false, TI, Builder);
 943   DefineFastIntType(16, true, TI, Builder);
 944   DefineFastIntType(16, false, TI, Builder);
 945   DefineFastIntType(32, true, TI, Builder);
 946   DefineFastIntType(32, false, TI, Builder);
 947   DefineFastIntType(64, true, TI, Builder);
 948   DefineFastIntType(64, false, TI, Builder);
 949
 950   char UserLabelPrefix[2] = {TI.getDataLayout().getGlobalPrefix(), 0};
 951   Builder.defineMacro("__USER_LABEL_PREFIX__", UserLabelPrefix);
 952
 953   if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
 954     Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
 955   else
 956     Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
 957
 958   if (LangOpts.GNUCVersion) {
 959     if (LangOpts.GNUInline || LangOpts.CPlusPlus)
 960       Builder.defineMacro("__GNUC_GNU_INLINE__");
 961     else
 962       Builder.defineMacro("__GNUC_STDC_INLINE__");
 963
 964     // The value written by __atomic_test_and_set.
 965     // FIXME: This is target-dependent.
 966     Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
 967   }
 968
 969   auto addLockFreeMacros = [&](const llvm::Twine &Prefix) {
 970     // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
 971     unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
 972 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type)                                     \
 973   Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE",                             \
 974                       getLockFreeValue(TI.get##Type##Width(),                  \
 975                                        TI.get##Type##Align(),                  \
 976                                        InlineWidthBits));
 977     DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
 978     DEFINE_LOCK_FREE_MACRO(CHAR, Char);
 979     if (LangOpts.Char8)
 980       DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char.
 981     DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
 982     DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
 983     DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
 984     DEFINE_LOCK_FREE_MACRO(SHORT, Short);
 985     DEFINE_LOCK_FREE_MACRO(INT, Int);
 986     DEFINE_LOCK_FREE_MACRO(LONG, Long);
 987     DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
 988     Builder.defineMacro(Prefix + "POINTER_LOCK_FREE",
 989                         getLockFreeValue(TI.getPointerWidth(0),
 990                                          TI.getPointerAlign(0),
 991                                          InlineWidthBits));
 992 #undef DEFINE_LOCK_FREE_MACRO
 993   };
 994   addLockFreeMacros("__CLANG_ATOMIC_");
 995   if (LangOpts.GNUCVersion)
 996     addLockFreeMacros("__GCC_ATOMIC_");
 997
 998   if (LangOpts.NoInlineDefine)
 999     Builder.defineMacro("__NO_INLINE__");
1000
1001   if (unsigned PICLevel = LangOpts.PICLevel) {
1002     Builder.defineMacro("__PIC__", Twine(PICLevel));
1003     Builder.defineMacro("__pic__", Twine(PICLevel));
1004     if (LangOpts.PIE) {
1005       Builder.defineMacro("__PIE__", Twine(PICLevel));
1006       Builder.defineMacro("__pie__", Twine(PICLevel));
1007     }
1008   }
1009
1010   // Macros to control C99 numerics and <float.h>
1011   Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
1012   Builder.defineMacro("__FLT_RADIX__", "2");
1013   Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__");
1014
1015   if (LangOpts.getStackProtector() == LangOptions::SSPOn)
1016     Builder.defineMacro("__SSP__");
1017   else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
1018     Builder.defineMacro("__SSP_STRONG__", "2");
1019   else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
1020     Builder.defineMacro("__SSP_ALL__", "3");
1021
1022   if (PPOpts.SetUpStaticAnalyzer)
1023     Builder.defineMacro("__clang_analyzer__");
1024
1025   if (LangOpts.FastRelaxedMath)
1026     Builder.defineMacro("__FAST_RELAXED_MATH__");
1027
1028   if (FEOpts.ProgramAction == frontend::RewriteObjC ||
1029       LangOpts.getGC() != LangOptions::NonGC) {
1030     Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
1031     Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))");
1032     Builder.defineMacro("__autoreleasing", "");
1033     Builder.defineMacro("__unsafe_unretained", "");
1034   } else if (LangOpts.ObjC) {
1035     Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
1036     Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
1037     Builder.defineMacro("__autoreleasing",
1038                         "__attribute__((objc_ownership(autoreleasing)))");
1039     Builder.defineMacro("__unsafe_unretained",
1040                         "__attribute__((objc_ownership(none)))");
1041   }
1042
1043   // On Darwin, there are __double_underscored variants of the type
1044   // nullability qualifiers.
1045   if (TI.getTriple().isOSDarwin()) {
1046     Builder.defineMacro("__nonnull", "_Nonnull");
1047     Builder.defineMacro("__null_unspecified", "_Null_unspecified");
1048     Builder.defineMacro("__nullable", "_Nullable");
1049   }
1050
1051   // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and
1052   // the corresponding simulator targets.
1053   if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment())
1054     Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1");
1055
1056   // OpenMP definition
1057   // OpenMP 2.2:
1058   //   In implementations that support a preprocessor, the _OPENMP
1059   //   macro name is defined to have the decimal value yyyymm where
1060   //   yyyy and mm are the year and the month designations of the
1061   //   version of the OpenMP API that the implementation support.
1062   if (!LangOpts.OpenMPSimd) {
1063     switch (LangOpts.OpenMP) {
1064     case 0:
1065       break;
1066     case 31:
1067       Builder.defineMacro("_OPENMP", "201107");
1068       break;
1069     case 40:
1070       Builder.defineMacro("_OPENMP", "201307");
1071       break;
1072     case 50:
1073       Builder.defineMacro("_OPENMP", "201811");
1074       break;
1075     default:
1076       // Default version is OpenMP 4.5
1077       Builder.defineMacro("_OPENMP", "201511");
1078       break;
1079     }
1080   }
1081
1082   // CUDA device path compilaton
1083   if (LangOpts.CUDAIsDevice && !LangOpts.HIP) {
1084     // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
1085     // backend's target defines.
1086     Builder.defineMacro("__CUDA_ARCH__");
1087   }
1088
1089   // We need to communicate this to our CUDA header wrapper, which in turn
1090   // informs the proper CUDA headers of this choice.
1091   if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) {
1092     Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__");
1093   }
1094
1095   // Define a macro indicating that the source file is being compiled with a
1096   // SYCL device compiler which doesn't produce host binary.
1097   if (LangOpts.SYCLIsDevice) {
1098     Builder.defineMacro("__SYCL_DEVICE_ONLY__", "1");
1099   }
1100
1101   // OpenCL definitions.
1102   if (LangOpts.OpenCL) {
1103 #define OPENCLEXT(Ext)                                                         \
1104   if (TI.getSupportedOpenCLOpts().isSupported(#Ext, LangOpts))                 \
1105     Builder.defineMacro(#Ext);
1106 #include "clang/Basic/OpenCLExtensions.def"
1107
1108     if (TI.getTriple().isSPIR())
1109       Builder.defineMacro("__IMAGE_SUPPORT__");
1110   }
1111
1112   if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1113     // For each extended integer type, g++ defines a macro mapping the
1114     // index of the type (0 in this case) in some list of extended types
1115     // to the type.
1116     Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128");
1117     Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128");
1118   }
1119
1120   // Get other target #defines.
1121   TI.getTargetDefines(LangOpts, Builder);
1122 }
1123
1124 /// InitializePreprocessor - Initialize the preprocessor getting it and the
1125 /// environment ready to process a single file. This returns true on error.
1126 ///
1127 void clang::InitializePreprocessor(
1128     Preprocessor &PP, const PreprocessorOptions &InitOpts,
1129     const PCHContainerReader &PCHContainerRdr,
1130     const FrontendOptions &FEOpts) {
1131   const LangOptions &LangOpts = PP.getLangOpts();
1132   std::string PredefineBuffer;
1133   PredefineBuffer.reserve(4080);
1134   llvm::raw_string_ostream Predefines(PredefineBuffer);
1135   MacroBuilder Builder(Predefines);
1136
1137   // Emit line markers for various builtin sections of the file.  We don't do
1138   // this in asm preprocessor mode, because "# 4" is not a line marker directive
1139   // in this mode.
1140   if (!PP.getLangOpts().AsmPreprocessor)
1141     Builder.append("# 1 \"<built-in>\" 3");
1142
1143   // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1144   if (InitOpts.UsePredefines) {
1145     // FIXME: This will create multiple definitions for most of the predefined
1146     // macros. This is not the right way to handle this.
1147     if ((LangOpts.CUDA || LangOpts.OpenMPIsDevice || LangOpts.SYCLIsDevice) &&
1148         PP.getAuxTargetInfo())
1149       InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts,
1150                                  PP.getPreprocessorOpts(), Builder);
1151
1152     InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts,
1153                                PP.getPreprocessorOpts(), Builder);
1154
1155     // Install definitions to make Objective-C++ ARC work well with various
1156     // C++ Standard Library implementations.
1157     if (LangOpts.ObjC && LangOpts.CPlusPlus &&
1158         (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1159       switch (InitOpts.ObjCXXARCStandardLibrary) {
1160       case ARCXX_nolib:
1161       case ARCXX_libcxx:
1162         break;
1163
1164       case ARCXX_libstdcxx:
1165         AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1166         break;
1167       }
1168     }
1169   }
1170
1171   // Even with predefines off, some macros are still predefined.
1172   // These should all be defined in the preprocessor according to the
1173   // current language configuration.
1174   InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
1175                                      FEOpts, Builder);
1176
1177   // Add on the predefines from the driver.  Wrap in a #line directive to report
1178   // that they come from the command line.
1179   if (!PP.getLangOpts().AsmPreprocessor)
1180     Builder.append("# 1 \"<command line>\" 1");
1181
1182   // Process #define's and #undef's in the order they are given.
1183   for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1184     if (InitOpts.Macros[i].second)  // isUndef
1185       Builder.undefineMacro(InitOpts.Macros[i].first);
1186     else
1187       DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
1188                          PP.getDiagnostics());
1189   }
1190
1191   // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1192   if (!PP.getLangOpts().AsmPreprocessor)
1193     Builder.append("# 1 \"<built-in>\" 2");
1194
1195   // If -imacros are specified, include them now.  These are processed before
1196   // any -include directives.
1197   for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1198     AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
1199
1200   // Process -include-pch/-include-pth directives.
1201   if (!InitOpts.ImplicitPCHInclude.empty())
1202     AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1203                           InitOpts.ImplicitPCHInclude);
1204
1205   // Process -include directives.
1206   for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1207     const std::string &Path = InitOpts.Includes[i];
1208     AddImplicitInclude(Builder, Path);
1209   }
1210
1211   // Instruct the preprocessor to skip the preamble.
1212   PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
1213                              InitOpts.PrecompiledPreambleBytes.second);
1214
1215   // Copy PredefinedBuffer into the Preprocessor.
1216   PP.setPredefines(Predefines.str());
1217 }