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   if (!LangOpts.MSVCCompat && !LangOpts.TraditionalCPP)
 348     Builder.defineMacro("__STDC__");
 349   if (LangOpts.Freestanding)
 350     Builder.defineMacro("__STDC_HOSTED__", "0");
 351   else
 352     Builder.defineMacro("__STDC_HOSTED__");
 353
 354   if (!LangOpts.CPlusPlus) {
 355     if (LangOpts.C17)
 356       Builder.defineMacro("__STDC_VERSION__", "201710L");
 357     else if (LangOpts.C11)
 358       Builder.defineMacro("__STDC_VERSION__", "201112L");
 359     else if (LangOpts.C99)
 360       Builder.defineMacro("__STDC_VERSION__", "199901L");
 361     else if (!LangOpts.GNUMode && LangOpts.Digraphs)
 362       Builder.defineMacro("__STDC_VERSION__", "199409L");
 363   } else {
 364     // FIXME: Use correct value for C++20.
 365     if (LangOpts.CPlusPlus2a)
 366       Builder.defineMacro("__cplusplus", "201707L");
 367     // C++17 [cpp.predefined]p1:
 368     //   The name __cplusplus is defined to the value 201703L when compiling a
 369     //   C++ translation unit.
 370     else if (LangOpts.CPlusPlus17)
 371       Builder.defineMacro("__cplusplus", "201703L");
 372     // C++1y [cpp.predefined]p1:
 373     //   The name __cplusplus is defined to the value 201402L when compiling a
 374     //   C++ translation unit.
 375     else if (LangOpts.CPlusPlus14)
 376       Builder.defineMacro("__cplusplus", "201402L");
 377     // C++11 [cpp.predefined]p1:
 378     //   The name __cplusplus is defined to the value 201103L when compiling a
 379     //   C++ translation unit.
 380     else if (LangOpts.CPlusPlus11)
 381       Builder.defineMacro("__cplusplus", "201103L");
 382     // C++03 [cpp.predefined]p1:
 383     //   The name __cplusplus is defined to the value 199711L when compiling a
 384     //   C++ translation unit.
 385     else
 386       Builder.defineMacro("__cplusplus", "199711L");
 387
 388     // C++1z [cpp.predefined]p1:
 389     //   An integer literal of type std::size_t whose value is the alignment
 390     //   guaranteed by a call to operator new(std::size_t)
 391     //
 392     // We provide this in all language modes, since it seems generally useful.
 393     Builder.defineMacro("__STDCPP_DEFAULT_NEW_ALIGNMENT__",
 394                         Twine(TI.getNewAlign() / TI.getCharWidth()) +
 395                             TI.getTypeConstantSuffix(TI.getSizeType()));
 396   }
 397
 398   // In C11 these are environment macros. In C++11 they are only defined
 399   // as part of <cuchar>. To prevent breakage when mixing C and C++
 400   // code, define these macros unconditionally. We can define them
 401   // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
 402   // and 32-bit character literals.
 403   Builder.defineMacro("__STDC_UTF_16__", "1");
 404   Builder.defineMacro("__STDC_UTF_32__", "1");
 405
 406   if (LangOpts.ObjC)
 407     Builder.defineMacro("__OBJC__");
 408
 409   // OpenCL v1.0/1.1 s6.9, v1.2/2.0 s6.10: Preprocessor Directives and Macros.
 410   if (LangOpts.OpenCL) {
 411     if (LangOpts.CPlusPlus) {
 412       if (LangOpts.OpenCLCPlusPlusVersion == 100)
 413         Builder.defineMacro("__OPENCL_CPP_VERSION__", "100");
 414       else
 415         llvm_unreachable("Unsupported C++ version for OpenCL");
 416       Builder.defineMacro("__CL_CPP_VERSION_1_0__", "100");
 417     } else {
 418       // OpenCL v1.0 and v1.1 do not have a predefined macro to indicate the
 419       // language standard with which the program is compiled. __OPENCL_VERSION__
 420       // is for the OpenCL version supported by the OpenCL device, which is not
 421       // necessarily the language standard with which the program is compiled.
 422       // A shared OpenCL header file requires a macro to indicate the language
 423       // standard. As a workaround, __OPENCL_C_VERSION__ is defined for
 424       // OpenCL v1.0 and v1.1.
 425       switch (LangOpts.OpenCLVersion) {
 426       case 100:
 427         Builder.defineMacro("__OPENCL_C_VERSION__", "100");
 428         break;
 429       case 110:
 430         Builder.defineMacro("__OPENCL_C_VERSION__", "110");
 431         break;
 432       case 120:
 433         Builder.defineMacro("__OPENCL_C_VERSION__", "120");
 434         break;
 435       case 200:
 436         Builder.defineMacro("__OPENCL_C_VERSION__", "200");
 437         break;
 438       default:
 439         llvm_unreachable("Unsupported OpenCL version");
 440       }
 441     }
 442     Builder.defineMacro("CL_VERSION_1_0", "100");
 443     Builder.defineMacro("CL_VERSION_1_1", "110");
 444     Builder.defineMacro("CL_VERSION_1_2", "120");
 445     Builder.defineMacro("CL_VERSION_2_0", "200");
 446
 447     if (TI.isLittleEndian())
 448       Builder.defineMacro("__ENDIAN_LITTLE__");
 449
 450     if (LangOpts.FastRelaxedMath)
 451       Builder.defineMacro("__FAST_RELAXED_MATH__");
 452   }
 453   // Not "standard" per se, but available even with the -undef flag.
 454   if (LangOpts.AsmPreprocessor)
 455     Builder.defineMacro("__ASSEMBLER__");
 456   if (LangOpts.CUDA && !LangOpts.HIP)
 457     Builder.defineMacro("__CUDA__");
 458   if (LangOpts.HIP) {
 459     Builder.defineMacro("__HIP__");
 460     Builder.defineMacro("__HIPCC__");
 461     if (LangOpts.CUDAIsDevice)
 462       Builder.defineMacro("__HIP_DEVICE_COMPILE__");
 463   }
 464 }
 465
 466 /// Initialize the predefined C++ language feature test macros defined in
 467 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
 468 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
 469                                                  MacroBuilder &Builder) {
 470   // C++98 features.
 471   if (LangOpts.RTTI)
 472     Builder.defineMacro("__cpp_rtti", "199711L");
 473   if (LangOpts.CXXExceptions)
 474     Builder.defineMacro("__cpp_exceptions", "199711L");
 475
 476   // C++11 features.
 477   if (LangOpts.CPlusPlus11) {
 478     Builder.defineMacro("__cpp_unicode_characters", "200704L");
 479     Builder.defineMacro("__cpp_raw_strings", "200710L");
 480     Builder.defineMacro("__cpp_unicode_literals", "200710L");
 481     Builder.defineMacro("__cpp_user_defined_literals", "200809L");
 482     Builder.defineMacro("__cpp_lambdas", "200907L");
 483     Builder.defineMacro("__cpp_constexpr",
 484                         LangOpts.CPlusPlus2a ? "201907L" :
 485                         LangOpts.CPlusPlus17 ? "201603L" :
 486                         LangOpts.CPlusPlus14 ? "201304L" : "200704");
 487     Builder.defineMacro("__cpp_range_based_for",
 488                         LangOpts.CPlusPlus17 ? "201603L" : "200907");
 489     Builder.defineMacro("__cpp_static_assert",
 490                         LangOpts.CPlusPlus17 ? "201411L" : "200410");
 491     Builder.defineMacro("__cpp_decltype", "200707L");
 492     Builder.defineMacro("__cpp_attributes", "200809L");
 493     Builder.defineMacro("__cpp_rvalue_references", "200610L");
 494     Builder.defineMacro("__cpp_variadic_templates", "200704L");
 495     Builder.defineMacro("__cpp_initializer_lists", "200806L");
 496     Builder.defineMacro("__cpp_delegating_constructors", "200604L");
 497     Builder.defineMacro("__cpp_nsdmi", "200809L");
 498     Builder.defineMacro("__cpp_inheriting_constructors", "201511L");
 499     Builder.defineMacro("__cpp_ref_qualifiers", "200710L");
 500     Builder.defineMacro("__cpp_alias_templates", "200704L");
 501   }
 502   if (LangOpts.ThreadsafeStatics)
 503     Builder.defineMacro("__cpp_threadsafe_static_init", "200806L");
 504
 505   // C++14 features.
 506   if (LangOpts.CPlusPlus14) {
 507     Builder.defineMacro("__cpp_binary_literals", "201304L");
 508     Builder.defineMacro("__cpp_digit_separators", "201309L");
 509     Builder.defineMacro("__cpp_init_captures", "201304L");
 510     Builder.defineMacro("__cpp_generic_lambdas", "201304L");
 511     Builder.defineMacro("__cpp_decltype_auto", "201304L");
 512     Builder.defineMacro("__cpp_return_type_deduction", "201304L");
 513     Builder.defineMacro("__cpp_aggregate_nsdmi", "201304L");
 514     Builder.defineMacro("__cpp_variable_templates", "201304L");
 515   }
 516   if (LangOpts.SizedDeallocation)
 517     Builder.defineMacro("__cpp_sized_deallocation", "201309L");
 518
 519   // C++17 features.
 520   if (LangOpts.CPlusPlus17) {
 521     Builder.defineMacro("__cpp_hex_float", "201603L");
 522     Builder.defineMacro("__cpp_inline_variables", "201606L");
 523     Builder.defineMacro("__cpp_noexcept_function_type", "201510L");
 524     Builder.defineMacro("__cpp_capture_star_this", "201603L");
 525     Builder.defineMacro("__cpp_if_constexpr", "201606L");
 526     Builder.defineMacro("__cpp_deduction_guides", "201703L");
 527     Builder.defineMacro("__cpp_template_auto", "201606L"); // (old name)
 528     Builder.defineMacro("__cpp_namespace_attributes", "201411L");
 529     Builder.defineMacro("__cpp_enumerator_attributes", "201411L");
 530     Builder.defineMacro("__cpp_nested_namespace_definitions", "201411L");
 531     Builder.defineMacro("__cpp_variadic_using", "201611L");
 532     Builder.defineMacro("__cpp_aggregate_bases", "201603L");
 533     Builder.defineMacro("__cpp_structured_bindings", "201606L");
 534     Builder.defineMacro("__cpp_nontype_template_args", "201411L");
 535     Builder.defineMacro("__cpp_fold_expressions", "201603L");
 536     Builder.defineMacro("__cpp_guaranteed_copy_elision", "201606L");
 537     Builder.defineMacro("__cpp_nontype_template_parameter_auto", "201606L");
 538   }
 539   if (LangOpts.AlignedAllocation && !LangOpts.AlignedAllocationUnavailable)
 540     Builder.defineMacro("__cpp_aligned_new", "201606L");
 541   if (LangOpts.RelaxedTemplateTemplateArgs)
 542     Builder.defineMacro("__cpp_template_template_args", "201611L");
 543
 544   // C++20 features.
 545   if (LangOpts.CPlusPlus2a) {
 546     Builder.defineMacro("__cpp_conditional_explicit", "201806L");
 547     Builder.defineMacro("__cpp_constexpr_dynamic_alloc", "201907L");
 548     Builder.defineMacro("__cpp_constinit", "201907L");
 549   }
 550   if (LangOpts.Char8)
 551     Builder.defineMacro("__cpp_char8_t", "201811L");
 552   Builder.defineMacro("__cpp_impl_destroying_delete", "201806L");
 553
 554   // TS features.
 555   if (LangOpts.ConceptsTS)
 556     Builder.defineMacro("__cpp_experimental_concepts", "1L");
 557   if (LangOpts.Coroutines)
 558     Builder.defineMacro("__cpp_coroutines", "201703L");
 559 }
 560
 561 static void InitializePredefinedMacros(const TargetInfo &TI,
 562                                        const LangOptions &LangOpts,
 563                                        const FrontendOptions &FEOpts,
 564                                        const PreprocessorOptions &PPOpts,
 565                                        MacroBuilder &Builder) {
 566   // Compiler version introspection macros.
 567   Builder.defineMacro("__llvm__");  // LLVM Backend
 568   Builder.defineMacro("__clang__"); // Clang Frontend
 569 #define TOSTR2(X) #X
 570 #define TOSTR(X) TOSTR2(X)
 571   Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
 572   Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
 573   Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
 574 #undef TOSTR
 575 #undef TOSTR2
 576   Builder.defineMacro("__clang_version__",
 577                       "\"" CLANG_VERSION_STRING " "
 578                       + getClangFullRepositoryVersion() + "\"");
 579
 580   if (LangOpts.GNUCVersion != 0) {
 581     // Major, minor, patch, are given two decimal places each, so 4.2.1 becomes
 582     // 40201.
 583     unsigned GNUCMajor = LangOpts.GNUCVersion / 100 / 100;
 584     unsigned GNUCMinor = LangOpts.GNUCVersion / 100 % 100;
 585     unsigned GNUCPatch = LangOpts.GNUCVersion % 100;
 586     Builder.defineMacro("__GNUC__", Twine(GNUCMajor));
 587     Builder.defineMacro("__GNUC_MINOR__", Twine(GNUCMinor));
 588     Builder.defineMacro("__GNUC_PATCHLEVEL__", Twine(GNUCPatch));
 589     Builder.defineMacro("__GXX_ABI_VERSION", "1002");
 590
 591     if (LangOpts.CPlusPlus) {
 592       Builder.defineMacro("__GNUG__", Twine(GNUCMajor));
 593       Builder.defineMacro("__GXX_WEAK__");
 594     }
 595   }
 596
 597   // Define macros for the C11 / C++11 memory orderings
 598   Builder.defineMacro("__ATOMIC_RELAXED", "0");
 599   Builder.defineMacro("__ATOMIC_CONSUME", "1");
 600   Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
 601   Builder.defineMacro("__ATOMIC_RELEASE", "3");
 602   Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
 603   Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
 604
 605   // Define macros for the OpenCL memory scope.
 606   // The values should match AtomicScopeOpenCLModel::ID enum.
 607   static_assert(
 608       static_cast<unsigned>(AtomicScopeOpenCLModel::WorkGroup) == 1 &&
 609           static_cast<unsigned>(AtomicScopeOpenCLModel::Device) == 2 &&
 610           static_cast<unsigned>(AtomicScopeOpenCLModel::AllSVMDevices) == 3 &&
 611           static_cast<unsigned>(AtomicScopeOpenCLModel::SubGroup) == 4,
 612       "Invalid OpenCL memory scope enum definition");
 613   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_ITEM", "0");
 614   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_WORK_GROUP", "1");
 615   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_DEVICE", "2");
 616   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_ALL_SVM_DEVICES", "3");
 617   Builder.defineMacro("__OPENCL_MEMORY_SCOPE_SUB_GROUP", "4");
 618
 619   // Support for #pragma redefine_extname (Sun compatibility)
 620   Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
 621
 622   // Previously this macro was set to a string aiming to achieve compatibility
 623   // with GCC 4.2.1. Now, just return the full Clang version
 624   Builder.defineMacro("__VERSION__", "\"" +
 625                       Twine(getClangFullCPPVersion()) + "\"");
 626
 627   // Initialize language-specific preprocessor defines.
 628
 629   // Standard conforming mode?
 630   if (!LangOpts.GNUMode && !LangOpts.MSVCCompat)
 631     Builder.defineMacro("__STRICT_ANSI__");
 632
 633   if (LangOpts.GNUCVersion && LangOpts.CPlusPlus11)
 634     Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
 635
 636   if (LangOpts.ObjC) {
 637     if (LangOpts.ObjCRuntime.isNonFragile()) {
 638       Builder.defineMacro("__OBJC2__");
 639
 640       if (LangOpts.ObjCExceptions)
 641         Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
 642     }
 643
 644     if (LangOpts.getGC() != LangOptions::NonGC)
 645       Builder.defineMacro("__OBJC_GC__");
 646
 647     if (LangOpts.ObjCRuntime.isNeXTFamily())
 648       Builder.defineMacro("__NEXT_RUNTIME__");
 649
 650     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::GNUstep) {
 651       auto version = LangOpts.ObjCRuntime.getVersion();
 652       std::string versionString = "1";
 653       // Don't rely on the tuple argument, because we can be asked to target
 654       // later ABIs than we actually support, so clamp these values to those
 655       // currently supported
 656       if (version >= VersionTuple(2, 0))
 657         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__", "20");
 658       else
 659         Builder.defineMacro("__OBJC_GNUSTEP_RUNTIME_ABI__",
 660             "1" + Twine(std::min(8U, version.getMinor().getValueOr(0))));
 661     }
 662
 663     if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
 664       VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
 665
 666       unsigned minor = 0;
 667       if (tuple.getMinor().hasValue())
 668         minor = tuple.getMinor().getValue();
 669
 670       unsigned subminor = 0;
 671       if (tuple.getSubminor().hasValue())
 672         subminor = tuple.getSubminor().getValue();
 673
 674       Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
 675                           Twine(tuple.getMajor() * 10000 + minor * 100 +
 676                                 subminor));
 677     }
 678
 679     Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
 680     Builder.defineMacro("IBOutletCollection(ClassName)",
 681                         "__attribute__((iboutletcollection(ClassName)))");
 682     Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
 683     Builder.defineMacro("IBInspectable", "");
 684     Builder.defineMacro("IB_DESIGNABLE", "");
 685   }
 686
 687   // Define a macro that describes the Objective-C boolean type even for C
 688   // and C++ since BOOL can be used from non Objective-C code.
 689   Builder.defineMacro("__OBJC_BOOL_IS_BOOL",
 690                       Twine(TI.useSignedCharForObjCBool() ? "0" : "1"));
 691
 692   if (LangOpts.CPlusPlus)
 693     InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
 694
 695   // darwin_constant_cfstrings controls this. This is also dependent
 696   // on other things like the runtime I believe.  This is set even for C code.
 697   if (!LangOpts.NoConstantCFStrings)
 698       Builder.defineMacro("__CONSTANT_CFSTRINGS__");
 699
 700   if (LangOpts.ObjC)
 701     Builder.defineMacro("OBJC_NEW_PROPERTIES");
 702
 703   if (LangOpts.PascalStrings)
 704     Builder.defineMacro("__PASCAL_STRINGS__");
 705
 706   if (LangOpts.Blocks) {
 707     Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
 708     Builder.defineMacro("__BLOCKS__");
 709   }
 710
 711   if (!LangOpts.MSVCCompat && LangOpts.Exceptions)
 712     Builder.defineMacro("__EXCEPTIONS");
 713   if (LangOpts.GNUCVersion && LangOpts.RTTI)
 714     Builder.defineMacro("__GXX_RTTI");
 715
 716   if (LangOpts.SjLjExceptions)
 717     Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
 718   else if (LangOpts.SEHExceptions)
 719     Builder.defineMacro("__SEH__");
 720   else if (LangOpts.DWARFExceptions &&
 721           (TI.getTriple().isThumb() || TI.getTriple().isARM()))
 722     Builder.defineMacro("__ARM_DWARF_EH__");
 723
 724   if (LangOpts.Deprecated)
 725     Builder.defineMacro("__DEPRECATED");
 726
 727   if (!LangOpts.MSVCCompat && LangOpts.CPlusPlus)
 728     Builder.defineMacro("__private_extern__", "extern");
 729
 730   if (LangOpts.MicrosoftExt) {
 731     if (LangOpts.WChar) {
 732       // wchar_t supported as a keyword.
 733       Builder.defineMacro("_WCHAR_T_DEFINED");
 734       Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
 735     }
 736   }
 737
 738   if (LangOpts.Optimize)
 739     Builder.defineMacro("__OPTIMIZE__");
 740   if (LangOpts.OptimizeSize)
 741     Builder.defineMacro("__OPTIMIZE_SIZE__");
 742
 743   if (LangOpts.FastMath)
 744     Builder.defineMacro("__FAST_MATH__");
 745
 746   // Initialize target-specific preprocessor defines.
 747
 748   // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
 749   // to the macro __BYTE_ORDER (no trailing underscores)
 750   // from glibc's <endian.h> header.
 751   // We don't support the PDP-11 as a target, but include
 752   // the define so it can still be compared against.
 753   Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
 754   Builder.defineMacro("__ORDER_BIG_ENDIAN__",    "4321");
 755   Builder.defineMacro("__ORDER_PDP_ENDIAN__",    "3412");
 756   if (TI.isBigEndian()) {
 757     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
 758     Builder.defineMacro("__BIG_ENDIAN__");
 759   } else {
 760     Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
 761     Builder.defineMacro("__LITTLE_ENDIAN__");
 762   }
 763
 764   if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
 765       && TI.getIntWidth() == 32) {
 766     Builder.defineMacro("_LP64");
 767     Builder.defineMacro("__LP64__");
 768   }
 769
 770   if (TI.getPointerWidth(0) == 32 && TI.getLongWidth() == 32
 771       && TI.getIntWidth() == 32) {
 772     Builder.defineMacro("_ILP32");
 773     Builder.defineMacro("__ILP32__");
 774   }
 775
 776   // Define type sizing macros based on the target properties.
 777   assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
 778   Builder.defineMacro("__CHAR_BIT__", Twine(TI.getCharWidth()));
 779
 780   DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
 781   DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
 782   DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
 783   DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
 784   DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
 785   DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
 786   DefineTypeSize("__WINT_MAX__", TI.getWIntType(), TI, Builder);
 787   DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
 788   DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
 789
 790   DefineTypeSize("__UINTMAX_MAX__", TI.getUIntMaxType(), TI, Builder);
 791   DefineTypeSize("__PTRDIFF_MAX__", TI.getPtrDiffType(0), TI, Builder);
 792   DefineTypeSize("__INTPTR_MAX__", TI.getIntPtrType(), TI, Builder);
 793   DefineTypeSize("__UINTPTR_MAX__", TI.getUIntPtrType(), TI, Builder);
 794
 795   DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
 796   DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
 797   DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
 798   DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
 799   DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
 800   DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
 801   DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
 802   DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
 803   DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
 804                    TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
 805   DefineTypeSizeof("__SIZEOF_SIZE_T__",
 806                    TI.getTypeWidth(TI.getSizeType()), TI, Builder);
 807   DefineTypeSizeof("__SIZEOF_WCHAR_T__",
 808                    TI.getTypeWidth(TI.getWCharType()), TI, Builder);
 809   DefineTypeSizeof("__SIZEOF_WINT_T__",
 810                    TI.getTypeWidth(TI.getWIntType()), TI, Builder);
 811   if (TI.hasInt128Type())
 812     DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
 813
 814   DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
 815   DefineFmt("__INTMAX", TI.getIntMaxType(), TI, Builder);
 816   Builder.defineMacro("__INTMAX_C_SUFFIX__",
 817                       TI.getTypeConstantSuffix(TI.getIntMaxType()));
 818   DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
 819   DefineFmt("__UINTMAX", TI.getUIntMaxType(), TI, Builder);
 820   Builder.defineMacro("__UINTMAX_C_SUFFIX__",
 821                       TI.getTypeConstantSuffix(TI.getUIntMaxType()));
 822   DefineTypeWidth("__INTMAX_WIDTH__",  TI.getIntMaxType(), TI, Builder);
 823   DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
 824   DefineFmt("__PTRDIFF", TI.getPtrDiffType(0), TI, Builder);
 825   DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
 826   DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
 827   DefineFmt("__INTPTR", TI.getIntPtrType(), TI, Builder);
 828   DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
 829   DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
 830   DefineFmt("__SIZE", TI.getSizeType(), TI, Builder);
 831   DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
 832   DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
 833   DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
 834   DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
 835   DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
 836   DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
 837   DefineTypeSize("__SIG_ATOMIC_MAX__", TI.getSigAtomicType(), TI, Builder);
 838   DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
 839   DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
 840
 841   DefineTypeWidth("__UINTMAX_WIDTH__",  TI.getUIntMaxType(), TI, Builder);
 842   DefineType("__UINTPTR_TYPE__", TI.getUIntPtrType(), Builder);
 843   DefineFmt("__UINTPTR", TI.getUIntPtrType(), TI, Builder);
 844   DefineTypeWidth("__UINTPTR_WIDTH__", TI.getUIntPtrType(), TI, Builder);
 845
 846   if (TI.hasFloat16Type())
 847     DefineFloatMacros(Builder, "FLT16", &TI.getHalfFormat(), "F16");
 848   DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
 849   DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
 850   DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
 851
 852   // Define a __POINTER_WIDTH__ macro for stdint.h.
 853   Builder.defineMacro("__POINTER_WIDTH__",
 854                       Twine((int)TI.getPointerWidth(0)));
 855
 856   // Define __BIGGEST_ALIGNMENT__ to be compatible with gcc.
 857   Builder.defineMacro("__BIGGEST_ALIGNMENT__",
 858                       Twine(TI.getSuitableAlign() / TI.getCharWidth()) );
 859
 860   if (!LangOpts.CharIsSigned)
 861     Builder.defineMacro("__CHAR_UNSIGNED__");
 862
 863   if (!TargetInfo::isTypeSigned(TI.getWCharType()))
 864     Builder.defineMacro("__WCHAR_UNSIGNED__");
 865
 866   if (!TargetInfo::isTypeSigned(TI.getWIntType()))
 867     Builder.defineMacro("__WINT_UNSIGNED__");
 868
 869   // Define exact-width integer types for stdint.h
 870   DefineExactWidthIntType(TargetInfo::SignedChar, TI, Builder);
 871
 872   if (TI.getShortWidth() > TI.getCharWidth())
 873     DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
 874
 875   if (TI.getIntWidth() > TI.getShortWidth())
 876     DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
 877
 878   if (TI.getLongWidth() > TI.getIntWidth())
 879     DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
 880
 881   if (TI.getLongLongWidth() > TI.getLongWidth())
 882     DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
 883
 884   DefineExactWidthIntType(TargetInfo::UnsignedChar, TI, Builder);
 885   DefineExactWidthIntTypeSize(TargetInfo::UnsignedChar, TI, Builder);
 886   DefineExactWidthIntTypeSize(TargetInfo::SignedChar, TI, Builder);
 887
 888   if (TI.getShortWidth() > TI.getCharWidth()) {
 889     DefineExactWidthIntType(TargetInfo::UnsignedShort, TI, Builder);
 890     DefineExactWidthIntTypeSize(TargetInfo::UnsignedShort, TI, Builder);
 891     DefineExactWidthIntTypeSize(TargetInfo::SignedShort, TI, Builder);
 892   }
 893
 894   if (TI.getIntWidth() > TI.getShortWidth()) {
 895     DefineExactWidthIntType(TargetInfo::UnsignedInt, TI, Builder);
 896     DefineExactWidthIntTypeSize(TargetInfo::UnsignedInt, TI, Builder);
 897     DefineExactWidthIntTypeSize(TargetInfo::SignedInt, TI, Builder);
 898   }
 899
 900   if (TI.getLongWidth() > TI.getIntWidth()) {
 901     DefineExactWidthIntType(TargetInfo::UnsignedLong, TI, Builder);
 902     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLong, TI, Builder);
 903     DefineExactWidthIntTypeSize(TargetInfo::SignedLong, TI, Builder);
 904   }
 905
 906   if (TI.getLongLongWidth() > TI.getLongWidth()) {
 907     DefineExactWidthIntType(TargetInfo::UnsignedLongLong, TI, Builder);
 908     DefineExactWidthIntTypeSize(TargetInfo::UnsignedLongLong, TI, Builder);
 909     DefineExactWidthIntTypeSize(TargetInfo::SignedLongLong, TI, Builder);
 910   }
 911
 912   DefineLeastWidthIntType(8, true, TI, Builder);
 913   DefineLeastWidthIntType(8, false, TI, Builder);
 914   DefineLeastWidthIntType(16, true, TI, Builder);
 915   DefineLeastWidthIntType(16, false, TI, Builder);
 916   DefineLeastWidthIntType(32, true, TI, Builder);
 917   DefineLeastWidthIntType(32, false, TI, Builder);
 918   DefineLeastWidthIntType(64, true, TI, Builder);
 919   DefineLeastWidthIntType(64, false, TI, Builder);
 920
 921   DefineFastIntType(8, true, TI, Builder);
 922   DefineFastIntType(8, false, TI, Builder);
 923   DefineFastIntType(16, true, TI, Builder);
 924   DefineFastIntType(16, false, TI, Builder);
 925   DefineFastIntType(32, true, TI, Builder);
 926   DefineFastIntType(32, false, TI, Builder);
 927   DefineFastIntType(64, true, TI, Builder);
 928   DefineFastIntType(64, false, TI, Builder);
 929
 930   char UserLabelPrefix[2] = {TI.getDataLayout().getGlobalPrefix(), 0};
 931   Builder.defineMacro("__USER_LABEL_PREFIX__", UserLabelPrefix);
 932
 933   if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
 934     Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
 935   else
 936     Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
 937
 938   if (LangOpts.GNUCVersion) {
 939     if (LangOpts.GNUInline || LangOpts.CPlusPlus)
 940       Builder.defineMacro("__GNUC_GNU_INLINE__");
 941     else
 942       Builder.defineMacro("__GNUC_STDC_INLINE__");
 943
 944     // The value written by __atomic_test_and_set.
 945     // FIXME: This is target-dependent.
 946     Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
 947   }
 948
 949   auto addLockFreeMacros = [&](const llvm::Twine &Prefix) {
 950     // Used by libc++ and libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
 951     unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
 952 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type)                                     \
 953   Builder.defineMacro(Prefix + #TYPE "_LOCK_FREE",                             \
 954                       getLockFreeValue(TI.get##Type##Width(),                  \
 955                                        TI.get##Type##Align(),                  \
 956                                        InlineWidthBits));
 957     DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
 958     DEFINE_LOCK_FREE_MACRO(CHAR, Char);
 959     if (LangOpts.Char8)
 960       DEFINE_LOCK_FREE_MACRO(CHAR8_T, Char); // Treat char8_t like char.
 961     DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
 962     DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
 963     DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
 964     DEFINE_LOCK_FREE_MACRO(SHORT, Short);
 965     DEFINE_LOCK_FREE_MACRO(INT, Int);
 966     DEFINE_LOCK_FREE_MACRO(LONG, Long);
 967     DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
 968     Builder.defineMacro(Prefix + "POINTER_LOCK_FREE",
 969                         getLockFreeValue(TI.getPointerWidth(0),
 970                                          TI.getPointerAlign(0),
 971                                          InlineWidthBits));
 972 #undef DEFINE_LOCK_FREE_MACRO
 973   };
 974   addLockFreeMacros("__CLANG_ATOMIC_");
 975   if (LangOpts.GNUCVersion)
 976     addLockFreeMacros("__GCC_ATOMIC_");
 977
 978   if (LangOpts.NoInlineDefine)
 979     Builder.defineMacro("__NO_INLINE__");
 980
 981   if (unsigned PICLevel = LangOpts.PICLevel) {
 982     Builder.defineMacro("__PIC__", Twine(PICLevel));
 983     Builder.defineMacro("__pic__", Twine(PICLevel));
 984     if (LangOpts.PIE) {
 985       Builder.defineMacro("__PIE__", Twine(PICLevel));
 986       Builder.defineMacro("__pie__", Twine(PICLevel));
 987     }
 988   }
 989
 990   // Macros to control C99 numerics and <float.h>
 991   Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
 992   Builder.defineMacro("__FLT_RADIX__", "2");
 993   Builder.defineMacro("__DECIMAL_DIG__", "__LDBL_DECIMAL_DIG__");
 994
 995   if (LangOpts.getStackProtector() == LangOptions::SSPOn)
 996     Builder.defineMacro("__SSP__");
 997   else if (LangOpts.getStackProtector() == LangOptions::SSPStrong)
 998     Builder.defineMacro("__SSP_STRONG__", "2");
 999   else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
