Clang Project

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