CommonArgs.cpp 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351
  1. //===--- CommonArgs.cpp - Args handling for multiple toolchains -*- 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. #include "CommonArgs.h"
  9. #include "Arch/AArch64.h"
  10. #include "Arch/ARM.h"
  11. #include "Arch/CSKY.h"
  12. #include "Arch/LoongArch.h"
  13. #include "Arch/M68k.h"
  14. #include "Arch/Mips.h"
  15. #include "Arch/PPC.h"
  16. #include "Arch/RISCV.h"
  17. #include "Arch/Sparc.h"
  18. #include "Arch/SystemZ.h"
  19. #include "Arch/VE.h"
  20. #include "Arch/X86.h"
  21. #include "HIPAMD.h"
  22. #include "Hexagon.h"
  23. #include "MSP430.h"
  24. #include "clang/Basic/CharInfo.h"
  25. #include "clang/Basic/LangOptions.h"
  26. #include "clang/Basic/ObjCRuntime.h"
  27. #include "clang/Basic/Version.h"
  28. #include "clang/Config/config.h"
  29. #include "clang/Driver/Action.h"
  30. #include "clang/Driver/Compilation.h"
  31. #include "clang/Driver/Driver.h"
  32. #include "clang/Driver/DriverDiagnostic.h"
  33. #include "clang/Driver/InputInfo.h"
  34. #include "clang/Driver/Job.h"
  35. #include "clang/Driver/Options.h"
  36. #include "clang/Driver/SanitizerArgs.h"
  37. #include "clang/Driver/ToolChain.h"
  38. #include "clang/Driver/Util.h"
  39. #include "clang/Driver/XRayArgs.h"
  40. #include "llvm/ADT/STLExtras.h"
  41. #include "llvm/ADT/SmallSet.h"
  42. #include "llvm/ADT/SmallString.h"
  43. #include "llvm/ADT/StringExtras.h"
  44. #include "llvm/ADT/StringSwitch.h"
  45. #include "llvm/ADT/Twine.h"
  46. #include "llvm/BinaryFormat/Magic.h"
  47. #include "llvm/Config/llvm-config.h"
  48. #include "llvm/Option/Arg.h"
  49. #include "llvm/Option/ArgList.h"
  50. #include "llvm/Option/Option.h"
  51. #include "llvm/Support/CodeGen.h"
  52. #include "llvm/Support/Compression.h"
  53. #include "llvm/Support/Debug.h"
  54. #include "llvm/Support/ErrorHandling.h"
  55. #include "llvm/Support/FileSystem.h"
  56. #include "llvm/Support/Host.h"
  57. #include "llvm/Support/Path.h"
  58. #include "llvm/Support/Process.h"
  59. #include "llvm/Support/Program.h"
  60. #include "llvm/Support/ScopedPrinter.h"
  61. #include "llvm/Support/TargetParser.h"
  62. #include "llvm/Support/Threading.h"
  63. #include "llvm/Support/VirtualFileSystem.h"
  64. #include "llvm/Support/YAMLParser.h"
  65. #include <optional>
  66. using namespace clang::driver;
  67. using namespace clang::driver::tools;
  68. using namespace clang;
  69. using namespace llvm::opt;
  70. static void renderRpassOptions(const ArgList &Args, ArgStringList &CmdArgs,
  71. const StringRef PluginOptPrefix) {
  72. if (const Arg *A = Args.getLastArg(options::OPT_Rpass_EQ))
  73. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  74. "-pass-remarks=" + A->getValue()));
  75. if (const Arg *A = Args.getLastArg(options::OPT_Rpass_missed_EQ))
  76. CmdArgs.push_back(Args.MakeArgString(
  77. Twine(PluginOptPrefix) + "-pass-remarks-missed=" + A->getValue()));
  78. if (const Arg *A = Args.getLastArg(options::OPT_Rpass_analysis_EQ))
  79. CmdArgs.push_back(Args.MakeArgString(
  80. Twine(PluginOptPrefix) + "-pass-remarks-analysis=" + A->getValue()));
  81. }
  82. static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
  83. const llvm::Triple &Triple,
  84. const InputInfo &Input,
  85. const InputInfo &Output,
  86. const StringRef PluginOptPrefix) {
  87. StringRef Format = "yaml";
  88. if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
  89. Format = A->getValue();
  90. SmallString<128> F;
  91. const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
  92. if (A)
  93. F = A->getValue();
  94. else if (Output.isFilename())
  95. F = Output.getFilename();
  96. assert(!F.empty() && "Cannot determine remarks output name.");
  97. // Append "opt.ld.<format>" to the end of the file name.
  98. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  99. "opt-remarks-filename=" + F +
  100. ".opt.ld." + Format));
  101. if (const Arg *A =
  102. Args.getLastArg(options::OPT_foptimization_record_passes_EQ))
  103. CmdArgs.push_back(Args.MakeArgString(
  104. Twine(PluginOptPrefix) + "opt-remarks-passes=" + A->getValue()));
  105. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  106. "opt-remarks-format=" + Format.data()));
  107. }
  108. static void renderRemarksHotnessOptions(const ArgList &Args,
  109. ArgStringList &CmdArgs,
  110. const StringRef PluginOptPrefix) {
  111. if (Args.hasFlag(options::OPT_fdiagnostics_show_hotness,
  112. options::OPT_fno_diagnostics_show_hotness, false))
  113. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  114. "opt-remarks-with-hotness"));
  115. if (const Arg *A =
  116. Args.getLastArg(options::OPT_fdiagnostics_hotness_threshold_EQ))
  117. CmdArgs.push_back(
  118. Args.MakeArgString(Twine(PluginOptPrefix) +
  119. "opt-remarks-hotness-threshold=" + A->getValue()));
  120. }
  121. void tools::addPathIfExists(const Driver &D, const Twine &Path,
  122. ToolChain::path_list &Paths) {
  123. if (D.getVFS().exists(Path))
  124. Paths.push_back(Path.str());
  125. }
  126. void tools::handleTargetFeaturesGroup(const ArgList &Args,
  127. std::vector<StringRef> &Features,
  128. OptSpecifier Group) {
  129. for (const Arg *A : Args.filtered(Group)) {
  130. StringRef Name = A->getOption().getName();
  131. A->claim();
  132. // Skip over "-m".
  133. assert(Name.startswith("m") && "Invalid feature name.");
  134. Name = Name.substr(1);
  135. bool IsNegative = Name.startswith("no-");
  136. if (IsNegative)
  137. Name = Name.substr(3);
  138. Features.push_back(Args.MakeArgString((IsNegative ? "-" : "+") + Name));
  139. }
  140. }
  141. SmallVector<StringRef>
  142. tools::unifyTargetFeatures(ArrayRef<StringRef> Features) {
  143. // Only add a feature if it hasn't been seen before starting from the end.
  144. SmallVector<StringRef> UnifiedFeatures;
  145. llvm::DenseSet<StringRef> UsedFeatures;
  146. for (StringRef Feature : llvm::reverse(Features)) {
  147. if (UsedFeatures.insert(Feature.drop_front()).second)
  148. UnifiedFeatures.insert(UnifiedFeatures.begin(), Feature);
  149. }
  150. return UnifiedFeatures;
  151. }
  152. void tools::addDirectoryList(const ArgList &Args, ArgStringList &CmdArgs,
  153. const char *ArgName, const char *EnvVar) {
  154. const char *DirList = ::getenv(EnvVar);
  155. bool CombinedArg = false;
  156. if (!DirList)
  157. return; // Nothing to do.
  158. StringRef Name(ArgName);
  159. if (Name.equals("-I") || Name.equals("-L") || Name.empty())
  160. CombinedArg = true;
  161. StringRef Dirs(DirList);
  162. if (Dirs.empty()) // Empty string should not add '.'.
  163. return;
  164. StringRef::size_type Delim;
  165. while ((Delim = Dirs.find(llvm::sys::EnvPathSeparator)) != StringRef::npos) {
  166. if (Delim == 0) { // Leading colon.
  167. if (CombinedArg) {
  168. CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
  169. } else {
  170. CmdArgs.push_back(ArgName);
  171. CmdArgs.push_back(".");
  172. }
  173. } else {
  174. if (CombinedArg) {
  175. CmdArgs.push_back(
  176. Args.MakeArgString(std::string(ArgName) + Dirs.substr(0, Delim)));
  177. } else {
  178. CmdArgs.push_back(ArgName);
  179. CmdArgs.push_back(Args.MakeArgString(Dirs.substr(0, Delim)));
  180. }
  181. }
  182. Dirs = Dirs.substr(Delim + 1);
  183. }
  184. if (Dirs.empty()) { // Trailing colon.
  185. if (CombinedArg) {
  186. CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
  187. } else {
  188. CmdArgs.push_back(ArgName);
  189. CmdArgs.push_back(".");
  190. }
  191. } else { // Add the last path.
  192. if (CombinedArg) {
  193. CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + Dirs));
  194. } else {
  195. CmdArgs.push_back(ArgName);
  196. CmdArgs.push_back(Args.MakeArgString(Dirs));
  197. }
  198. }
  199. }
  200. void tools::AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
  201. const ArgList &Args, ArgStringList &CmdArgs,
  202. const JobAction &JA) {
  203. const Driver &D = TC.getDriver();
  204. // Add extra linker input arguments which are not treated as inputs
  205. // (constructed via -Xarch_).
  206. Args.AddAllArgValues(CmdArgs, options::OPT_Zlinker_input);
  207. // LIBRARY_PATH are included before user inputs and only supported on native
  208. // toolchains.
  209. if (!TC.isCrossCompiling())
  210. addDirectoryList(Args, CmdArgs, "-L", "LIBRARY_PATH");
  211. for (const auto &II : Inputs) {
  212. // If the current tool chain refers to an OpenMP offloading host, we
  213. // should ignore inputs that refer to OpenMP offloading devices -
  214. // they will be embedded according to a proper linker script.
  215. if (auto *IA = II.getAction())
  216. if ((JA.isHostOffloading(Action::OFK_OpenMP) &&
  217. IA->isDeviceOffloading(Action::OFK_OpenMP)))
  218. continue;
  219. if (!TC.HasNativeLLVMSupport() && types::isLLVMIR(II.getType()))
  220. // Don't try to pass LLVM inputs unless we have native support.
  221. D.Diag(diag::err_drv_no_linker_llvm_support) << TC.getTripleString();
  222. // Add filenames immediately.
  223. if (II.isFilename()) {
  224. CmdArgs.push_back(II.getFilename());
  225. continue;
  226. }
  227. // In some error cases, the input could be Nothing; skip those.
  228. if (II.isNothing())
  229. continue;
  230. // Otherwise, this is a linker input argument.
  231. const Arg &A = II.getInputArg();
  232. // Handle reserved library options.
  233. if (A.getOption().matches(options::OPT_Z_reserved_lib_stdcxx))
  234. TC.AddCXXStdlibLibArgs(Args, CmdArgs);
  235. else if (A.getOption().matches(options::OPT_Z_reserved_lib_cckext))
  236. TC.AddCCKextLibArgs(Args, CmdArgs);
  237. else if (A.getOption().matches(options::OPT_z)) {
  238. // Pass -z prefix for gcc linker compatibility.
  239. A.claim();
  240. A.render(Args, CmdArgs);
  241. } else if (A.getOption().matches(options::OPT_b)) {
  242. const llvm::Triple &T = TC.getTriple();
  243. if (!T.isOSAIX()) {
  244. TC.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
  245. << A.getSpelling() << T.str();
  246. }
  247. // Pass -b prefix for AIX linker.
  248. A.claim();
  249. A.render(Args, CmdArgs);
  250. } else {
  251. A.renderAsInput(Args, CmdArgs);
  252. }
  253. }
  254. }
  255. void tools::addLinkerCompressDebugSectionsOption(
  256. const ToolChain &TC, const llvm::opt::ArgList &Args,
  257. llvm::opt::ArgStringList &CmdArgs) {
  258. // GNU ld supports --compress-debug-sections=none|zlib|zlib-gnu|zlib-gabi
  259. // whereas zlib is an alias to zlib-gabi and zlib-gnu is obsoleted. Therefore
  260. // -gz=none|zlib are translated to --compress-debug-sections=none|zlib. -gz
  261. // is not translated since ld --compress-debug-sections option requires an
  262. // argument.
  263. if (const Arg *A = Args.getLastArg(options::OPT_gz_EQ)) {
  264. StringRef V = A->getValue();
  265. if (V == "none" || V == "zlib" || V == "zstd")
  266. CmdArgs.push_back(Args.MakeArgString("--compress-debug-sections=" + V));
  267. else
  268. TC.getDriver().Diag(diag::err_drv_unsupported_option_argument)
  269. << A->getSpelling() << V;
  270. }
  271. }
  272. void tools::AddTargetFeature(const ArgList &Args,
  273. std::vector<StringRef> &Features,
  274. OptSpecifier OnOpt, OptSpecifier OffOpt,
  275. StringRef FeatureName) {
  276. if (Arg *A = Args.getLastArg(OnOpt, OffOpt)) {
  277. if (A->getOption().matches(OnOpt))
  278. Features.push_back(Args.MakeArgString("+" + FeatureName));
  279. else
  280. Features.push_back(Args.MakeArgString("-" + FeatureName));
  281. }
  282. }
  283. /// Get the (LLVM) name of the AMDGPU gpu we are targeting.
  284. static std::string getAMDGPUTargetGPU(const llvm::Triple &T,
  285. const ArgList &Args) {
  286. if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
  287. auto GPUName = getProcessorFromTargetID(T, A->getValue());
  288. return llvm::StringSwitch<std::string>(GPUName)
  289. .Cases("rv630", "rv635", "r600")
  290. .Cases("rv610", "rv620", "rs780", "rs880")
  291. .Case("rv740", "rv770")
  292. .Case("palm", "cedar")
  293. .Cases("sumo", "sumo2", "sumo")
  294. .Case("hemlock", "cypress")
  295. .Case("aruba", "cayman")
  296. .Default(GPUName.str());
  297. }
  298. return "";
  299. }
  300. static std::string getLanaiTargetCPU(const ArgList &Args) {
  301. if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
  302. return A->getValue();
  303. }
  304. return "";
  305. }
  306. /// Get the (LLVM) name of the WebAssembly cpu we are targeting.
  307. static StringRef getWebAssemblyTargetCPU(const ArgList &Args) {
  308. // If we have -mcpu=, use that.
  309. if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
  310. StringRef CPU = A->getValue();
  311. #ifdef __wasm__
  312. // Handle "native" by examining the host. "native" isn't meaningful when
  313. // cross compiling, so only support this when the host is also WebAssembly.
  314. if (CPU == "native")
  315. return llvm::sys::getHostCPUName();
  316. #endif
  317. return CPU;
  318. }
  319. return "generic";
  320. }
  321. std::string tools::getCPUName(const Driver &D, const ArgList &Args,
  322. const llvm::Triple &T, bool FromAs) {
  323. Arg *A;
  324. switch (T.getArch()) {
  325. default:
  326. return "";
  327. case llvm::Triple::aarch64:
  328. case llvm::Triple::aarch64_32:
  329. case llvm::Triple::aarch64_be:
  330. return aarch64::getAArch64TargetCPU(Args, T, A);
  331. case llvm::Triple::arm:
  332. case llvm::Triple::armeb:
  333. case llvm::Triple::thumb:
  334. case llvm::Triple::thumbeb: {
  335. StringRef MArch, MCPU;
  336. arm::getARMArchCPUFromArgs(Args, MArch, MCPU, FromAs);
  337. return arm::getARMTargetCPU(MCPU, MArch, T);
  338. }
  339. case llvm::Triple::avr:
  340. if (const Arg *A = Args.getLastArg(options::OPT_mmcu_EQ))
  341. return A->getValue();
  342. return "";
  343. case llvm::Triple::m68k:
  344. return m68k::getM68kTargetCPU(Args);
  345. case llvm::Triple::mips:
  346. case llvm::Triple::mipsel:
  347. case llvm::Triple::mips64:
  348. case llvm::Triple::mips64el: {
  349. StringRef CPUName;
  350. StringRef ABIName;
  351. mips::getMipsCPUAndABI(Args, T, CPUName, ABIName);
  352. return std::string(CPUName);
  353. }
  354. case llvm::Triple::nvptx:
  355. case llvm::Triple::nvptx64:
  356. if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
  357. return A->getValue();
  358. return "";
  359. case llvm::Triple::ppc:
  360. case llvm::Triple::ppcle:
  361. case llvm::Triple::ppc64:
  362. case llvm::Triple::ppc64le:
  363. return ppc::getPPCTargetCPU(Args, T);
  364. case llvm::Triple::csky:
  365. if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
  366. return A->getValue();
  367. else if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
  368. return A->getValue();
  369. else
  370. return "ck810";
  371. case llvm::Triple::riscv32:
  372. case llvm::Triple::riscv64:
  373. return riscv::getRISCVTargetCPU(Args, T);
  374. case llvm::Triple::bpfel:
  375. case llvm::Triple::bpfeb:
  376. if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
  377. return A->getValue();
  378. return "";
  379. case llvm::Triple::sparc:
  380. case llvm::Triple::sparcel:
  381. case llvm::Triple::sparcv9:
  382. return sparc::getSparcTargetCPU(D, Args, T);
  383. case llvm::Triple::x86:
  384. case llvm::Triple::x86_64:
  385. return x86::getX86TargetCPU(D, Args, T);
  386. case llvm::Triple::hexagon:
  387. return "hexagon" +
  388. toolchains::HexagonToolChain::GetTargetCPUVersion(Args).str();
  389. case llvm::Triple::lanai:
  390. return getLanaiTargetCPU(Args);
  391. case llvm::Triple::systemz:
  392. return systemz::getSystemZTargetCPU(Args);
  393. case llvm::Triple::r600:
  394. case llvm::Triple::amdgcn:
  395. return getAMDGPUTargetGPU(T, Args);
  396. case llvm::Triple::wasm32:
  397. case llvm::Triple::wasm64:
  398. return std::string(getWebAssemblyTargetCPU(Args));
  399. }
  400. }
  401. static void getWebAssemblyTargetFeatures(const ArgList &Args,
  402. std::vector<StringRef> &Features) {
  403. handleTargetFeaturesGroup(Args, Features, options::OPT_m_wasm_Features_Group);
  404. }
  405. void tools::getTargetFeatures(const Driver &D, const llvm::Triple &Triple,
  406. const ArgList &Args, ArgStringList &CmdArgs,
  407. bool ForAS, bool IsAux) {
  408. std::vector<StringRef> Features;
  409. switch (Triple.getArch()) {
  410. default:
  411. break;
  412. case llvm::Triple::mips:
  413. case llvm::Triple::mipsel:
  414. case llvm::Triple::mips64:
  415. case llvm::Triple::mips64el:
  416. mips::getMIPSTargetFeatures(D, Triple, Args, Features);
  417. break;
  418. case llvm::Triple::arm:
  419. case llvm::Triple::armeb:
  420. case llvm::Triple::thumb:
  421. case llvm::Triple::thumbeb:
  422. arm::getARMTargetFeatures(D, Triple, Args, Features, ForAS);
  423. break;
  424. case llvm::Triple::ppc:
  425. case llvm::Triple::ppcle:
  426. case llvm::Triple::ppc64:
  427. case llvm::Triple::ppc64le:
  428. ppc::getPPCTargetFeatures(D, Triple, Args, Features);
  429. break;
  430. case llvm::Triple::riscv32:
  431. case llvm::Triple::riscv64:
  432. riscv::getRISCVTargetFeatures(D, Triple, Args, Features);
  433. break;
  434. case llvm::Triple::systemz:
  435. systemz::getSystemZTargetFeatures(D, Args, Features);
  436. break;
  437. case llvm::Triple::aarch64:
  438. case llvm::Triple::aarch64_32:
  439. case llvm::Triple::aarch64_be:
  440. aarch64::getAArch64TargetFeatures(D, Triple, Args, Features, ForAS);
  441. break;
  442. case llvm::Triple::x86:
  443. case llvm::Triple::x86_64:
  444. x86::getX86TargetFeatures(D, Triple, Args, Features);
  445. break;
  446. case llvm::Triple::hexagon:
  447. hexagon::getHexagonTargetFeatures(D, Args, Features);
  448. break;
  449. case llvm::Triple::wasm32:
  450. case llvm::Triple::wasm64:
  451. getWebAssemblyTargetFeatures(Args, Features);
  452. break;
  453. case llvm::Triple::sparc:
  454. case llvm::Triple::sparcel:
  455. case llvm::Triple::sparcv9:
  456. sparc::getSparcTargetFeatures(D, Args, Features);
  457. break;
  458. case llvm::Triple::r600:
  459. case llvm::Triple::amdgcn:
  460. amdgpu::getAMDGPUTargetFeatures(D, Triple, Args, Features);
  461. break;
  462. case llvm::Triple::nvptx:
  463. case llvm::Triple::nvptx64:
  464. NVPTX::getNVPTXTargetFeatures(D, Triple, Args, Features);
  465. break;
  466. case llvm::Triple::m68k:
  467. m68k::getM68kTargetFeatures(D, Triple, Args, Features);
  468. break;
  469. case llvm::Triple::msp430:
  470. msp430::getMSP430TargetFeatures(D, Args, Features);
  471. break;
  472. case llvm::Triple::ve:
  473. ve::getVETargetFeatures(D, Args, Features);
  474. break;
  475. case llvm::Triple::csky:
  476. csky::getCSKYTargetFeatures(D, Triple, Args, CmdArgs, Features);
  477. break;
  478. case llvm::Triple::loongarch32:
  479. case llvm::Triple::loongarch64:
  480. loongarch::getLoongArchTargetFeatures(D, Triple, Args, Features);
  481. break;
  482. }
  483. for (auto Feature : unifyTargetFeatures(Features)) {
  484. CmdArgs.push_back(IsAux ? "-aux-target-feature" : "-target-feature");
  485. CmdArgs.push_back(Feature.data());
  486. }
  487. }
  488. llvm::StringRef tools::getLTOParallelism(const ArgList &Args, const Driver &D) {
  489. Arg *LtoJobsArg = Args.getLastArg(options::OPT_flto_jobs_EQ);
  490. if (!LtoJobsArg)
  491. return {};
  492. if (!llvm::get_threadpool_strategy(LtoJobsArg->getValue()))
  493. D.Diag(diag::err_drv_invalid_int_value)
  494. << LtoJobsArg->getAsString(Args) << LtoJobsArg->getValue();
  495. return LtoJobsArg->getValue();
  496. }
  497. // CloudABI and PS4/PS5 use -ffunction-sections and -fdata-sections by default.
  498. bool tools::isUseSeparateSections(const llvm::Triple &Triple) {
  499. return Triple.getOS() == llvm::Triple::CloudABI || Triple.isPS();
  500. }
  501. void tools::addLTOOptions(const ToolChain &ToolChain, const ArgList &Args,
  502. ArgStringList &CmdArgs, const InputInfo &Output,
  503. const InputInfo &Input, bool IsThinLTO) {
  504. const bool IsOSAIX = ToolChain.getTriple().isOSAIX();
  505. const char *Linker = Args.MakeArgString(ToolChain.GetLinkerPath());
  506. const Driver &D = ToolChain.getDriver();
  507. if (llvm::sys::path::filename(Linker) != "ld.lld" &&
  508. llvm::sys::path::stem(Linker) != "ld.lld") {
  509. // Tell the linker to load the plugin. This has to come before
  510. // AddLinkerInputs as gold requires -plugin and AIX ld requires -bplugin to
  511. // come before any -plugin-opt/-bplugin_opt that -Wl might forward.
  512. const char *PluginPrefix = IsOSAIX ? "-bplugin:" : "";
  513. const char *PluginName = IsOSAIX ? "/libLTO" : "/LLVMgold";
  514. if (!IsOSAIX)
  515. CmdArgs.push_back("-plugin");
  516. #if defined(_WIN32)
  517. const char *Suffix = ".dll";
  518. #elif defined(__APPLE__)
  519. const char *Suffix = ".dylib";
  520. #else
  521. const char *Suffix = ".so";
  522. #endif
  523. SmallString<1024> Plugin;
  524. llvm::sys::path::native(Twine(D.Dir) +
  525. "/../" CLANG_INSTALL_LIBDIR_BASENAME +
  526. PluginName + Suffix,
  527. Plugin);
  528. CmdArgs.push_back(Args.MakeArgString(Twine(PluginPrefix) + Plugin));
  529. }
  530. const char *PluginOptPrefix = IsOSAIX ? "-bplugin_opt:" : "-plugin-opt=";
  531. const char *ExtraDash = IsOSAIX ? "-" : "";
  532. // Note, this solution is far from perfect, better to encode it into IR
  533. // metadata, but this may not be worth it, since it looks like aranges is on
  534. // the way out.
  535. if (Args.hasArg(options::OPT_gdwarf_aranges)) {
  536. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  537. "-generate-arange-section"));
  538. }
  539. // Try to pass driver level flags relevant to LTO code generation down to
  540. // the plugin.
  541. // Handle flags for selecting CPU variants.
  542. std::string CPU = getCPUName(D, Args, ToolChain.getTriple());
  543. if (!CPU.empty())
  544. CmdArgs.push_back(
  545. Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash + "mcpu=" + CPU));
  546. if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
  547. // The optimization level matches
  548. // CompilerInvocation.cpp:getOptimizationLevel().
  549. StringRef OOpt;
  550. if (A->getOption().matches(options::OPT_O4) ||
  551. A->getOption().matches(options::OPT_Ofast))
  552. OOpt = "3";
  553. else if (A->getOption().matches(options::OPT_O)) {
  554. OOpt = A->getValue();
  555. if (OOpt == "g")
  556. OOpt = "1";
  557. else if (OOpt == "s" || OOpt == "z")
  558. OOpt = "2";
  559. } else if (A->getOption().matches(options::OPT_O0))
  560. OOpt = "0";
  561. if (!OOpt.empty())
  562. CmdArgs.push_back(
  563. Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash + "O" + OOpt));
  564. }
  565. if (Args.hasArg(options::OPT_gsplit_dwarf))
  566. CmdArgs.push_back(Args.MakeArgString(
  567. Twine(PluginOptPrefix) + "dwo_dir=" + Output.getFilename() + "_dwo"));
  568. if (IsThinLTO)
  569. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + "thinlto"));
  570. StringRef Parallelism = getLTOParallelism(Args, D);
  571. if (!Parallelism.empty())
  572. CmdArgs.push_back(
  573. Args.MakeArgString(Twine(PluginOptPrefix) + "jobs=" + Parallelism));
  574. // If an explicit debugger tuning argument appeared, pass it along.
  575. if (Arg *A =
  576. Args.getLastArg(options::OPT_gTune_Group, options::OPT_ggdbN_Group)) {
  577. if (A->getOption().matches(options::OPT_glldb))
  578. CmdArgs.push_back(
  579. Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=lldb"));
  580. else if (A->getOption().matches(options::OPT_gsce))
  581. CmdArgs.push_back(
  582. Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=sce"));
  583. else if (A->getOption().matches(options::OPT_gdbx))
  584. CmdArgs.push_back(
  585. Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=dbx"));
  586. else
  587. CmdArgs.push_back(
  588. Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=gdb"));
  589. }
  590. if (IsOSAIX) {
  591. // On AIX, clang assumes strict-dwarf is true if any debug option is
  592. // specified, unless it is told explicitly not to assume so.
  593. Arg *A = Args.getLastArg(options::OPT_g_Group);
  594. bool EnableDebugInfo = A && !A->getOption().matches(options::OPT_g0) &&
  595. !A->getOption().matches(options::OPT_ggdb0);
  596. if (EnableDebugInfo && Args.hasFlag(options::OPT_gstrict_dwarf,
  597. options::OPT_gno_strict_dwarf, true))
  598. CmdArgs.push_back(
  599. Args.MakeArgString(Twine(PluginOptPrefix) + "-strict-dwarf=true"));
  600. if (Args.getLastArg(options::OPT_mabi_EQ_vec_extabi))
  601. CmdArgs.push_back(
  602. Args.MakeArgString(Twine(PluginOptPrefix) + "-vec-extabi"));
  603. }
  604. bool UseSeparateSections =
  605. isUseSeparateSections(ToolChain.getEffectiveTriple());
  606. if (Args.hasFlag(options::OPT_ffunction_sections,
  607. options::OPT_fno_function_sections, UseSeparateSections))
  608. CmdArgs.push_back(
  609. Args.MakeArgString(Twine(PluginOptPrefix) + "-function-sections=1"));
  610. else if (Args.hasArg(options::OPT_fno_function_sections))
  611. CmdArgs.push_back(
  612. Args.MakeArgString(Twine(PluginOptPrefix) + "-function-sections=0"));
  613. if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
  614. UseSeparateSections))
  615. CmdArgs.push_back(
  616. Args.MakeArgString(Twine(PluginOptPrefix) + "-data-sections=1"));
  617. else if (Args.hasArg(options::OPT_fno_data_sections))
  618. CmdArgs.push_back(
  619. Args.MakeArgString(Twine(PluginOptPrefix) + "-data-sections=0"));
  620. // Pass an option to enable split machine functions.
  621. if (auto *A = Args.getLastArg(options::OPT_fsplit_machine_functions,
  622. options::OPT_fno_split_machine_functions)) {
  623. if (A->getOption().matches(options::OPT_fsplit_machine_functions))
  624. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  625. "-split-machine-functions"));
  626. }
  627. if (Arg *A = getLastProfileSampleUseArg(Args)) {
  628. StringRef FName = A->getValue();
  629. if (!llvm::sys::fs::exists(FName))
  630. D.Diag(diag::err_drv_no_such_file) << FName;
  631. else
  632. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  633. "sample-profile=" + FName));
  634. }
  635. auto *CSPGOGenerateArg = Args.getLastArg(options::OPT_fcs_profile_generate,
  636. options::OPT_fcs_profile_generate_EQ,
  637. options::OPT_fno_profile_generate);
  638. if (CSPGOGenerateArg &&
  639. CSPGOGenerateArg->getOption().matches(options::OPT_fno_profile_generate))
  640. CSPGOGenerateArg = nullptr;
  641. auto *ProfileUseArg = getLastProfileUseArg(Args);
  642. if (CSPGOGenerateArg) {
  643. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
  644. "cs-profile-generate"));
  645. if (CSPGOGenerateArg->getOption().matches(
  646. options::OPT_fcs_profile_generate_EQ)) {
  647. SmallString<128> Path(CSPGOGenerateArg->getValue());
  648. llvm::sys::path::append(Path, "default_%m.profraw");
  649. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
  650. "cs-profile-path=" + Path));
  651. } else
  652. CmdArgs.push_back(
  653. Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
  654. "cs-profile-path=default_%m.profraw"));
  655. } else if (ProfileUseArg) {
  656. SmallString<128> Path(
  657. ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
  658. if (Path.empty() || llvm::sys::fs::is_directory(Path))
  659. llvm::sys::path::append(Path, "default.profdata");
  660. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
  661. "cs-profile-path=" + Path));
  662. }
  663. // This controls whether or not we perform JustMyCode instrumentation.
  664. if (Args.hasFlag(options::OPT_fjmc, options::OPT_fno_jmc, false)) {
  665. if (ToolChain.getEffectiveTriple().isOSBinFormatELF())
  666. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
  667. "-enable-jmc-instrument"));
  668. else
  669. D.Diag(clang::diag::warn_drv_fjmc_for_elf_only);
  670. }
  671. if (Args.hasFlag(options::OPT_fstack_size_section,
  672. options::OPT_fno_stack_size_section, false))
  673. CmdArgs.push_back(
  674. Args.MakeArgString(Twine(PluginOptPrefix) + "-stack-size-section"));
  675. // Setup statistics file output.
  676. SmallString<128> StatsFile = getStatsFileName(Args, Output, Input, D);
  677. if (!StatsFile.empty())
  678. CmdArgs.push_back(
  679. Args.MakeArgString(Twine(PluginOptPrefix) + "stats-file=" + StatsFile));
  680. // Setup crash diagnostics dir.
  681. if (Arg *A = Args.getLastArg(options::OPT_fcrash_diagnostics_dir))
  682. CmdArgs.push_back(Args.MakeArgString(
  683. Twine(PluginOptPrefix) + "-crash-diagnostics-dir=" + A->getValue()));
  684. addX86AlignBranchArgs(D, Args, CmdArgs, /*IsLTO=*/true, PluginOptPrefix);
  685. // Handle remark diagnostics on screen options: '-Rpass-*'.
  686. renderRpassOptions(Args, CmdArgs, PluginOptPrefix);
  687. // Handle serialized remarks options: '-fsave-optimization-record'
  688. // and '-foptimization-record-*'.
  689. if (willEmitRemarks(Args))
  690. renderRemarksOptions(Args, CmdArgs, ToolChain.getEffectiveTriple(), Input,
  691. Output, PluginOptPrefix);
  692. // Handle remarks hotness/threshold related options.
  693. renderRemarksHotnessOptions(Args, CmdArgs, PluginOptPrefix);
  694. addMachineOutlinerArgs(D, Args, CmdArgs, ToolChain.getEffectiveTriple(),
  695. /*IsLTO=*/true, PluginOptPrefix);
  696. }
  697. void tools::addOpenMPRuntimeSpecificRPath(const ToolChain &TC,
  698. const ArgList &Args,
  699. ArgStringList &CmdArgs) {
  700. if (Args.hasFlag(options::OPT_fopenmp_implicit_rpath,
  701. options::OPT_fno_openmp_implicit_rpath, true)) {
  702. // Default to clang lib / lib64 folder, i.e. the same location as device
  703. // runtime
  704. SmallString<256> DefaultLibPath =
  705. llvm::sys::path::parent_path(TC.getDriver().Dir);
  706. llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
  707. CmdArgs.push_back("-rpath");
  708. CmdArgs.push_back(Args.MakeArgString(DefaultLibPath));
  709. }
  710. }
  711. void tools::addOpenMPRuntimeLibraryPath(const ToolChain &TC,
  712. const ArgList &Args,
  713. ArgStringList &CmdArgs) {
  714. // Default to clang lib / lib64 folder, i.e. the same location as device
  715. // runtime.
  716. SmallString<256> DefaultLibPath =
  717. llvm::sys::path::parent_path(TC.getDriver().Dir);
  718. llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
  719. CmdArgs.push_back(Args.MakeArgString("-L" + DefaultLibPath));
  720. }
  721. void tools::addArchSpecificRPath(const ToolChain &TC, const ArgList &Args,
  722. ArgStringList &CmdArgs) {
  723. // Enable -frtlib-add-rpath by default for the case of VE.
  724. const bool IsVE = TC.getTriple().isVE();
  725. bool DefaultValue = IsVE;
  726. if (!Args.hasFlag(options::OPT_frtlib_add_rpath,
  727. options::OPT_fno_rtlib_add_rpath, DefaultValue))
  728. return;
  729. std::string CandidateRPath = TC.getArchSpecificLibPath();
  730. if (TC.getVFS().exists(CandidateRPath)) {
  731. CmdArgs.push_back("-rpath");
  732. CmdArgs.push_back(Args.MakeArgString(CandidateRPath));
  733. }
  734. }
  735. bool tools::addOpenMPRuntime(ArgStringList &CmdArgs, const ToolChain &TC,
  736. const ArgList &Args, bool ForceStaticHostRuntime,
  737. bool IsOffloadingHost, bool GompNeedsRT) {
  738. if (!Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
  739. options::OPT_fno_openmp, false))
  740. return false;
  741. Driver::OpenMPRuntimeKind RTKind = TC.getDriver().getOpenMPRuntime(Args);
  742. if (RTKind == Driver::OMPRT_Unknown)
  743. // Already diagnosed.
  744. return false;
  745. if (ForceStaticHostRuntime)
  746. CmdArgs.push_back("-Bstatic");
  747. switch (RTKind) {
  748. case Driver::OMPRT_OMP:
  749. CmdArgs.push_back("-lomp");
  750. break;
  751. case Driver::OMPRT_GOMP:
  752. CmdArgs.push_back("-lgomp");
  753. break;
  754. case Driver::OMPRT_IOMP5:
  755. CmdArgs.push_back("-liomp5");
  756. break;
  757. case Driver::OMPRT_Unknown:
  758. break;
  759. }
  760. if (ForceStaticHostRuntime)
  761. CmdArgs.push_back("-Bdynamic");
  762. if (RTKind == Driver::OMPRT_GOMP && GompNeedsRT)
  763. CmdArgs.push_back("-lrt");
  764. if (IsOffloadingHost)
  765. CmdArgs.push_back("-lomptarget");
  766. if (IsOffloadingHost && !Args.hasArg(options::OPT_nogpulib))
  767. CmdArgs.push_back("-lomptarget.devicertl");
  768. addArchSpecificRPath(TC, Args, CmdArgs);
  769. if (RTKind == Driver::OMPRT_OMP)
  770. addOpenMPRuntimeSpecificRPath(TC, Args, CmdArgs);
  771. addOpenMPRuntimeLibraryPath(TC, Args, CmdArgs);
  772. return true;
  773. }
  774. void tools::addFortranRuntimeLibs(const ToolChain &TC,
  775. llvm::opt::ArgStringList &CmdArgs) {
  776. if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
  777. CmdArgs.push_back("Fortran_main.lib");
  778. CmdArgs.push_back("FortranRuntime.lib");
  779. CmdArgs.push_back("FortranDecimal.lib");
  780. } else {
  781. CmdArgs.push_back("-lFortran_main");
  782. CmdArgs.push_back("-lFortranRuntime");
  783. CmdArgs.push_back("-lFortranDecimal");
  784. }
  785. }
  786. void tools::addFortranRuntimeLibraryPath(const ToolChain &TC,
  787. const llvm::opt::ArgList &Args,
  788. ArgStringList &CmdArgs) {
  789. // NOTE: Generating executables by Flang is considered an "experimental"
  790. // feature and hence this is guarded with a command line option.
  791. // TODO: Make this work unconditionally once Flang is mature enough.
  792. if (!Args.hasArg(options::OPT_flang_experimental_exec))
  793. return;
  794. // Default to the <driver-path>/../lib directory. This works fine on the
  795. // platforms that we have tested so far. We will probably have to re-fine
  796. // this in the future. In particular, on some platforms, we may need to use
  797. // lib64 instead of lib.
  798. SmallString<256> DefaultLibPath =
  799. llvm::sys::path::parent_path(TC.getDriver().Dir);
  800. llvm::sys::path::append(DefaultLibPath, "lib");
  801. if (TC.getTriple().isKnownWindowsMSVCEnvironment())
  802. CmdArgs.push_back(Args.MakeArgString("-libpath:" + DefaultLibPath));
  803. else
  804. CmdArgs.push_back(Args.MakeArgString("-L" + DefaultLibPath));
  805. }
  806. static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args,
  807. ArgStringList &CmdArgs, StringRef Sanitizer,
  808. bool IsShared, bool IsWhole) {
  809. // Wrap any static runtimes that must be forced into executable in
  810. // whole-archive.
  811. if (IsWhole) CmdArgs.push_back("--whole-archive");
  812. CmdArgs.push_back(TC.getCompilerRTArgString(
  813. Args, Sanitizer, IsShared ? ToolChain::FT_Shared : ToolChain::FT_Static));
  814. if (IsWhole) CmdArgs.push_back("--no-whole-archive");
  815. if (IsShared) {
  816. addArchSpecificRPath(TC, Args, CmdArgs);
  817. }
  818. }
  819. // Tries to use a file with the list of dynamic symbols that need to be exported
  820. // from the runtime library. Returns true if the file was found.
  821. static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args,
  822. ArgStringList &CmdArgs,
  823. StringRef Sanitizer) {
  824. // Solaris ld defaults to --export-dynamic behaviour but doesn't support
  825. // the option, so don't try to pass it.
  826. if (TC.getTriple().getOS() == llvm::Triple::Solaris)
  827. return true;
  828. SmallString<128> SanRT(TC.getCompilerRT(Args, Sanitizer));
  829. if (llvm::sys::fs::exists(SanRT + ".syms")) {
  830. CmdArgs.push_back(Args.MakeArgString("--dynamic-list=" + SanRT + ".syms"));
  831. return true;
  832. }
  833. return false;
  834. }
  835. const char *tools::getAsNeededOption(const ToolChain &TC, bool as_needed) {
  836. assert(!TC.getTriple().isOSAIX() &&
  837. "AIX linker does not support any form of --as-needed option yet.");
  838. // While the Solaris 11.2 ld added --as-needed/--no-as-needed as aliases
  839. // for the native forms -z ignore/-z record, they are missing in Illumos,
  840. // so always use the native form.
  841. if (TC.getTriple().isOSSolaris())
  842. return as_needed ? "-zignore" : "-zrecord";
  843. else
  844. return as_needed ? "--as-needed" : "--no-as-needed";
  845. }
  846. void tools::linkSanitizerRuntimeDeps(const ToolChain &TC,
  847. ArgStringList &CmdArgs) {
  848. // Force linking against the system libraries sanitizers depends on
  849. // (see PR15823 why this is necessary).
  850. CmdArgs.push_back(getAsNeededOption(TC, false));
  851. // There's no libpthread or librt on RTEMS & Android.
  852. if (TC.getTriple().getOS() != llvm::Triple::RTEMS &&
  853. !TC.getTriple().isAndroid()) {
  854. CmdArgs.push_back("-lpthread");
  855. if (!TC.getTriple().isOSOpenBSD())
  856. CmdArgs.push_back("-lrt");
  857. }
  858. CmdArgs.push_back("-lm");
  859. // There's no libdl on all OSes.
  860. if (!TC.getTriple().isOSFreeBSD() && !TC.getTriple().isOSNetBSD() &&
  861. !TC.getTriple().isOSOpenBSD() &&
  862. TC.getTriple().getOS() != llvm::Triple::RTEMS)
  863. CmdArgs.push_back("-ldl");
  864. // Required for backtrace on some OSes
  865. if (TC.getTriple().isOSFreeBSD() ||
  866. TC.getTriple().isOSNetBSD() ||
  867. TC.getTriple().isOSOpenBSD())
  868. CmdArgs.push_back("-lexecinfo");
  869. // There is no libresolv on Android, FreeBSD, OpenBSD, etc. On musl
  870. // libresolv.a, even if exists, is an empty archive to satisfy POSIX -lresolv
  871. // requirement.
  872. if (TC.getTriple().isOSLinux() && !TC.getTriple().isAndroid() &&
  873. !TC.getTriple().isMusl())
  874. CmdArgs.push_back("-lresolv");
  875. }
  876. static void
  877. collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
  878. SmallVectorImpl<StringRef> &SharedRuntimes,
  879. SmallVectorImpl<StringRef> &StaticRuntimes,
  880. SmallVectorImpl<StringRef> &NonWholeStaticRuntimes,
  881. SmallVectorImpl<StringRef> &HelperStaticRuntimes,
  882. SmallVectorImpl<StringRef> &RequiredSymbols) {
  883. const SanitizerArgs &SanArgs = TC.getSanitizerArgs(Args);
  884. // Collect shared runtimes.
  885. if (SanArgs.needsSharedRt()) {
  886. if (SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
  887. SharedRuntimes.push_back("asan");
  888. if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
  889. HelperStaticRuntimes.push_back("asan-preinit");
  890. }
  891. if (SanArgs.needsMemProfRt() && SanArgs.linkRuntimes()) {
  892. SharedRuntimes.push_back("memprof");
  893. if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
  894. HelperStaticRuntimes.push_back("memprof-preinit");
  895. }
  896. if (SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
  897. if (SanArgs.requiresMinimalRuntime())
  898. SharedRuntimes.push_back("ubsan_minimal");
  899. else
  900. SharedRuntimes.push_back("ubsan_standalone");
  901. }
  902. if (SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
  903. SharedRuntimes.push_back("scudo_standalone");
  904. }
  905. if (SanArgs.needsTsanRt() && SanArgs.linkRuntimes())
  906. SharedRuntimes.push_back("tsan");
  907. if (SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
  908. if (SanArgs.needsHwasanAliasesRt())
  909. SharedRuntimes.push_back("hwasan_aliases");
  910. else
  911. SharedRuntimes.push_back("hwasan");
  912. if (!Args.hasArg(options::OPT_shared))
  913. HelperStaticRuntimes.push_back("hwasan-preinit");
  914. }
  915. }
  916. // The stats_client library is also statically linked into DSOs.
  917. if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes())
  918. StaticRuntimes.push_back("stats_client");
  919. // Always link the static runtime regardless of DSO or executable.
  920. if (SanArgs.needsAsanRt() && SanArgs.linkRuntimes())
  921. HelperStaticRuntimes.push_back("asan_static");
  922. // Collect static runtimes.
  923. if (Args.hasArg(options::OPT_shared)) {
  924. // Don't link static runtimes into DSOs.
  925. return;
  926. }
  927. // Each static runtime that has a DSO counterpart above is excluded below,
  928. // but runtimes that exist only as static are not affected by needsSharedRt.
  929. if (!SanArgs.needsSharedRt() && SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
  930. StaticRuntimes.push_back("asan");
  931. if (SanArgs.linkCXXRuntimes())
  932. StaticRuntimes.push_back("asan_cxx");
  933. }
  934. if (!SanArgs.needsSharedRt() && SanArgs.needsMemProfRt() &&
  935. SanArgs.linkRuntimes()) {
  936. StaticRuntimes.push_back("memprof");
  937. if (SanArgs.linkCXXRuntimes())
  938. StaticRuntimes.push_back("memprof_cxx");
  939. }
  940. if (!SanArgs.needsSharedRt() && SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
  941. if (SanArgs.needsHwasanAliasesRt()) {
  942. StaticRuntimes.push_back("hwasan_aliases");
  943. if (SanArgs.linkCXXRuntimes())
  944. StaticRuntimes.push_back("hwasan_aliases_cxx");
  945. } else {
  946. StaticRuntimes.push_back("hwasan");
  947. if (SanArgs.linkCXXRuntimes())
  948. StaticRuntimes.push_back("hwasan_cxx");
  949. }
  950. }
  951. if (SanArgs.needsDfsanRt() && SanArgs.linkRuntimes())
  952. StaticRuntimes.push_back("dfsan");
  953. if (SanArgs.needsLsanRt() && SanArgs.linkRuntimes())
  954. StaticRuntimes.push_back("lsan");
  955. if (SanArgs.needsMsanRt() && SanArgs.linkRuntimes()) {
  956. StaticRuntimes.push_back("msan");
  957. if (SanArgs.linkCXXRuntimes())
  958. StaticRuntimes.push_back("msan_cxx");
  959. }
  960. if (!SanArgs.needsSharedRt() && SanArgs.needsTsanRt() &&
  961. SanArgs.linkRuntimes()) {
  962. StaticRuntimes.push_back("tsan");
  963. if (SanArgs.linkCXXRuntimes())
  964. StaticRuntimes.push_back("tsan_cxx");
  965. }
  966. if (!SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
  967. if (SanArgs.requiresMinimalRuntime()) {
  968. StaticRuntimes.push_back("ubsan_minimal");
  969. } else {
  970. StaticRuntimes.push_back("ubsan_standalone");
  971. if (SanArgs.linkCXXRuntimes())
  972. StaticRuntimes.push_back("ubsan_standalone_cxx");
  973. }
  974. }
  975. if (SanArgs.needsSafeStackRt() && SanArgs.linkRuntimes()) {
  976. NonWholeStaticRuntimes.push_back("safestack");
  977. RequiredSymbols.push_back("__safestack_init");
  978. }
  979. if (!(SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes())) {
  980. if (SanArgs.needsCfiRt() && SanArgs.linkRuntimes())
  981. StaticRuntimes.push_back("cfi");
  982. if (SanArgs.needsCfiDiagRt() && SanArgs.linkRuntimes()) {
  983. StaticRuntimes.push_back("cfi_diag");
  984. if (SanArgs.linkCXXRuntimes())
  985. StaticRuntimes.push_back("ubsan_standalone_cxx");
  986. }
  987. }
  988. if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes()) {
  989. NonWholeStaticRuntimes.push_back("stats");
  990. RequiredSymbols.push_back("__sanitizer_stats_register");
  991. }
  992. if (!SanArgs.needsSharedRt() && SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
  993. StaticRuntimes.push_back("scudo_standalone");
  994. if (SanArgs.linkCXXRuntimes())
  995. StaticRuntimes.push_back("scudo_standalone_cxx");
  996. }
  997. }
  998. // Should be called before we add system libraries (C++ ABI, libstdc++/libc++,
  999. // C runtime, etc). Returns true if sanitizer system deps need to be linked in.
  1000. bool tools::addSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
  1001. ArgStringList &CmdArgs) {
  1002. SmallVector<StringRef, 4> SharedRuntimes, StaticRuntimes,
  1003. NonWholeStaticRuntimes, HelperStaticRuntimes, RequiredSymbols;
  1004. collectSanitizerRuntimes(TC, Args, SharedRuntimes, StaticRuntimes,
  1005. NonWholeStaticRuntimes, HelperStaticRuntimes,
  1006. RequiredSymbols);
  1007. const SanitizerArgs &SanArgs = TC.getSanitizerArgs(Args);
  1008. // Inject libfuzzer dependencies.
  1009. if (SanArgs.needsFuzzer() && SanArgs.linkRuntimes() &&
  1010. !Args.hasArg(options::OPT_shared)) {
  1011. addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer", false, true);
  1012. if (SanArgs.needsFuzzerInterceptors())
  1013. addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer_interceptors", false,
  1014. true);
  1015. if (!Args.hasArg(clang::driver::options::OPT_nostdlibxx)) {
  1016. bool OnlyLibstdcxxStatic = Args.hasArg(options::OPT_static_libstdcxx) &&
  1017. !Args.hasArg(options::OPT_static);
  1018. if (OnlyLibstdcxxStatic)
  1019. CmdArgs.push_back("-Bstatic");
  1020. TC.AddCXXStdlibLibArgs(Args, CmdArgs);
  1021. if (OnlyLibstdcxxStatic)
  1022. CmdArgs.push_back("-Bdynamic");
  1023. }
  1024. }
  1025. for (auto RT : SharedRuntimes)
  1026. addSanitizerRuntime(TC, Args, CmdArgs, RT, true, false);
  1027. for (auto RT : HelperStaticRuntimes)
  1028. addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
  1029. bool AddExportDynamic = false;
  1030. for (auto RT : StaticRuntimes) {
  1031. addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
  1032. AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
  1033. }
  1034. for (auto RT : NonWholeStaticRuntimes) {
  1035. addSanitizerRuntime(TC, Args, CmdArgs, RT, false, false);
  1036. AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
  1037. }
  1038. for (auto S : RequiredSymbols) {
  1039. CmdArgs.push_back("-u");
  1040. CmdArgs.push_back(Args.MakeArgString(S));
  1041. }
  1042. // If there is a static runtime with no dynamic list, force all the symbols
  1043. // to be dynamic to be sure we export sanitizer interface functions.
  1044. if (AddExportDynamic)
  1045. CmdArgs.push_back("--export-dynamic");
  1046. if (SanArgs.hasCrossDsoCfi() && !AddExportDynamic)
  1047. CmdArgs.push_back("--export-dynamic-symbol=__cfi_check");
  1048. if (SanArgs.hasMemTag()) {
  1049. if (!TC.getTriple().isAndroid()) {
  1050. TC.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
  1051. << "-fsanitize=memtag*" << TC.getTriple().str();
  1052. }
  1053. CmdArgs.push_back(
  1054. Args.MakeArgString("--android-memtag-mode=" + SanArgs.getMemtagMode()));
  1055. if (SanArgs.hasMemtagHeap())
  1056. CmdArgs.push_back("--android-memtag-heap");
  1057. if (SanArgs.hasMemtagStack())
  1058. CmdArgs.push_back("--android-memtag-stack");
  1059. }
  1060. return !StaticRuntimes.empty() || !NonWholeStaticRuntimes.empty();
  1061. }
  1062. bool tools::addXRayRuntime(const ToolChain&TC, const ArgList &Args, ArgStringList &CmdArgs) {
  1063. if (Args.hasArg(options::OPT_shared))
  1064. return false;
  1065. if (TC.getXRayArgs().needsXRayRt()) {
  1066. CmdArgs.push_back("-whole-archive");
  1067. CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray"));
  1068. for (const auto &Mode : TC.getXRayArgs().modeList())
  1069. CmdArgs.push_back(TC.getCompilerRTArgString(Args, Mode));
  1070. CmdArgs.push_back("-no-whole-archive");
  1071. return true;
  1072. }
  1073. return false;
  1074. }
  1075. void tools::linkXRayRuntimeDeps(const ToolChain &TC, ArgStringList &CmdArgs) {
  1076. CmdArgs.push_back(getAsNeededOption(TC, false));
  1077. CmdArgs.push_back("-lpthread");
  1078. if (!TC.getTriple().isOSOpenBSD())
  1079. CmdArgs.push_back("-lrt");
  1080. CmdArgs.push_back("-lm");
  1081. if (!TC.getTriple().isOSFreeBSD() &&
  1082. !TC.getTriple().isOSNetBSD() &&
  1083. !TC.getTriple().isOSOpenBSD())
  1084. CmdArgs.push_back("-ldl");
  1085. }
  1086. bool tools::areOptimizationsEnabled(const ArgList &Args) {
  1087. // Find the last -O arg and see if it is non-zero.
  1088. if (Arg *A = Args.getLastArg(options::OPT_O_Group))
  1089. return !A->getOption().matches(options::OPT_O0);
  1090. // Defaults to -O0.
  1091. return false;
  1092. }
  1093. const char *tools::SplitDebugName(const JobAction &JA, const ArgList &Args,
  1094. const InputInfo &Input,
  1095. const InputInfo &Output) {
  1096. auto AddPostfix = [JA](auto &F) {
  1097. if (JA.getOffloadingDeviceKind() == Action::OFK_HIP)
  1098. F += (Twine("_") + JA.getOffloadingArch()).str();
  1099. F += ".dwo";
  1100. };
  1101. if (Arg *A = Args.getLastArg(options::OPT_gsplit_dwarf_EQ))
  1102. if (StringRef(A->getValue()) == "single")
  1103. return Args.MakeArgString(Output.getFilename());
  1104. Arg *FinalOutput = Args.getLastArg(options::OPT_o);
  1105. if (FinalOutput && Args.hasArg(options::OPT_c)) {
  1106. SmallString<128> T(FinalOutput->getValue());
  1107. llvm::sys::path::remove_filename(T);
  1108. llvm::sys::path::append(T, llvm::sys::path::stem(FinalOutput->getValue()));
  1109. AddPostfix(T);
  1110. return Args.MakeArgString(T);
  1111. } else {
  1112. // Use the compilation dir.
  1113. Arg *A = Args.getLastArg(options::OPT_ffile_compilation_dir_EQ,
  1114. options::OPT_fdebug_compilation_dir_EQ);
  1115. SmallString<128> T(A ? A->getValue() : "");
  1116. SmallString<128> F(llvm::sys::path::stem(Input.getBaseInput()));
  1117. AddPostfix(F);
  1118. T += F;
  1119. return Args.MakeArgString(T);
  1120. }
  1121. }
  1122. void tools::SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
  1123. const JobAction &JA, const ArgList &Args,
  1124. const InputInfo &Output, const char *OutFile) {
  1125. ArgStringList ExtractArgs;
  1126. ExtractArgs.push_back("--extract-dwo");
  1127. ArgStringList StripArgs;
  1128. StripArgs.push_back("--strip-dwo");
  1129. // Grabbing the output of the earlier compile step.
  1130. StripArgs.push_back(Output.getFilename());
  1131. ExtractArgs.push_back(Output.getFilename());
  1132. ExtractArgs.push_back(OutFile);
  1133. const char *Exec =
  1134. Args.MakeArgString(TC.GetProgramPath(CLANG_DEFAULT_OBJCOPY));
  1135. InputInfo II(types::TY_Object, Output.getFilename(), Output.getFilename());
  1136. // First extract the dwo sections.
  1137. C.addCommand(std::make_unique<Command>(JA, T,
  1138. ResponseFileSupport::AtFileCurCP(),
  1139. Exec, ExtractArgs, II, Output));
  1140. // Then remove them from the original .o file.
  1141. C.addCommand(std::make_unique<Command>(
  1142. JA, T, ResponseFileSupport::AtFileCurCP(), Exec, StripArgs, II, Output));
  1143. }
  1144. // Claim options we don't want to warn if they are unused. We do this for
  1145. // options that build systems might add but are unused when assembling or only
  1146. // running the preprocessor for example.
  1147. void tools::claimNoWarnArgs(const ArgList &Args) {
  1148. // Don't warn about unused -f(no-)?lto. This can happen when we're
  1149. // preprocessing, precompiling or assembling.
  1150. Args.ClaimAllArgs(options::OPT_flto_EQ);
  1151. Args.ClaimAllArgs(options::OPT_flto);
  1152. Args.ClaimAllArgs(options::OPT_fno_lto);
  1153. }
  1154. Arg *tools::getLastProfileUseArg(const ArgList &Args) {
  1155. auto *ProfileUseArg = Args.getLastArg(
  1156. options::OPT_fprofile_instr_use, options::OPT_fprofile_instr_use_EQ,
  1157. options::OPT_fprofile_use, options::OPT_fprofile_use_EQ,
  1158. options::OPT_fno_profile_instr_use);
  1159. if (ProfileUseArg &&
  1160. ProfileUseArg->getOption().matches(options::OPT_fno_profile_instr_use))
  1161. ProfileUseArg = nullptr;
  1162. return ProfileUseArg;
  1163. }
  1164. Arg *tools::getLastProfileSampleUseArg(const ArgList &Args) {
  1165. auto *ProfileSampleUseArg = Args.getLastArg(
  1166. options::OPT_fprofile_sample_use, options::OPT_fprofile_sample_use_EQ,
  1167. options::OPT_fauto_profile, options::OPT_fauto_profile_EQ,
  1168. options::OPT_fno_profile_sample_use, options::OPT_fno_auto_profile);
  1169. if (ProfileSampleUseArg &&
  1170. (ProfileSampleUseArg->getOption().matches(
  1171. options::OPT_fno_profile_sample_use) ||
  1172. ProfileSampleUseArg->getOption().matches(options::OPT_fno_auto_profile)))
  1173. return nullptr;
  1174. return Args.getLastArg(options::OPT_fprofile_sample_use_EQ,
  1175. options::OPT_fauto_profile_EQ);
  1176. }
  1177. const char *tools::RelocationModelName(llvm::Reloc::Model Model) {
  1178. switch (Model) {
  1179. case llvm::Reloc::Static:
  1180. return "static";
  1181. case llvm::Reloc::PIC_:
  1182. return "pic";
  1183. case llvm::Reloc::DynamicNoPIC:
  1184. return "dynamic-no-pic";
  1185. case llvm::Reloc::ROPI:
  1186. return "ropi";
  1187. case llvm::Reloc::RWPI:
  1188. return "rwpi";
  1189. case llvm::Reloc::ROPI_RWPI:
  1190. return "ropi-rwpi";
  1191. }
  1192. llvm_unreachable("Unknown Reloc::Model kind");
  1193. }
  1194. /// Parses the various -fpic/-fPIC/-fpie/-fPIE arguments. Then,
  1195. /// smooshes them together with platform defaults, to decide whether
  1196. /// this compile should be using PIC mode or not. Returns a tuple of
  1197. /// (RelocationModel, PICLevel, IsPIE).
  1198. std::tuple<llvm::Reloc::Model, unsigned, bool>
  1199. tools::ParsePICArgs(const ToolChain &ToolChain, const ArgList &Args) {
  1200. const llvm::Triple &EffectiveTriple = ToolChain.getEffectiveTriple();
  1201. const llvm::Triple &Triple = ToolChain.getTriple();
  1202. bool PIE = ToolChain.isPIEDefault(Args);
  1203. bool PIC = PIE || ToolChain.isPICDefault();
  1204. // The Darwin/MachO default to use PIC does not apply when using -static.
  1205. if (Triple.isOSBinFormatMachO() && Args.hasArg(options::OPT_static))
  1206. PIE = PIC = false;
  1207. bool IsPICLevelTwo = PIC;
  1208. bool KernelOrKext =
  1209. Args.hasArg(options::OPT_mkernel, options::OPT_fapple_kext);
  1210. // Android-specific defaults for PIC/PIE
  1211. if (Triple.isAndroid()) {
  1212. switch (Triple.getArch()) {
  1213. case llvm::Triple::arm:
  1214. case llvm::Triple::armeb:
  1215. case llvm::Triple::thumb:
  1216. case llvm::Triple::thumbeb:
  1217. case llvm::Triple::aarch64:
  1218. case llvm::Triple::mips:
  1219. case llvm::Triple::mipsel:
  1220. case llvm::Triple::mips64:
  1221. case llvm::Triple::mips64el:
  1222. PIC = true; // "-fpic"
  1223. break;
  1224. case llvm::Triple::x86:
  1225. case llvm::Triple::x86_64:
  1226. PIC = true; // "-fPIC"
  1227. IsPICLevelTwo = true;
  1228. break;
  1229. default:
  1230. break;
  1231. }
  1232. }
  1233. // OpenBSD-specific defaults for PIE
  1234. if (Triple.isOSOpenBSD()) {
  1235. switch (ToolChain.getArch()) {
  1236. case llvm::Triple::arm:
  1237. case llvm::Triple::aarch64:
  1238. case llvm::Triple::mips64:
  1239. case llvm::Triple::mips64el:
  1240. case llvm::Triple::x86:
  1241. case llvm::Triple::x86_64:
  1242. IsPICLevelTwo = false; // "-fpie"
  1243. break;
  1244. case llvm::Triple::ppc:
  1245. case llvm::Triple::sparcv9:
  1246. IsPICLevelTwo = true; // "-fPIE"
  1247. break;
  1248. default:
  1249. break;
  1250. }
  1251. }
  1252. // AMDGPU-specific defaults for PIC.
  1253. if (Triple.getArch() == llvm::Triple::amdgcn)
  1254. PIC = true;
  1255. // The last argument relating to either PIC or PIE wins, and no
  1256. // other argument is used. If the last argument is any flavor of the
  1257. // '-fno-...' arguments, both PIC and PIE are disabled. Any PIE
  1258. // option implicitly enables PIC at the same level.
  1259. Arg *LastPICArg = Args.getLastArg(options::OPT_fPIC, options::OPT_fno_PIC,
  1260. options::OPT_fpic, options::OPT_fno_pic,
  1261. options::OPT_fPIE, options::OPT_fno_PIE,
  1262. options::OPT_fpie, options::OPT_fno_pie);
  1263. if (Triple.isOSWindows() && !Triple.isOSCygMing() && LastPICArg &&
  1264. LastPICArg == Args.getLastArg(options::OPT_fPIC, options::OPT_fpic,
  1265. options::OPT_fPIE, options::OPT_fpie)) {
  1266. ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
  1267. << LastPICArg->getSpelling() << Triple.str();
  1268. if (Triple.getArch() == llvm::Triple::x86_64)
  1269. return std::make_tuple(llvm::Reloc::PIC_, 2U, false);
  1270. return std::make_tuple(llvm::Reloc::Static, 0U, false);
  1271. }
  1272. // Check whether the tool chain trumps the PIC-ness decision. If the PIC-ness
  1273. // is forced, then neither PIC nor PIE flags will have no effect.
  1274. if (!ToolChain.isPICDefaultForced()) {
  1275. if (LastPICArg) {
  1276. Option O = LastPICArg->getOption();
  1277. if (O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic) ||
  1278. O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie)) {
  1279. PIE = O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie);
  1280. PIC =
  1281. PIE || O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic);
  1282. IsPICLevelTwo =
  1283. O.matches(options::OPT_fPIE) || O.matches(options::OPT_fPIC);
  1284. } else {
  1285. PIE = PIC = false;
  1286. if (EffectiveTriple.isPS()) {
  1287. Arg *ModelArg = Args.getLastArg(options::OPT_mcmodel_EQ);
  1288. StringRef Model = ModelArg ? ModelArg->getValue() : "";
  1289. if (Model != "kernel") {
  1290. PIC = true;
  1291. ToolChain.getDriver().Diag(diag::warn_drv_ps_force_pic)
  1292. << LastPICArg->getSpelling()
  1293. << (EffectiveTriple.isPS4() ? "PS4" : "PS5");
  1294. }
  1295. }
  1296. }
  1297. }
  1298. }
  1299. // Introduce a Darwin and PS4/PS5-specific hack. If the default is PIC, but
  1300. // the PIC level would've been set to level 1, force it back to level 2 PIC
  1301. // instead.
  1302. if (PIC && (Triple.isOSDarwin() || EffectiveTriple.isPS()))
  1303. IsPICLevelTwo |= ToolChain.isPICDefault();
  1304. // This kernel flags are a trump-card: they will disable PIC/PIE
  1305. // generation, independent of the argument order.
  1306. if (KernelOrKext &&
  1307. ((!EffectiveTriple.isiOS() || EffectiveTriple.isOSVersionLT(6)) &&
  1308. !EffectiveTriple.isWatchOS() && !EffectiveTriple.isDriverKit()))
  1309. PIC = PIE = false;
  1310. if (Arg *A = Args.getLastArg(options::OPT_mdynamic_no_pic)) {
  1311. // This is a very special mode. It trumps the other modes, almost no one
  1312. // uses it, and it isn't even valid on any OS but Darwin.
  1313. if (!Triple.isOSDarwin())
  1314. ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
  1315. << A->getSpelling() << Triple.str();
  1316. // FIXME: Warn when this flag trumps some other PIC or PIE flag.
  1317. // Only a forced PIC mode can cause the actual compile to have PIC defines
  1318. // etc., no flags are sufficient. This behavior was selected to closely
  1319. // match that of llvm-gcc and Apple GCC before that.
  1320. PIC = ToolChain.isPICDefault() && ToolChain.isPICDefaultForced();
  1321. return std::make_tuple(llvm::Reloc::DynamicNoPIC, PIC ? 2U : 0U, false);
  1322. }
  1323. bool EmbeddedPISupported;
  1324. switch (Triple.getArch()) {
  1325. case llvm::Triple::arm:
  1326. case llvm::Triple::armeb:
  1327. case llvm::Triple::thumb:
  1328. case llvm::Triple::thumbeb:
  1329. EmbeddedPISupported = true;
  1330. break;
  1331. default:
  1332. EmbeddedPISupported = false;
  1333. break;
  1334. }
  1335. bool ROPI = false, RWPI = false;
  1336. Arg* LastROPIArg = Args.getLastArg(options::OPT_fropi, options::OPT_fno_ropi);
  1337. if (LastROPIArg && LastROPIArg->getOption().matches(options::OPT_fropi)) {
  1338. if (!EmbeddedPISupported)
  1339. ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
  1340. << LastROPIArg->getSpelling() << Triple.str();
  1341. ROPI = true;
  1342. }
  1343. Arg *LastRWPIArg = Args.getLastArg(options::OPT_frwpi, options::OPT_fno_rwpi);
  1344. if (LastRWPIArg && LastRWPIArg->getOption().matches(options::OPT_frwpi)) {
  1345. if (!EmbeddedPISupported)
  1346. ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
  1347. << LastRWPIArg->getSpelling() << Triple.str();
  1348. RWPI = true;
  1349. }
  1350. // ROPI and RWPI are not compatible with PIC or PIE.
  1351. if ((ROPI || RWPI) && (PIC || PIE))
  1352. ToolChain.getDriver().Diag(diag::err_drv_ropi_rwpi_incompatible_with_pic);
  1353. if (Triple.isMIPS()) {
  1354. StringRef CPUName;
  1355. StringRef ABIName;
  1356. mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
  1357. // When targeting the N64 ABI, PIC is the default, except in the case
  1358. // when the -mno-abicalls option is used. In that case we exit
  1359. // at next check regardless of PIC being set below.
  1360. if (ABIName == "n64")
  1361. PIC = true;
  1362. // When targettng MIPS with -mno-abicalls, it's always static.
  1363. if(Args.hasArg(options::OPT_mno_abicalls))
  1364. return std::make_tuple(llvm::Reloc::Static, 0U, false);
  1365. // Unlike other architectures, MIPS, even with -fPIC/-mxgot/multigot,
  1366. // does not use PIC level 2 for historical reasons.
  1367. IsPICLevelTwo = false;
  1368. }
  1369. if (PIC)
  1370. return std::make_tuple(llvm::Reloc::PIC_, IsPICLevelTwo ? 2U : 1U, PIE);
  1371. llvm::Reloc::Model RelocM = llvm::Reloc::Static;
  1372. if (ROPI && RWPI)
  1373. RelocM = llvm::Reloc::ROPI_RWPI;
  1374. else if (ROPI)
  1375. RelocM = llvm::Reloc::ROPI;
  1376. else if (RWPI)
  1377. RelocM = llvm::Reloc::RWPI;
  1378. return std::make_tuple(RelocM, 0U, false);
  1379. }
  1380. // `-falign-functions` indicates that the functions should be aligned to a
  1381. // 16-byte boundary.
  1382. //
  1383. // `-falign-functions=1` is the same as `-fno-align-functions`.
  1384. //
  1385. // The scalar `n` in `-falign-functions=n` must be an integral value between
  1386. // [0, 65536]. If the value is not a power-of-two, it will be rounded up to
  1387. // the nearest power-of-two.
  1388. //
  1389. // If we return `0`, the frontend will default to the backend's preferred
  1390. // alignment.
  1391. //
  1392. // NOTE: icc only allows values between [0, 4096]. icc uses `-falign-functions`
  1393. // to mean `-falign-functions=16`. GCC defaults to the backend's preferred
  1394. // alignment. For unaligned functions, we default to the backend's preferred
  1395. // alignment.
  1396. unsigned tools::ParseFunctionAlignment(const ToolChain &TC,
  1397. const ArgList &Args) {
  1398. const Arg *A = Args.getLastArg(options::OPT_falign_functions,
  1399. options::OPT_falign_functions_EQ,
  1400. options::OPT_fno_align_functions);
  1401. if (!A || A->getOption().matches(options::OPT_fno_align_functions))
  1402. return 0;
  1403. if (A->getOption().matches(options::OPT_falign_functions))
  1404. return 0;
  1405. unsigned Value = 0;
  1406. if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 65536)
  1407. TC.getDriver().Diag(diag::err_drv_invalid_int_value)
  1408. << A->getAsString(Args) << A->getValue();
  1409. return Value ? llvm::Log2_32_Ceil(std::min(Value, 65536u)) : Value;
  1410. }
  1411. static unsigned ParseDebugDefaultVersion(const ToolChain &TC,
  1412. const ArgList &Args) {
  1413. const Arg *A = Args.getLastArg(options::OPT_fdebug_default_version);
  1414. if (!A)
  1415. return 0;
  1416. unsigned Value = 0;
  1417. if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 5 ||
  1418. Value < 2)
  1419. TC.getDriver().Diag(diag::err_drv_invalid_int_value)
  1420. << A->getAsString(Args) << A->getValue();
  1421. return Value;
  1422. }
  1423. unsigned tools::DwarfVersionNum(StringRef ArgValue) {
  1424. return llvm::StringSwitch<unsigned>(ArgValue)
  1425. .Case("-gdwarf-2", 2)
  1426. .Case("-gdwarf-3", 3)
  1427. .Case("-gdwarf-4", 4)
  1428. .Case("-gdwarf-5", 5)
  1429. .Default(0);
  1430. }
  1431. const Arg *tools::getDwarfNArg(const ArgList &Args) {
  1432. return Args.getLastArg(options::OPT_gdwarf_2, options::OPT_gdwarf_3,
  1433. options::OPT_gdwarf_4, options::OPT_gdwarf_5,
  1434. options::OPT_gdwarf);
  1435. }
  1436. unsigned tools::getDwarfVersion(const ToolChain &TC,
  1437. const llvm::opt::ArgList &Args) {
  1438. unsigned DwarfVersion = ParseDebugDefaultVersion(TC, Args);
  1439. if (const Arg *GDwarfN = getDwarfNArg(Args))
  1440. if (int N = DwarfVersionNum(GDwarfN->getSpelling()))
  1441. DwarfVersion = N;
  1442. if (DwarfVersion == 0) {
  1443. DwarfVersion = TC.GetDefaultDwarfVersion();
  1444. assert(DwarfVersion && "toolchain default DWARF version must be nonzero");
  1445. }
  1446. return DwarfVersion;
  1447. }
  1448. void tools::AddAssemblerKPIC(const ToolChain &ToolChain, const ArgList &Args,
  1449. ArgStringList &CmdArgs) {
  1450. llvm::Reloc::Model RelocationModel;
  1451. unsigned PICLevel;
  1452. bool IsPIE;
  1453. std::tie(RelocationModel, PICLevel, IsPIE) = ParsePICArgs(ToolChain, Args);
  1454. if (RelocationModel != llvm::Reloc::Static)
  1455. CmdArgs.push_back("-KPIC");
  1456. }
  1457. /// Determine whether Objective-C automated reference counting is
  1458. /// enabled.
  1459. bool tools::isObjCAutoRefCount(const ArgList &Args) {
  1460. return Args.hasFlag(options::OPT_fobjc_arc, options::OPT_fno_objc_arc, false);
  1461. }
  1462. enum class LibGccType { UnspecifiedLibGcc, StaticLibGcc, SharedLibGcc };
  1463. static LibGccType getLibGccType(const ToolChain &TC, const Driver &D,
  1464. const ArgList &Args) {
  1465. if (Args.hasArg(options::OPT_static_libgcc) ||
  1466. Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_static_pie) ||
  1467. // The Android NDK only provides libunwind.a, not libunwind.so.
  1468. TC.getTriple().isAndroid())
  1469. return LibGccType::StaticLibGcc;
  1470. if (Args.hasArg(options::OPT_shared_libgcc))
  1471. return LibGccType::SharedLibGcc;
  1472. return LibGccType::UnspecifiedLibGcc;
  1473. }
  1474. // Gcc adds libgcc arguments in various ways:
  1475. //
  1476. // gcc <none>: -lgcc --as-needed -lgcc_s --no-as-needed
  1477. // g++ <none>: -lgcc_s -lgcc
  1478. // gcc shared: -lgcc_s -lgcc
  1479. // g++ shared: -lgcc_s -lgcc
  1480. // gcc static: -lgcc -lgcc_eh
  1481. // g++ static: -lgcc -lgcc_eh
  1482. // gcc static-pie: -lgcc -lgcc_eh
  1483. // g++ static-pie: -lgcc -lgcc_eh
  1484. //
  1485. // Also, certain targets need additional adjustments.
  1486. static void AddUnwindLibrary(const ToolChain &TC, const Driver &D,
  1487. ArgStringList &CmdArgs, const ArgList &Args) {
  1488. ToolChain::UnwindLibType UNW = TC.GetUnwindLibType(Args);
  1489. // Targets that don't use unwind libraries.
  1490. if ((TC.getTriple().isAndroid() && UNW == ToolChain::UNW_Libgcc) ||
  1491. TC.getTriple().isOSIAMCU() || TC.getTriple().isOSBinFormatWasm() ||
  1492. TC.getTriple().isWindowsMSVCEnvironment() || UNW == ToolChain::UNW_None)
  1493. return;
  1494. LibGccType LGT = getLibGccType(TC, D, Args);
  1495. bool AsNeeded = LGT == LibGccType::UnspecifiedLibGcc &&
  1496. (UNW == ToolChain::UNW_CompilerRT || !D.CCCIsCXX()) &&
  1497. !TC.getTriple().isAndroid() &&
  1498. !TC.getTriple().isOSCygMing() && !TC.getTriple().isOSAIX();
  1499. if (AsNeeded)
  1500. CmdArgs.push_back(getAsNeededOption(TC, true));
  1501. switch (UNW) {
  1502. case ToolChain::UNW_None:
  1503. return;
  1504. case ToolChain::UNW_Libgcc: {
  1505. if (LGT == LibGccType::StaticLibGcc)
  1506. CmdArgs.push_back("-lgcc_eh");
  1507. else
  1508. CmdArgs.push_back("-lgcc_s");
  1509. break;
  1510. }
  1511. case ToolChain::UNW_CompilerRT:
  1512. if (TC.getTriple().isOSAIX()) {
  1513. // AIX only has libunwind as a shared library. So do not pass
  1514. // anything in if -static is specified.
  1515. if (LGT != LibGccType::StaticLibGcc)
  1516. CmdArgs.push_back("-lunwind");
  1517. } else if (LGT == LibGccType::StaticLibGcc) {
  1518. CmdArgs.push_back("-l:libunwind.a");
  1519. } else if (LGT == LibGccType::SharedLibGcc) {
  1520. if (TC.getTriple().isOSCygMing())
  1521. CmdArgs.push_back("-l:libunwind.dll.a");
  1522. else
  1523. CmdArgs.push_back("-l:libunwind.so");
  1524. } else {
  1525. // Let the linker choose between libunwind.so and libunwind.a
  1526. // depending on what's available, and depending on the -static flag
  1527. CmdArgs.push_back("-lunwind");
  1528. }
  1529. break;
  1530. }
  1531. if (AsNeeded)
  1532. CmdArgs.push_back(getAsNeededOption(TC, false));
  1533. }
  1534. static void AddLibgcc(const ToolChain &TC, const Driver &D,
  1535. ArgStringList &CmdArgs, const ArgList &Args) {
  1536. LibGccType LGT = getLibGccType(TC, D, Args);
  1537. if (LGT == LibGccType::StaticLibGcc ||
  1538. (LGT == LibGccType::UnspecifiedLibGcc && !D.CCCIsCXX()))
  1539. CmdArgs.push_back("-lgcc");
  1540. AddUnwindLibrary(TC, D, CmdArgs, Args);
  1541. if (LGT == LibGccType::SharedLibGcc ||
  1542. (LGT == LibGccType::UnspecifiedLibGcc && D.CCCIsCXX()))
  1543. CmdArgs.push_back("-lgcc");
  1544. }
  1545. void tools::AddRunTimeLibs(const ToolChain &TC, const Driver &D,
  1546. ArgStringList &CmdArgs, const ArgList &Args) {
  1547. // Make use of compiler-rt if --rtlib option is used
  1548. ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(Args);
  1549. switch (RLT) {
  1550. case ToolChain::RLT_CompilerRT:
  1551. CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
  1552. AddUnwindLibrary(TC, D, CmdArgs, Args);
  1553. break;
  1554. case ToolChain::RLT_Libgcc:
  1555. // Make sure libgcc is not used under MSVC environment by default
  1556. if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
  1557. // Issue error diagnostic if libgcc is explicitly specified
  1558. // through command line as --rtlib option argument.
  1559. Arg *A = Args.getLastArg(options::OPT_rtlib_EQ);
  1560. if (A && A->getValue() != StringRef("platform")) {
  1561. TC.getDriver().Diag(diag::err_drv_unsupported_rtlib_for_platform)
  1562. << A->getValue() << "MSVC";
  1563. }
  1564. } else
  1565. AddLibgcc(TC, D, CmdArgs, Args);
  1566. break;
  1567. }
  1568. // On Android, the unwinder uses dl_iterate_phdr (or one of
  1569. // dl_unwind_find_exidx/__gnu_Unwind_Find_exidx on arm32) from libdl.so. For
  1570. // statically-linked executables, these functions come from libc.a instead.
  1571. if (TC.getTriple().isAndroid() && !Args.hasArg(options::OPT_static) &&
  1572. !Args.hasArg(options::OPT_static_pie))
  1573. CmdArgs.push_back("-ldl");
  1574. }
  1575. SmallString<128> tools::getStatsFileName(const llvm::opt::ArgList &Args,
  1576. const InputInfo &Output,
  1577. const InputInfo &Input,
  1578. const Driver &D) {
  1579. const Arg *A = Args.getLastArg(options::OPT_save_stats_EQ);
  1580. if (!A)
  1581. return {};
  1582. StringRef SaveStats = A->getValue();
  1583. SmallString<128> StatsFile;
  1584. if (SaveStats == "obj" && Output.isFilename()) {
  1585. StatsFile.assign(Output.getFilename());
  1586. llvm::sys::path::remove_filename(StatsFile);
  1587. } else if (SaveStats != "cwd") {
  1588. D.Diag(diag::err_drv_invalid_value) << A->getAsString(Args) << SaveStats;
  1589. return {};
  1590. }
  1591. StringRef BaseName = llvm::sys::path::filename(Input.getBaseInput());
  1592. llvm::sys::path::append(StatsFile, BaseName);
  1593. llvm::sys::path::replace_extension(StatsFile, "stats");
  1594. return StatsFile;
  1595. }
  1596. void tools::addMultilibFlag(bool Enabled, const char *const Flag,
  1597. Multilib::flags_list &Flags) {
  1598. Flags.push_back(std::string(Enabled ? "+" : "-") + Flag);
  1599. }
  1600. void tools::addX86AlignBranchArgs(const Driver &D, const ArgList &Args,
  1601. ArgStringList &CmdArgs, bool IsLTO,
  1602. const StringRef PluginOptPrefix) {
  1603. auto addArg = [&, IsLTO](const Twine &Arg) {
  1604. if (IsLTO) {
  1605. assert(!PluginOptPrefix.empty() && "Cannot have empty PluginOptPrefix!");
  1606. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + Arg));
  1607. } else {
  1608. CmdArgs.push_back("-mllvm");
  1609. CmdArgs.push_back(Args.MakeArgString(Arg));
  1610. }
  1611. };
  1612. if (Args.hasArg(options::OPT_mbranches_within_32B_boundaries)) {
  1613. addArg(Twine("-x86-branches-within-32B-boundaries"));
  1614. }
  1615. if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_boundary_EQ)) {
  1616. StringRef Value = A->getValue();
  1617. unsigned Boundary;
  1618. if (Value.getAsInteger(10, Boundary) || Boundary < 16 ||
  1619. !llvm::isPowerOf2_64(Boundary)) {
  1620. D.Diag(diag::err_drv_invalid_argument_to_option)
  1621. << Value << A->getOption().getName();
  1622. } else {
  1623. addArg("-x86-align-branch-boundary=" + Twine(Boundary));
  1624. }
  1625. }
  1626. if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_EQ)) {
  1627. std::string AlignBranch;
  1628. for (StringRef T : A->getValues()) {
  1629. if (T != "fused" && T != "jcc" && T != "jmp" && T != "call" &&
  1630. T != "ret" && T != "indirect")
  1631. D.Diag(diag::err_drv_invalid_malign_branch_EQ)
  1632. << T << "fused, jcc, jmp, call, ret, indirect";
  1633. if (!AlignBranch.empty())
  1634. AlignBranch += '+';
  1635. AlignBranch += T;
  1636. }
  1637. addArg("-x86-align-branch=" + Twine(AlignBranch));
  1638. }
  1639. if (const Arg *A = Args.getLastArg(options::OPT_mpad_max_prefix_size_EQ)) {
  1640. StringRef Value = A->getValue();
  1641. unsigned PrefixSize;
  1642. if (Value.getAsInteger(10, PrefixSize)) {
  1643. D.Diag(diag::err_drv_invalid_argument_to_option)
  1644. << Value << A->getOption().getName();
  1645. } else {
  1646. addArg("-x86-pad-max-prefix-size=" + Twine(PrefixSize));
  1647. }
  1648. }
  1649. }
  1650. /// SDLSearch: Search for Static Device Library
  1651. /// The search for SDL bitcode files is consistent with how static host
  1652. /// libraries are discovered. That is, the -l option triggers a search for
  1653. /// files in a set of directories called the LINKPATH. The host library search
  1654. /// procedure looks for a specific filename in the LINKPATH. The filename for
  1655. /// a host library is lib<libname>.a or lib<libname>.so. For SDLs, there is an
  1656. /// ordered-set of filenames that are searched. We call this ordered-set of
  1657. /// filenames as SEARCH-ORDER. Since an SDL can either be device-type specific,
  1658. /// architecture specific, or generic across all architectures, a naming
  1659. /// convention and search order is used where the file name embeds the
  1660. /// architecture name <arch-name> (nvptx or amdgcn) and the GPU device type
  1661. /// <device-name> such as sm_30 and gfx906. <device-name> is absent in case of
  1662. /// device-independent SDLs. To reduce congestion in host library directories,
  1663. /// the search first looks for files in the “libdevice” subdirectory. SDLs that
  1664. /// are bc files begin with the prefix “lib”.
  1665. ///
  1666. /// Machine-code SDLs can also be managed as an archive (*.a file). The
  1667. /// convention has been to use the prefix “lib”. To avoid confusion with host
  1668. /// archive libraries, we use prefix "libbc-" for the bitcode SDL archives.
  1669. ///
  1670. bool tools::SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs,
  1671. llvm::opt::ArgStringList &CC1Args,
  1672. SmallVector<std::string, 8> LibraryPaths, std::string Lib,
  1673. StringRef Arch, StringRef Target, bool isBitCodeSDL,
  1674. bool postClangLink) {
  1675. SmallVector<std::string, 12> SDLs;
  1676. std::string LibDeviceLoc = "/libdevice";
  1677. std::string LibBcPrefix = "/libbc-";
  1678. std::string LibPrefix = "/lib";
  1679. if (isBitCodeSDL) {
  1680. // SEARCH-ORDER for Bitcode SDLs:
  1681. // libdevice/libbc-<libname>-<arch-name>-<device-type>.a
  1682. // libbc-<libname>-<arch-name>-<device-type>.a
  1683. // libdevice/libbc-<libname>-<arch-name>.a
  1684. // libbc-<libname>-<arch-name>.a
  1685. // libdevice/libbc-<libname>.a
  1686. // libbc-<libname>.a
  1687. // libdevice/lib<libname>-<arch-name>-<device-type>.bc
  1688. // lib<libname>-<arch-name>-<device-type>.bc
  1689. // libdevice/lib<libname>-<arch-name>.bc
  1690. // lib<libname>-<arch-name>.bc
  1691. // libdevice/lib<libname>.bc
  1692. // lib<libname>.bc
  1693. for (StringRef Base : {LibBcPrefix, LibPrefix}) {
  1694. const auto *Ext = Base.contains(LibBcPrefix) ? ".a" : ".bc";
  1695. for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
  1696. Twine(Lib + "-" + Arch).str(), Twine(Lib).str()}) {
  1697. SDLs.push_back(Twine(LibDeviceLoc + Base + Suffix + Ext).str());
  1698. SDLs.push_back(Twine(Base + Suffix + Ext).str());
  1699. }
  1700. }
  1701. } else {
  1702. // SEARCH-ORDER for Machine-code SDLs:
  1703. // libdevice/lib<libname>-<arch-name>-<device-type>.a
  1704. // lib<libname>-<arch-name>-<device-type>.a
  1705. // libdevice/lib<libname>-<arch-name>.a
  1706. // lib<libname>-<arch-name>.a
  1707. const auto *Ext = ".a";
  1708. for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
  1709. Twine(Lib + "-" + Arch).str()}) {
  1710. SDLs.push_back(Twine(LibDeviceLoc + LibPrefix + Suffix + Ext).str());
  1711. SDLs.push_back(Twine(LibPrefix + Suffix + Ext).str());
  1712. }
  1713. }
  1714. // The CUDA toolchain does not use a global device llvm-link before the LLVM
  1715. // backend generates ptx. So currently, the use of bitcode SDL for nvptx is
  1716. // only possible with post-clang-cc1 linking. Clang cc1 has a feature that
  1717. // will link libraries after clang compilation while the LLVM IR is still in
  1718. // memory. This utilizes a clang cc1 option called “-mlink-builtin-bitcode”.
  1719. // This is a clang -cc1 option that is generated by the clang driver. The
  1720. // option value must a full path to an existing file.
  1721. bool FoundSDL = false;
  1722. for (auto LPath : LibraryPaths) {
  1723. for (auto SDL : SDLs) {
  1724. auto FullName = Twine(LPath + SDL).str();
  1725. if (llvm::sys::fs::exists(FullName)) {
  1726. if (postClangLink)
  1727. CC1Args.push_back("-mlink-builtin-bitcode");
  1728. CC1Args.push_back(DriverArgs.MakeArgString(FullName));
  1729. FoundSDL = true;
  1730. break;
  1731. }
  1732. }
  1733. if (FoundSDL)
  1734. break;
  1735. }
  1736. return FoundSDL;
  1737. }
  1738. /// Search if a user provided archive file lib<libname>.a exists in any of
  1739. /// the library paths. If so, add a new command to clang-offload-bundler to
  1740. /// unbundle this archive and create a temporary device specific archive. Name
  1741. /// of this SDL is passed to the llvm-link tool.
  1742. bool tools::GetSDLFromOffloadArchive(
  1743. Compilation &C, const Driver &D, const Tool &T, const JobAction &JA,
  1744. const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs,
  1745. llvm::opt::ArgStringList &CC1Args, SmallVector<std::string, 8> LibraryPaths,
  1746. StringRef Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL,
  1747. bool postClangLink) {
  1748. // We don't support bitcode archive bundles for nvptx
  1749. if (isBitCodeSDL && Arch.contains("nvptx"))
  1750. return false;
  1751. bool FoundAOB = false;
  1752. std::string ArchiveOfBundles;
  1753. llvm::Triple Triple(D.getTargetTriple());
  1754. bool IsMSVC = Triple.isWindowsMSVCEnvironment();
  1755. auto Ext = IsMSVC ? ".lib" : ".a";
  1756. if (!Lib.startswith(":") && !Lib.startswith("-l")) {
  1757. if (llvm::sys::fs::exists(Lib)) {
  1758. ArchiveOfBundles = Lib;
  1759. FoundAOB = true;
  1760. }
  1761. } else {
  1762. if (Lib.startswith("-l"))
  1763. Lib = Lib.drop_front(2);
  1764. for (auto LPath : LibraryPaths) {
  1765. ArchiveOfBundles.clear();
  1766. SmallVector<std::string, 2> AOBFileNames;
  1767. auto LibFile =
  1768. (Lib.startswith(":") ? Lib.drop_front()
  1769. : IsMSVC ? Lib + Ext : "lib" + Lib + Ext)
  1770. .str();
  1771. for (auto Prefix : {"/libdevice/", "/"}) {
  1772. auto AOB = Twine(LPath + Prefix + LibFile).str();
  1773. if (llvm::sys::fs::exists(AOB)) {
  1774. ArchiveOfBundles = AOB;
  1775. FoundAOB = true;
  1776. break;
  1777. }
  1778. }
  1779. if (FoundAOB)
  1780. break;
  1781. }
  1782. }
  1783. if (!FoundAOB)
  1784. return false;
  1785. llvm::file_magic Magic;
  1786. auto EC = llvm::identify_magic(ArchiveOfBundles, Magic);
  1787. if (EC || Magic != llvm::file_magic::archive)
  1788. return false;
  1789. StringRef Prefix = isBitCodeSDL ? "libbc-" : "lib";
  1790. std::string OutputLib =
  1791. D.GetTemporaryPath(Twine(Prefix + llvm::sys::path::filename(Lib) + "-" +
  1792. Arch + "-" + Target)
  1793. .str(),
  1794. "a");
  1795. C.addTempFile(C.getArgs().MakeArgString(OutputLib));
  1796. ArgStringList CmdArgs;
  1797. SmallString<128> DeviceTriple;
  1798. DeviceTriple += Action::GetOffloadKindName(JA.getOffloadingDeviceKind());
  1799. DeviceTriple += '-';
  1800. std::string NormalizedTriple = T.getToolChain().getTriple().normalize();
  1801. DeviceTriple += NormalizedTriple;
  1802. if (!Target.empty()) {
  1803. DeviceTriple += '-';
  1804. DeviceTriple += Target;
  1805. }
  1806. std::string UnbundleArg("-unbundle");
  1807. std::string TypeArg("-type=a");
  1808. std::string InputArg("-input=" + ArchiveOfBundles);
  1809. std::string OffloadArg("-targets=" + std::string(DeviceTriple));
  1810. std::string OutputArg("-output=" + OutputLib);
  1811. const char *UBProgram = DriverArgs.MakeArgString(
  1812. T.getToolChain().GetProgramPath("clang-offload-bundler"));
  1813. ArgStringList UBArgs;
  1814. UBArgs.push_back(C.getArgs().MakeArgString(UnbundleArg));
  1815. UBArgs.push_back(C.getArgs().MakeArgString(TypeArg));
  1816. UBArgs.push_back(C.getArgs().MakeArgString(InputArg));
  1817. UBArgs.push_back(C.getArgs().MakeArgString(OffloadArg));
  1818. UBArgs.push_back(C.getArgs().MakeArgString(OutputArg));
  1819. // Add this flag to not exit from clang-offload-bundler if no compatible
  1820. // code object is found in heterogenous archive library.
  1821. std::string AdditionalArgs("-allow-missing-bundles");
  1822. UBArgs.push_back(C.getArgs().MakeArgString(AdditionalArgs));
  1823. // Add this flag to treat hip and hipv4 offload kinds as compatible with
  1824. // openmp offload kind while extracting code objects from a heterogenous
  1825. // archive library. Vice versa is also considered compatible.
  1826. std::string HipCompatibleArgs("-hip-openmp-compatible");
  1827. UBArgs.push_back(C.getArgs().MakeArgString(HipCompatibleArgs));
  1828. C.addCommand(std::make_unique<Command>(
  1829. JA, T, ResponseFileSupport::AtFileCurCP(), UBProgram, UBArgs, Inputs,
  1830. InputInfo(&JA, C.getArgs().MakeArgString(OutputLib))));
  1831. if (postClangLink)
  1832. CC1Args.push_back("-mlink-builtin-bitcode");
  1833. CC1Args.push_back(DriverArgs.MakeArgString(OutputLib));
  1834. return true;
  1835. }
  1836. // Wrapper function used by driver for adding SDLs during link phase.
  1837. void tools::AddStaticDeviceLibsLinking(Compilation &C, const Tool &T,
  1838. const JobAction &JA,
  1839. const InputInfoList &Inputs,
  1840. const llvm::opt::ArgList &DriverArgs,
  1841. llvm::opt::ArgStringList &CC1Args,
  1842. StringRef Arch, StringRef Target,
  1843. bool isBitCodeSDL, bool postClangLink) {
  1844. AddStaticDeviceLibs(&C, &T, &JA, &Inputs, C.getDriver(), DriverArgs, CC1Args,
  1845. Arch, Target, isBitCodeSDL, postClangLink);
  1846. }
  1847. // User defined Static Device Libraries(SDLs) can be passed to clang for
  1848. // offloading GPU compilers. Like static host libraries, the use of a SDL is
  1849. // specified with the -l command line option. The primary difference between
  1850. // host and SDLs is the filenames for SDLs (refer SEARCH-ORDER for Bitcode SDLs
  1851. // and SEARCH-ORDER for Machine-code SDLs for the naming convention).
  1852. // SDLs are of following types:
  1853. //
  1854. // * Bitcode SDLs: They can either be a *.bc file or an archive of *.bc files.
  1855. // For NVPTX, these libraries are post-clang linked following each
  1856. // compilation. For AMDGPU, these libraries are linked one time
  1857. // during the application link phase.
  1858. //
  1859. // * Machine-code SDLs: They are archive files. For AMDGPU, the process for
  1860. // machine code SDLs is still in development. But they will be linked
  1861. // by the LLVM tool lld.
  1862. //
  1863. // * Bundled objects that contain both host and device codes: Bundled objects
  1864. // may also contain library code compiled from source. For NVPTX, the
  1865. // bundle contains cubin. For AMDGPU, the bundle contains bitcode.
  1866. //
  1867. // For Bitcode and Machine-code SDLs, current compiler toolchains hardcode the
  1868. // inclusion of specific SDLs such as math libraries and the OpenMP device
  1869. // library libomptarget.
  1870. void tools::AddStaticDeviceLibs(Compilation *C, const Tool *T,
  1871. const JobAction *JA,
  1872. const InputInfoList *Inputs, const Driver &D,
  1873. const llvm::opt::ArgList &DriverArgs,
  1874. llvm::opt::ArgStringList &CC1Args,
  1875. StringRef Arch, StringRef Target,
  1876. bool isBitCodeSDL, bool postClangLink) {
  1877. SmallVector<std::string, 8> LibraryPaths;
  1878. // Add search directories from LIBRARY_PATH env variable
  1879. std::optional<std::string> LibPath =
  1880. llvm::sys::Process::GetEnv("LIBRARY_PATH");
  1881. if (LibPath) {
  1882. SmallVector<StringRef, 8> Frags;
  1883. const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
  1884. llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
  1885. for (StringRef Path : Frags)
  1886. LibraryPaths.emplace_back(Path.trim());
  1887. }
  1888. // Add directories from user-specified -L options
  1889. for (std::string Search_Dir : DriverArgs.getAllArgValues(options::OPT_L))
  1890. LibraryPaths.emplace_back(Search_Dir);
  1891. // Add path to lib-debug folders
  1892. SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
  1893. llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
  1894. LibraryPaths.emplace_back(DefaultLibPath.c_str());
  1895. // Build list of Static Device Libraries SDLs specified by -l option
  1896. llvm::SmallSet<std::string, 16> SDLNames;
  1897. static const StringRef HostOnlyArchives[] = {
  1898. "omp", "cudart", "m", "gcc", "gcc_s", "pthread", "hip_hcc"};
  1899. for (auto SDLName : DriverArgs.getAllArgValues(options::OPT_l)) {
  1900. if (!HostOnlyArchives->contains(SDLName)) {
  1901. SDLNames.insert(std::string("-l") + SDLName);
  1902. }
  1903. }
  1904. for (auto Input : DriverArgs.getAllArgValues(options::OPT_INPUT)) {
  1905. auto FileName = StringRef(Input);
  1906. // Clang treats any unknown file types as archives and passes them to the
  1907. // linker. Files with extension 'lib' are classified as TY_Object by clang
  1908. // but they are usually archives. It is OK if the file is not really an
  1909. // archive since GetSDLFromOffloadArchive will check the magic of the file
  1910. // and only unbundle it if it is really an archive.
  1911. const StringRef LibFileExt = ".lib";
  1912. if (!llvm::sys::path::has_extension(FileName) ||
  1913. types::lookupTypeForExtension(
  1914. llvm::sys::path::extension(FileName).drop_front()) ==
  1915. types::TY_INVALID ||
  1916. llvm::sys::path::extension(FileName) == LibFileExt)
  1917. SDLNames.insert(Input);
  1918. }
  1919. // The search stops as soon as an SDL file is found. The driver then provides
  1920. // the full filename of the SDL to the llvm-link command. If no SDL is found
  1921. // after searching each LINKPATH with SEARCH-ORDER, it is possible that an
  1922. // archive file lib<libname>.a exists and may contain bundled object files.
  1923. for (auto SDLName : SDLNames) {
  1924. // This is the only call to SDLSearch
  1925. if (!SDLSearch(D, DriverArgs, CC1Args, LibraryPaths, SDLName, Arch, Target,
  1926. isBitCodeSDL, postClangLink)) {
  1927. GetSDLFromOffloadArchive(*C, D, *T, *JA, *Inputs, DriverArgs, CC1Args,
  1928. LibraryPaths, SDLName, Arch, Target,
  1929. isBitCodeSDL, postClangLink);
  1930. }
  1931. }
  1932. }
  1933. static llvm::opt::Arg *
  1934. getAMDGPUCodeObjectArgument(const Driver &D, const llvm::opt::ArgList &Args) {
  1935. // The last of -mcode-object-v3, -mno-code-object-v3 and
  1936. // -mcode-object-version=<version> wins.
  1937. return Args.getLastArg(options::OPT_mcode_object_v3_legacy,
  1938. options::OPT_mno_code_object_v3_legacy,
  1939. options::OPT_mcode_object_version_EQ);
  1940. }
  1941. void tools::checkAMDGPUCodeObjectVersion(const Driver &D,
  1942. const llvm::opt::ArgList &Args) {
  1943. const unsigned MinCodeObjVer = 2;
  1944. const unsigned MaxCodeObjVer = 5;
  1945. // Emit warnings for legacy options even if they are overridden.
  1946. if (Args.hasArg(options::OPT_mno_code_object_v3_legacy))
  1947. D.Diag(diag::warn_drv_deprecated_arg) << "-mno-code-object-v3"
  1948. << "-mcode-object-version=2";
  1949. if (Args.hasArg(options::OPT_mcode_object_v3_legacy))
  1950. D.Diag(diag::warn_drv_deprecated_arg) << "-mcode-object-v3"
  1951. << "-mcode-object-version=3";
  1952. if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args)) {
  1953. if (CodeObjArg->getOption().getID() ==
  1954. options::OPT_mcode_object_version_EQ) {
  1955. unsigned CodeObjVer = MaxCodeObjVer;
  1956. auto Remnant =
  1957. StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
  1958. if (Remnant || CodeObjVer < MinCodeObjVer || CodeObjVer > MaxCodeObjVer)
  1959. D.Diag(diag::err_drv_invalid_int_value)
  1960. << CodeObjArg->getAsString(Args) << CodeObjArg->getValue();
  1961. }
  1962. }
  1963. }
  1964. unsigned tools::getAMDGPUCodeObjectVersion(const Driver &D,
  1965. const llvm::opt::ArgList &Args) {
  1966. unsigned CodeObjVer = 4; // default
  1967. if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args)) {
  1968. if (CodeObjArg->getOption().getID() ==
  1969. options::OPT_mno_code_object_v3_legacy) {
  1970. CodeObjVer = 2;
  1971. } else if (CodeObjArg->getOption().getID() ==
  1972. options::OPT_mcode_object_v3_legacy) {
  1973. CodeObjVer = 3;
  1974. } else {
  1975. StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
  1976. }
  1977. }
  1978. return CodeObjVer;
  1979. }
  1980. bool tools::haveAMDGPUCodeObjectVersionArgument(
  1981. const Driver &D, const llvm::opt::ArgList &Args) {
  1982. return getAMDGPUCodeObjectArgument(D, Args) != nullptr;
  1983. }
  1984. void tools::addMachineOutlinerArgs(const Driver &D,
  1985. const llvm::opt::ArgList &Args,
  1986. llvm::opt::ArgStringList &CmdArgs,
  1987. const llvm::Triple &Triple, bool IsLTO,
  1988. const StringRef PluginOptPrefix) {
  1989. auto addArg = [&, IsLTO](const Twine &Arg) {
  1990. if (IsLTO) {
  1991. assert(!PluginOptPrefix.empty() && "Cannot have empty PluginOptPrefix!");
  1992. CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + Arg));
  1993. } else {
  1994. CmdArgs.push_back("-mllvm");
  1995. CmdArgs.push_back(Args.MakeArgString(Arg));
  1996. }
  1997. };
  1998. if (Arg *A = Args.getLastArg(options::OPT_moutline,
  1999. options::OPT_mno_outline)) {
  2000. if (A->getOption().matches(options::OPT_moutline)) {
  2001. // We only support -moutline in AArch64 and ARM targets right now. If
  2002. // we're not compiling for these, emit a warning and ignore the flag.
  2003. // Otherwise, add the proper mllvm flags.
  2004. if (!(Triple.isARM() || Triple.isThumb() ||
  2005. Triple.getArch() == llvm::Triple::aarch64 ||
  2006. Triple.getArch() == llvm::Triple::aarch64_32)) {
  2007. D.Diag(diag::warn_drv_moutline_unsupported_opt) << Triple.getArchName();
  2008. } else {
  2009. addArg(Twine("-enable-machine-outliner"));
  2010. }
  2011. } else {
  2012. // Disable all outlining behaviour.
  2013. addArg(Twine("-enable-machine-outliner=never"));
  2014. }
  2015. }
  2016. }
  2017. void tools::addOpenMPDeviceRTL(const Driver &D,
  2018. const llvm::opt::ArgList &DriverArgs,
  2019. llvm::opt::ArgStringList &CC1Args,
  2020. StringRef BitcodeSuffix,
  2021. const llvm::Triple &Triple) {
  2022. SmallVector<StringRef, 8> LibraryPaths;
  2023. // Add path to clang lib / lib64 folder.
  2024. SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
  2025. llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
  2026. LibraryPaths.emplace_back(DefaultLibPath.c_str());
  2027. // Add user defined library paths from LIBRARY_PATH.
  2028. std::optional<std::string> LibPath =
  2029. llvm::sys::Process::GetEnv("LIBRARY_PATH");
  2030. if (LibPath) {
  2031. SmallVector<StringRef, 8> Frags;
  2032. const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
  2033. llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
  2034. for (StringRef Path : Frags)
  2035. LibraryPaths.emplace_back(Path.trim());
  2036. }
  2037. OptSpecifier LibomptargetBCPathOpt =
  2038. Triple.isAMDGCN() ? options::OPT_libomptarget_amdgpu_bc_path_EQ
  2039. : options::OPT_libomptarget_nvptx_bc_path_EQ;
  2040. StringRef ArchPrefix = Triple.isAMDGCN() ? "amdgpu" : "nvptx";
  2041. std::string LibOmpTargetName =
  2042. ("libomptarget-" + ArchPrefix + "-" + BitcodeSuffix + ".bc").str();
  2043. // First check whether user specifies bc library
  2044. if (const Arg *A = DriverArgs.getLastArg(LibomptargetBCPathOpt)) {
  2045. SmallString<128> LibOmpTargetFile(A->getValue());
  2046. if (llvm::sys::fs::exists(LibOmpTargetFile) &&
  2047. llvm::sys::fs::is_directory(LibOmpTargetFile)) {
  2048. llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
  2049. }
  2050. if (llvm::sys::fs::exists(LibOmpTargetFile)) {
  2051. CC1Args.push_back("-mlink-builtin-bitcode");
  2052. CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
  2053. } else {
  2054. D.Diag(diag::err_drv_omp_offload_target_bcruntime_not_found)
  2055. << LibOmpTargetFile;
  2056. }
  2057. } else {
  2058. bool FoundBCLibrary = false;
  2059. for (StringRef LibraryPath : LibraryPaths) {
  2060. SmallString<128> LibOmpTargetFile(LibraryPath);
  2061. llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
  2062. if (llvm::sys::fs::exists(LibOmpTargetFile)) {
  2063. CC1Args.push_back("-mlink-builtin-bitcode");
  2064. CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
  2065. FoundBCLibrary = true;
  2066. break;
  2067. }
  2068. }
  2069. if (!FoundBCLibrary)
  2070. D.Diag(diag::err_drv_omp_offload_target_missingbcruntime)
  2071. << LibOmpTargetName << ArchPrefix;
  2072. }
  2073. }
  2074. void tools::addHIPRuntimeLibArgs(const ToolChain &TC,
  2075. const llvm::opt::ArgList &Args,
  2076. llvm::opt::ArgStringList &CmdArgs) {
  2077. if (Args.hasArg(options::OPT_hip_link) &&
  2078. !Args.hasArg(options::OPT_nostdlib) &&
  2079. !Args.hasArg(options::OPT_no_hip_rt)) {
  2080. TC.AddHIPRuntimeLibArgs(Args, CmdArgs);
  2081. } else {
  2082. // Claim "no HIP libraries" arguments if any
  2083. for (auto *Arg : Args.filtered(options::OPT_no_hip_rt)) {
  2084. Arg->claim();
  2085. }
  2086. }
  2087. }