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