contrib/llvm/tools/clang/lib/Frontend/InitPreprocessor.cpp

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