InitPreprocessor.cpp 49 KB

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