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