1000     Builder.defineMacro("__SSP_ALL__", "3");
1001
1002   if (PPOpts.SetUpStaticAnalyzer)
1003     Builder.defineMacro("__clang_analyzer__");
1004
1005   if (LangOpts.FastRelaxedMath)
1006     Builder.defineMacro("__FAST_RELAXED_MATH__");
1007
1008   if (FEOpts.ProgramAction == frontend::RewriteObjC ||
1009       LangOpts.getGC() != LangOptions::NonGC) {
1010     Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
1011     Builder.defineMacro("__strong", "__attribute__((objc_gc(strong)))");
1012     Builder.defineMacro("__autoreleasing", "");
1013     Builder.defineMacro("__unsafe_unretained", "");
1014   } else if (LangOpts.ObjC) {
1015     Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
1016     Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
1017     Builder.defineMacro("__autoreleasing",
1018                         "__attribute__((objc_ownership(autoreleasing)))");
1019     Builder.defineMacro("__unsafe_unretained",
1020                         "__attribute__((objc_ownership(none)))");
1021   }
1022
1023   // On Darwin, there are __double_underscored variants of the type
1024   // nullability qualifiers.
1025   if (TI.getTriple().isOSDarwin()) {
1026     Builder.defineMacro("__nonnull", "_Nonnull");
1027     Builder.defineMacro("__null_unspecified", "_Null_unspecified");
1028     Builder.defineMacro("__nullable", "_Nullable");
1029   }
1030
1031   // Add a macro to differentiate between regular iOS/tvOS/watchOS targets and
1032   // the corresponding simulator targets.
1033   if (TI.getTriple().isOSDarwin() && TI.getTriple().isSimulatorEnvironment())
1034     Builder.defineMacro("__APPLE_EMBEDDED_SIMULATOR__", "1");
1035
1036   // OpenMP definition
1037   // OpenMP 2.2:
1038   //   In implementations that support a preprocessor, the _OPENMP
1039   //   macro name is defined to have the decimal value yyyymm where
1040   //   yyyy and mm are the year and the month designations of the
1041   //   version of the OpenMP API that the implementation support.
1042   if (!LangOpts.OpenMPSimd) {
1043     switch (LangOpts.OpenMP) {
1044     case 0:
1045       break;
1046     case 31:
1047       Builder.defineMacro("_OPENMP", "201107");
1048       break;
1049     case 40:
1050       Builder.defineMacro("_OPENMP", "201307");
1051       break;
1052     case 50:
1053       Builder.defineMacro("_OPENMP", "201811");
1054       break;
1055     default:
1056       // Default version is OpenMP 4.5
1057       Builder.defineMacro("_OPENMP", "201511");
1058       break;
1059     }
1060   }
1061
1062   // CUDA device path compilaton
1063   if (LangOpts.CUDAIsDevice && !LangOpts.HIP) {
1064     // The CUDA_ARCH value is set for the GPU target specified in the NVPTX
1065     // backend's target defines.
1066     Builder.defineMacro("__CUDA_ARCH__");
1067   }
1068
1069   // We need to communicate this to our CUDA header wrapper, which in turn
1070   // informs the proper CUDA headers of this choice.
1071   if (LangOpts.CUDADeviceApproxTranscendentals || LangOpts.FastMath) {
1072     Builder.defineMacro("__CLANG_CUDA_APPROX_TRANSCENDENTALS__");
1073   }
1074
1075   // Define a macro indicating that the source file is being compiled with a
1076   // SYCL device compiler which doesn't produce host binary.
1077   if (LangOpts.SYCLIsDevice) {
1078     Builder.defineMacro("__SYCL_DEVICE_ONLY__", "1");
1079   }
1080
1081   // OpenCL definitions.
1082   if (LangOpts.OpenCL) {
1083 #define OPENCLEXT(Ext)                                                         \
1084   if (TI.getSupportedOpenCLOpts().isSupported(#Ext, LangOpts))                 \
1085     Builder.defineMacro(#Ext);
1086 #include "clang/Basic/OpenCLExtensions.def"
1087
1088     if (TI.getTriple().isSPIR())
1089       Builder.defineMacro("__IMAGE_SUPPORT__");
1090   }
1091
1092   if (TI.hasInt128Type() && LangOpts.CPlusPlus && LangOpts.GNUMode) {
1093     // For each extended integer type, g++ defines a macro mapping the
1094     // index of the type (0 in this case) in some list of extended types
1095     // to the type.
1096     Builder.defineMacro("__GLIBCXX_TYPE_INT_N_0", "__int128");
1097     Builder.defineMacro("__GLIBCXX_BITSIZE_INT_N_0", "128");
1098   }
1099
1100   // Get other target #defines.
1101   TI.getTargetDefines(LangOpts, Builder);
1102 }
1103
1104 /// InitializePreprocessor - Initialize the preprocessor getting it and the
1105 /// environment ready to process a single file. This returns true on error.
1106 ///
1107 void clang::InitializePreprocessor(
1108     Preprocessor &PP, const PreprocessorOptions &InitOpts,
1109     const PCHContainerReader &PCHContainerRdr,
1110     const FrontendOptions &FEOpts) {
1111   const LangOptions &LangOpts = PP.getLangOpts();
1112   std::string PredefineBuffer;
1113   PredefineBuffer.reserve(4080);
1114   llvm::raw_string_ostream Predefines(PredefineBuffer);
1115   MacroBuilder Builder(Predefines);
1116
1117   // Emit line markers for various builtin sections of the file.  We don't do
1118   // this in asm preprocessor mode, because "# 4" is not a line marker directive
1119   // in this mode.
1120   if (!PP.getLangOpts().AsmPreprocessor)
1121     Builder.append("# 1 \"<built-in>\" 3");
1122
1123   // Install things like __POWERPC__, __GNUC__, etc into the macro table.
1124   if (InitOpts.UsePredefines) {
1125     // FIXME: This will create multiple definitions for most of the predefined
1126     // macros. This is not the right way to handle this.
1127     if ((LangOpts.CUDA || LangOpts.OpenMPIsDevice) && PP.getAuxTargetInfo())
1128       InitializePredefinedMacros(*PP.getAuxTargetInfo(), LangOpts, FEOpts,
1129                                  PP.getPreprocessorOpts(), Builder);
1130
1131     InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts,
1132                                PP.getPreprocessorOpts(), Builder);
1133
1134     // Install definitions to make Objective-C++ ARC work well with various
1135     // C++ Standard Library implementations.
1136     if (LangOpts.ObjC && LangOpts.CPlusPlus &&
1137         (LangOpts.ObjCAutoRefCount || LangOpts.ObjCWeak)) {
1138       switch (InitOpts.ObjCXXARCStandardLibrary) {
1139       case ARCXX_nolib:
1140       case ARCXX_libcxx:
1141         break;
1142
1143       case ARCXX_libstdcxx:
1144         AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
1145         break;
1146       }
1147     }
1148   }
1149
1150   // Even with predefines off, some macros are still predefined.
1151   // These should all be defined in the preprocessor according to the
1152   // current language configuration.
1153   InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
1154                                      FEOpts, Builder);
1155
1156   // Add on the predefines from the driver.  Wrap in a #line directive to report
1157   // that they come from the command line.
1158   if (!PP.getLangOpts().AsmPreprocessor)
1159     Builder.append("# 1 \"<command line>\" 1");
1160
1161   // Process #define's and #undef's in the order they are given.
1162   for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
1163     if (InitOpts.Macros[i].second)  // isUndef
1164       Builder.undefineMacro(InitOpts.Macros[i].first);
1165     else
1166       DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
1167                          PP.getDiagnostics());
1168   }
1169
1170   // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
1171   if (!PP.getLangOpts().AsmPreprocessor)
1172     Builder.append("# 1 \"<built-in>\" 2");
1173
1174   // If -imacros are specified, include them now.  These are processed before
1175   // any -include directives.
1176   for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
1177     AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
1178
1179   // Process -include-pch/-include-pth directives.
1180   if (!InitOpts.ImplicitPCHInclude.empty())
1181     AddImplicitIncludePCH(Builder, PP, PCHContainerRdr,
1182                           InitOpts.ImplicitPCHInclude);
1183
1184   // Process -include directives.
1185   for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
1186     const std::string &Path = InitOpts.Includes[i];
1187     AddImplicitInclude(Builder, Path);
1188   }
1189
1190   // Instruct the preprocessor to skip the preamble.
1191   PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
1192                              InitOpts.PrecompiledPreambleBytes.second);
1193
1194   // Copy PredefinedBuffer into the Preprocessor.
1195   PP.setPredefines(Predefines.str());
1196 }