blob: a57c66403a28a773f7d2dd105bd3b2a31641206a [file] [log] [blame]
Nick Lewyckye47c2452010-09-23 23:48:20 +00001//===--- Driver.cpp - Clang GCC Compatible Driver -------------------------===//
Daniel Dunbar544ecd12009-03-02 19:59:07 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Daniel Dunbar544ecd12009-03-02 19:59:07 +00006//
7//===----------------------------------------------------------------------===//
8
Daniel Dunbar544ecd12009-03-02 19:59:07 +00009#include "clang/Driver/Driver.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000010#include "InputInfo.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000011#include "ToolChains/AMDGPU.h"
12#include "ToolChains/AVR.h"
Ed Schouten4dabea22017-06-25 08:29:09 +000013#include "ToolChains/Ananas.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000014#include "ToolChains/BareMetal.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000015#include "ToolChains/Clang.h"
16#include "ToolChains/CloudABI.h"
17#include "ToolChains/Contiki.h"
18#include "ToolChains/CrossWindows.h"
19#include "ToolChains/Cuda.h"
20#include "ToolChains/Darwin.h"
21#include "ToolChains/DragonFly.h"
22#include "ToolChains/FreeBSD.h"
23#include "ToolChains/Fuchsia.h"
24#include "ToolChains/Gnu.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000025#include "ToolChains/HIP.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000026#include "ToolChains/Haiku.h"
27#include "ToolChains/Hexagon.h"
Kristina Brooks77a4adc2018-11-29 03:49:14 +000028#include "ToolChains/Hurd.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000029#include "ToolChains/Lanai.h"
30#include "ToolChains/Linux.h"
Anton Korobeynikov93165d62019-01-15 19:44:05 +000031#include "ToolChains/MSP430.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000032#include "ToolChains/MSVC.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000033#include "ToolChains/MinGW.h"
34#include "ToolChains/Minix.h"
Konstantin Zhuravlyove37b32c2017-03-08 22:36:04 +000035#include "ToolChains/MipsLinux.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000036#include "ToolChains/Myriad.h"
37#include "ToolChains/NaCl.h"
38#include "ToolChains/NetBSD.h"
39#include "ToolChains/OpenBSD.h"
40#include "ToolChains/PS4CPU.h"
Qiu Chaofan19828e32019-04-23 05:50:24 +000041#include "ToolChains/PPCLinux.h"
Erik Pilkington46420b62018-09-27 20:36:28 +000042#include "ToolChains/RISCVToolchain.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000043#include "ToolChains/Solaris.h"
44#include "ToolChains/TCE.h"
45#include "ToolChains/WebAssembly.h"
46#include "ToolChains/XCore.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000047#include "clang/Basic/Version.h"
Alp Toker1d257e12014-06-04 03:28:55 +000048#include "clang/Config/config.h"
Daniel Dunbar1688f1a2009-03-12 07:58:46 +000049#include "clang/Driver/Action.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000050#include "clang/Driver/Compilation.h"
Daniel Dunbarc0b3e952009-03-12 08:55:43 +000051#include "clang/Driver/DriverDiagnostic.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000052#include "clang/Driver/Job.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000053#include "clang/Driver/Options.h"
Peter Collingbournea4ccff32015-02-20 20:30:56 +000054#include "clang/Driver/SanitizerArgs.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000055#include "clang/Driver/Tool.h"
56#include "clang/Driver/ToolChain.h"
Chris Lattnerce6c42f2011-03-23 04:04:01 +000057#include "llvm/ADT/ArrayRef.h"
Hans Wennborg6ddc6902013-07-27 00:23:45 +000058#include "llvm/ADT/STLExtras.h"
Justin Lebar62907612016-07-06 21:21:39 +000059#include "llvm/ADT/SmallSet.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000060#include "llvm/ADT/StringExtras.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000061#include "llvm/ADT/StringSet.h"
Hans Wennborg70850d82013-07-18 20:29:38 +000062#include "llvm/ADT/StringSwitch.h"
Nico Weberd637c052018-04-30 13:52:15 +000063#include "llvm/Config/llvm-config.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000064#include "llvm/Option/Arg.h"
65#include "llvm/Option/ArgList.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000066#include "llvm/Option/OptSpecifier.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000067#include "llvm/Option/OptTable.h"
68#include "llvm/Option/Option.h"
Serge Pavlov208ac652018-01-01 13:27:01 +000069#include "llvm/Support/CommandLine.h"
David Blaikie79000202011-09-23 05:57:42 +000070#include "llvm/Support/ErrorHandling.h"
Michael J. Spencerf28df4c2010-12-17 21:22:22 +000071#include "llvm/Support/FileSystem.h"
Fangrui Songd0028232018-10-10 00:15:33 +000072#include "llvm/Support/FormatVariadic.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000073#include "llvm/Support/Path.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000074#include "llvm/Support/PrettyStackTrace.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000075#include "llvm/Support/Process.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000076#include "llvm/Support/Program.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000077#include "llvm/Support/StringSaver.h"
Dimitry Andric81c40422017-06-06 21:54:21 +000078#include "llvm/Support/TargetRegistry.h"
Jonas Devliegherefc514902018-10-10 13:27:25 +000079#include "llvm/Support/VirtualFileSystem.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000080#include "llvm/Support/raw_ostream.h"
Dylan Noblesmith4f4e7452012-02-02 00:40:14 +000081#include <map>
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000082#include <memory>
Benjamin Kramercfeacf52016-05-27 14:27:13 +000083#include <utility>
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +000084#if LLVM_ON_UNIX
85#include <unistd.h> // getpid
Nick Desaulniers9d0df312018-10-15 17:39:00 +000086#include <sysexits.h> // EX_IOERR
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +000087#endif
Dylan Noblesmith86780e92012-02-01 14:25:28 +000088
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000089using namespace clang::driver;
Chris Lattnerada1c912009-03-26 05:56:24 +000090using namespace clang;
Reid Kleckner898229a2013-06-14 17:17:23 +000091using namespace llvm::opt;
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000092
Nico Weber0abcafd2019-01-31 22:15:32 +000093// static
94std::string Driver::GetResourcesPath(StringRef BinaryPath,
95 StringRef CustomResourceDir) {
96 // Since the resource directory is embedded in the module hash, it's important
97 // that all places that need it call this function, so that they get the
98 // exact same string ("a/../b/" and "b/" get different hashes, for example).
99
100 // Dir is bin/ or lib/, depending on where BinaryPath is.
101 std::string Dir = llvm::sys::path::parent_path(BinaryPath);
102
103 SmallString<128> P(Dir);
104 if (CustomResourceDir != "") {
105 llvm::sys::path::append(P, CustomResourceDir);
106 } else {
107 // On Windows, libclang.dll is in bin/.
108 // On non-Windows, libclang.so/.dylib is in lib/.
109 // With a static-library build of libclang, LibClangPath will contain the
110 // path of the embedding binary, which for LLVM binaries will be in bin/.
111 // ../lib gets us to lib/ in both cases.
112 P = llvm::sys::path::parent_path(Dir);
113 llvm::sys::path::append(P, Twine("lib") + CLANG_LIBDIR_SUFFIX, "clang",
114 CLANG_VERSION_STRING);
115 }
116
117 return P.str();
118}
119
Petr Hosekdd38d932018-05-29 22:35:39 +0000120Driver::Driver(StringRef ClangExecutable, StringRef TargetTriple,
Benjamin Kramerd45b2052015-10-07 15:48:01 +0000121 DiagnosticsEngine &Diags,
Jonas Devliegherefc514902018-10-10 13:27:25 +0000122 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)
Benjamin Kramercfeacf52016-05-27 14:27:13 +0000123 : Opts(createDriverOptTable()), Diags(Diags), VFS(std::move(VFS)),
124 Mode(GCCMode), SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
125 LTOMode(LTOK_None), ClangExecutable(ClangExecutable),
Alex Lorenz045c5142018-04-07 00:03:27 +0000126 SysRoot(DEFAULT_SYSROOT), DriverTitle("clang LLVM compiler"),
127 CCPrintOptionsFilename(nullptr), CCPrintHeadersFilename(nullptr),
128 CCLogDiagnosticsFilename(nullptr), CCCPrintBindings(false),
129 CCPrintOptions(false), CCPrintHeaders(false), CCLogDiagnostics(false),
Petr Hosekdd38d932018-05-29 22:35:39 +0000130 CCGenDiagnostics(false), TargetTriple(TargetTriple),
Alex Lorenz045c5142018-04-07 00:03:27 +0000131 CCCGenericGCCName(""), Saver(Alloc), CheckInputsExist(true),
Erich Keane0a6b5b62018-12-04 14:34:09 +0000132 GenReproducer(false), SuppressMissingInputWarning(false) {
Daniel Dunbar3f3e2cd2010-01-20 02:35:16 +0000133
Benjamin Kramerd45b2052015-10-07 15:48:01 +0000134 // Provide a sane fallback if no VFS is specified.
135 if (!this->VFS)
Michael J. Spencer7e48b402019-05-28 22:21:47 +0000136 this->VFS = llvm::vfs::createPhysicalFileSystem().release();
Benjamin Kramerd45b2052015-10-07 15:48:01 +0000137
Sumanth Gundapaneni3a1592942015-03-03 20:43:12 +0000138 Name = llvm::sys::path::filename(ClangExecutable);
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000139 Dir = llvm::sys::path::parent_path(ClangExecutable);
Benjamin Kramerf420dda2015-10-13 15:19:32 +0000140 InstalledDir = Dir; // Provide a sensible default installed dir.
Bob Wilsona20a1da2013-03-23 05:17:59 +0000141
Serge Pavlov208ac652018-01-01 13:27:01 +0000142#if defined(CLANG_CONFIG_FILE_SYSTEM_DIR)
143 SystemConfigDir = CLANG_CONFIG_FILE_SYSTEM_DIR;
144#endif
145#if defined(CLANG_CONFIG_FILE_USER_DIR)
146 UserConfigDir = CLANG_CONFIG_FILE_USER_DIR;
147#endif
148
Bob Wilsona20a1da2013-03-23 05:17:59 +0000149 // Compute the path to the resource directory.
Nico Weber0abcafd2019-01-31 22:15:32 +0000150 ResourceDir = GetResourcesPath(ClangExecutable, CLANG_RESOURCE_DIR);
Daniel Dunbar544ecd12009-03-02 19:59:07 +0000151}
152
Zachary Turneraff19c32016-08-12 17:47:52 +0000153void Driver::ParseDriverMode(StringRef ProgramName,
154 ArrayRef<const char *> Args) {
Martin Storsjo1fab23d2018-04-25 21:23:59 +0000155 if (ClangNameParts.isEmpty())
156 ClangNameParts = ToolChain::getTargetAndModeFromProgramName(ProgramName);
Serge Pavlov4e769842017-08-29 05:22:26 +0000157 setDriverModeFromOption(ClangNameParts.DriverMode);
Hans Wennborg70850d82013-07-18 20:29:38 +0000158
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000159 for (const char *ArgPtr : Args) {
Erich Keane258f0592018-02-07 00:19:58 +0000160 // Ignore nullptrs, they are the response file's EOL markers.
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000161 if (ArgPtr == nullptr)
Reid Kleckneraf5fd6a2014-08-22 19:29:30 +0000162 continue;
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000163 const StringRef Arg = ArgPtr;
Zachary Turneraff19c32016-08-12 17:47:52 +0000164 setDriverModeFromOption(Arg);
Hans Wennborg70850d82013-07-18 20:29:38 +0000165 }
166}
167
Zachary Turneraff19c32016-08-12 17:47:52 +0000168void Driver::setDriverModeFromOption(StringRef Opt) {
169 const std::string OptName =
170 getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
171 if (!Opt.startswith(OptName))
172 return;
173 StringRef Value = Opt.drop_front(OptName.size());
174
Erich Keane2908a042018-02-12 17:47:01 +0000175 if (auto M = llvm::StringSwitch<llvm::Optional<DriverMode>>(Value)
176 .Case("gcc", GCCMode)
177 .Case("g++", GXXMode)
178 .Case("cpp", CPPMode)
179 .Case("cl", CLMode)
180 .Default(None))
181 Mode = *M;
Zachary Turneraff19c32016-08-12 17:47:52 +0000182 else
183 Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
184}
185
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000186InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings,
Hans Wennborg797004d2018-11-08 11:27:04 +0000187 bool IsClCompatMode,
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000188 bool &ContainsError) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000189 llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000190 ContainsError = false;
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000191
192 unsigned IncludedFlagsBitmask;
193 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000194 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Hans Wennborg797004d2018-11-08 11:27:04 +0000195 getIncludeExcludeOptionFlagMasks(IsClCompatMode);
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000196
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000197 unsigned MissingArgIndex, MissingArgCount;
David Blaikie69a1d8c2015-06-22 22:07:27 +0000198 InputArgList Args =
David Blaikie6d492ad2015-06-21 06:32:36 +0000199 getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
200 IncludedFlagsBitmask, ExcludedFlagsBitmask);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000201
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000202 // Check for missing argument error.
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000203 if (MissingArgCount) {
204 Diag(diag::err_drv_missing_argument)
David Blaikie69a1d8c2015-06-22 22:07:27 +0000205 << Args.getArgString(MissingArgIndex) << MissingArgCount;
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000206 ContainsError |=
207 Diags.getDiagnosticLevel(diag::err_drv_missing_argument,
208 SourceLocation()) > DiagnosticsEngine::Warning;
209 }
Daniel Dunbar65229332009-03-13 11:38:42 +0000210
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000211 // Check for unsupported options.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000212 for (const Arg *A : Args) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +0000213 if (A->getOption().hasFlag(options::Unsupported)) {
Brian Gesiak24910762018-01-06 00:25:40 +0000214 unsigned DiagID;
215 auto ArgString = A->getAsString(Args);
216 std::string Nearest;
217 if (getOpts().findNearest(
218 ArgString, Nearest, IncludedFlagsBitmask,
219 ExcludedFlagsBitmask | options::Unsupported) > 1) {
220 DiagID = diag::err_drv_unsupported_opt;
221 Diag(DiagID) << ArgString;
222 } else {
223 DiagID = diag::err_drv_unsupported_opt_with_suggestion;
224 Diag(DiagID) << ArgString << Nearest;
225 }
226 ContainsError |= Diags.getDiagnosticLevel(DiagID, SourceLocation()) >
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000227 DiagnosticsEngine::Warning;
Daniel Dunbard8500f32009-03-22 23:26:43 +0000228 continue;
229 }
Chad Rosierce975d92012-02-22 17:55:22 +0000230
231 // Warn about -mcpu= without an argument.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000232 if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000233 Diag(diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
234 ContainsError |= Diags.getDiagnosticLevel(
235 diag::warn_drv_empty_joined_argument,
236 SourceLocation()) > DiagnosticsEngine::Warning;
Chad Rosierce975d92012-02-22 17:55:22 +0000237 }
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000238 }
239
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000240 for (const Arg *A : Args.filtered(options::OPT_UNKNOWN)) {
Brian Gesiak24910762018-01-06 00:25:40 +0000241 unsigned DiagID;
242 auto ArgString = A->getAsString(Args);
243 std::string Nearest;
244 if (getOpts().findNearest(
245 ArgString, Nearest, IncludedFlagsBitmask, ExcludedFlagsBitmask) > 1) {
246 DiagID = IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl
247 : diag::err_drv_unknown_argument;
248 Diags.Report(DiagID) << ArgString;
249 } else {
Simon Atanasyan27c0f202019-04-02 18:03:15 +0000250 DiagID = IsCLMode()
251 ? diag::warn_drv_unknown_argument_clang_cl_with_suggestion
252 : diag::err_drv_unknown_argument_with_suggestion;
Brian Gesiak24910762018-01-06 00:25:40 +0000253 Diags.Report(DiagID) << ArgString << Nearest;
254 }
255 ContainsError |= Diags.getDiagnosticLevel(DiagID, SourceLocation()) >
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000256 DiagnosticsEngine::Warning;
257 }
Rafael Espindola8a2d4962013-09-23 23:55:25 +0000258
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000259 return Args;
260}
261
Chad Rosier7742b5d2011-07-27 23:36:45 +0000262// Determine which compilation mode we are in. We look for options which
263// affect the phase, starting with the earliest phases, and record which
264// option we used to determine the final phase.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000265phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
266 Arg **FinalPhaseArg) const {
Craig Topper92fc2df2014-05-17 16:56:41 +0000267 Arg *PhaseArg = nullptr;
Chad Rosier7742b5d2011-07-27 23:36:45 +0000268 phases::ID FinalPhase;
Eric Christopherf901e852011-08-17 22:59:59 +0000269
Hans Wennborge50cec32014-06-13 20:59:54 +0000270 // -{E,EP,P,M,MM} only run the preprocessor.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000271 if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
Hans Wennborge50cec32014-06-13 20:59:54 +0000272 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
Hans Wennborge0053472013-12-20 18:40:46 +0000273 (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
274 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000275 FinalPhase = phases::Preprocess;
Eric Christopherf901e852011-08-17 22:59:59 +0000276
Richard Smithdd4ad3d2016-08-30 19:06:26 +0000277 // --precompile only runs up to precompilation.
278 } else if ((PhaseArg = DAL.getLastArg(options::OPT__precompile))) {
279 FinalPhase = phases::Precompile;
280
Bob Wilson23a55f12014-12-21 07:00:00 +0000281 // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
Chad Rosier7742b5d2011-07-27 23:36:45 +0000282 } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000283 (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000284 (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000285 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
Fariborz Jahanian73223bb2012-04-02 15:59:19 +0000286 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
Ted Kremenekf7639e12012-03-06 20:06:33 +0000287 (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000288 (PhaseArg = DAL.getLastArg(options::OPT__analyze,
Chad Rosier1aeb15a2012-03-06 23:14:35 +0000289 options::OPT__analyze_auto)) ||
Bob Wilson23a55f12014-12-21 07:00:00 +0000290 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000291 FinalPhase = phases::Compile;
292
Bob Wilson23a55f12014-12-21 07:00:00 +0000293 // -S only runs up to the backend.
294 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
295 FinalPhase = phases::Backend;
296
Artem Belevich4242f412015-07-28 21:01:21 +0000297 // -c compilation only runs up to the assembler.
298 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000299 FinalPhase = phases::Assemble;
300
301 // Otherwise do everything.
302 } else
303 FinalPhase = phases::Link;
304
305 if (FinalPhaseArg)
306 *FinalPhaseArg = PhaseArg;
307
308 return FinalPhase;
309}
310
David Blaikie0aaa7622017-01-13 17:34:15 +0000311static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
Martin Storsjo665c7a42018-05-04 06:05:58 +0000312 StringRef Value, bool Claim = true) {
David Blaikie0aaa7622017-01-13 17:34:15 +0000313 Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
Hans Wennborged1d0722013-08-13 21:32:29 +0000314 Args.getBaseArgs().MakeIndex(Value), Value.data());
Hans Wennborg55362852014-05-02 22:55:30 +0000315 Args.AddSynthesizedArg(A);
Martin Storsjo665c7a42018-05-04 06:05:58 +0000316 if (Claim)
317 A->claim();
Hans Wennborged1d0722013-08-13 21:32:29 +0000318 return A;
319}
320
Daniel Dunbar775d4062010-06-11 22:00:26 +0000321DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
322 DerivedArgList *DAL = new DerivedArgList(Args);
323
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000324 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
Dan Albertf5ffa1a2018-12-18 23:29:35 +0000325 bool HasNostdlibxx = Args.hasArg(options::OPT_nostdlibxx);
Nirav Daveb0bb6142015-11-24 16:07:21 +0000326 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000327 for (Arg *A : Args) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000328 // Unfortunately, we have to parse some forwarding options (-Xassembler,
329 // -Xlinker, -Xpreprocessor) because we either integrate their functionality
330 // (assembler and preprocessor), or bypass a previous driver ('collect2').
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000331
332 // Rewrite linker options, to replace --no-demangle with a custom internal
333 // option.
334 if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
335 A->getOption().matches(options::OPT_Xlinker)) &&
336 A->containsValue("--no-demangle")) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000337 // Add the rewritten no-demangle argument.
338 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
339
340 // Add the remaining values as Xlinker arguments.
Benjamin Kramer72e64312015-09-24 14:48:49 +0000341 for (StringRef Val : A->getValues())
Douglas Katzmana34b7bf2015-06-30 19:32:57 +0000342 if (Val != "--no-demangle")
343 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000344
345 continue;
346 }
347
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000348 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
349 // some build systems. We don't try to be complete here because we don't
350 // care to encourage this usage model.
351 if (A->getOption().matches(options::OPT_Wp_COMMA) &&
Richard Smithbd55daf2012-11-01 04:30:05 +0000352 (A->getValue(0) == StringRef("-MD") ||
353 A->getValue(0) == StringRef("-MMD"))) {
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000354 // Rewrite to -MD/-MMD along with -MF.
Richard Smithbd55daf2012-11-01 04:30:05 +0000355 if (A->getValue(0) == StringRef("-MD"))
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000356 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
357 else
358 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
Michael J. Spencer70d85be2012-11-07 23:37:14 +0000359 if (A->getNumValues() == 2)
360 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
361 A->getValue(1));
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000362 continue;
363 }
364
Shantonu Senafeb03b2010-09-17 18:39:08 +0000365 // Rewrite reserved library names.
366 if (A->getOption().matches(options::OPT_l)) {
Richard Smithbd55daf2012-11-01 04:30:05 +0000367 StringRef Value = A->getValue();
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000368
Shantonu Senafeb03b2010-09-17 18:39:08 +0000369 // Rewrite unless -nostdlib is present.
Dan Albertf5ffa1a2018-12-18 23:29:35 +0000370 if (!HasNostdlib && !HasNodefaultlib && !HasNostdlibxx &&
371 Value == "stdc++") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000372 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000373 continue;
374 }
Shantonu Senafeb03b2010-09-17 18:39:08 +0000375
376 // Rewrite unconditionally.
377 if (Value == "cc_kext") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000378 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
Shantonu Senafeb03b2010-09-17 18:39:08 +0000379 continue;
380 }
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000381 }
382
Hans Wennborged1d0722013-08-13 21:32:29 +0000383 // Pick up inputs via the -- option.
384 if (A->getOption().matches(options::OPT__DASH_DASH)) {
385 A->claim();
Benjamin Kramer72e64312015-09-24 14:48:49 +0000386 for (StringRef Val : A->getValues())
Martin Storsjo665c7a42018-05-04 06:05:58 +0000387 DAL->append(MakeInputArg(*DAL, *Opts, Val, false));
Hans Wennborged1d0722013-08-13 21:32:29 +0000388 continue;
389 }
390
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000391 DAL->append(A);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000392 }
Daniel Dunbar775d4062010-06-11 22:00:26 +0000393
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000394 // Enforce -static if -miamcu is present.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000395 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
396 DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000397
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000398// Add a default value of -mlinker-version=, if one was given and the user
399// didn't specify one.
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000400#if defined(HOST_LINK_VERSION)
Tim Northover018578c2015-06-12 19:21:35 +0000401 if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
402 strlen(HOST_LINK_VERSION) > 0) {
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000403 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
404 HOST_LINK_VERSION);
Daniel Dunbarb613ffc2010-08-17 22:32:45 +0000405 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000406 }
407#endif
408
Daniel Dunbar775d4062010-06-11 22:00:26 +0000409 return DAL;
410}
411
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000412/// Compute target triple from args.
Artem Belevich959e0542015-07-10 19:47:55 +0000413///
414/// This routine provides the logic to compute a target triple from various
415/// args passed to the driver and the default triple string.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000416static llvm::Triple computeTargetTriple(const Driver &D,
Petr Hosekdd38d932018-05-29 22:35:39 +0000417 StringRef TargetTriple,
Artem Belevich959e0542015-07-10 19:47:55 +0000418 const ArgList &Args,
419 StringRef DarwinArchName = "") {
420 // FIXME: Already done in Compilation *Driver::BuildCompilation
421 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +0000422 TargetTriple = A->getValue();
Artem Belevich959e0542015-07-10 19:47:55 +0000423
Petr Hosekdd38d932018-05-29 22:35:39 +0000424 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Artem Belevich959e0542015-07-10 19:47:55 +0000425
Kristina Brooks77a4adc2018-11-29 03:49:14 +0000426 // GNU/Hurd's triples should have been -hurd-gnu*, but were historically made
427 // -gnu* only, and we can not change this, so we have to detect that case as
428 // being the Hurd OS.
429 if (TargetTriple.find("-unknown-gnu") != StringRef::npos ||
430 TargetTriple.find("-pc-gnu") != StringRef::npos)
431 Target.setOSName("hurd");
432
Artem Belevich959e0542015-07-10 19:47:55 +0000433 // Handle Apple-specific options available here.
434 if (Target.isOSBinFormatMachO()) {
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000435 // If an explicit Darwin arch name is given, that trumps all.
Artem Belevich959e0542015-07-10 19:47:55 +0000436 if (!DarwinArchName.empty()) {
437 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
438 return Target;
439 }
440
441 // Handle the Darwin '-arch' flag.
442 if (Arg *A = Args.getLastArg(options::OPT_arch)) {
443 StringRef ArchName = A->getValue();
444 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
445 }
446 }
447
448 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
449 // '-mbig-endian'/'-EB'.
450 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
451 options::OPT_mbig_endian)) {
452 if (A->getOption().matches(options::OPT_mlittle_endian)) {
453 llvm::Triple LE = Target.getLittleEndianArchVariant();
454 if (LE.getArch() != llvm::Triple::UnknownArch)
455 Target = std::move(LE);
456 } else {
457 llvm::Triple BE = Target.getBigEndianArchVariant();
458 if (BE.getArch() != llvm::Triple::UnknownArch)
459 Target = std::move(BE);
460 }
461 }
462
463 // Skip further flag support on OSes which don't support '-m32' or '-m64'.
Douglas Katzman15a63ed2015-08-12 18:36:12 +0000464 if (Target.getArch() == llvm::Triple::tce ||
465 Target.getOS() == llvm::Triple::Minix)
Artem Belevich959e0542015-07-10 19:47:55 +0000466 return Target;
467
468 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000469 Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
470 options::OPT_m32, options::OPT_m16);
471 if (A) {
Artem Belevich959e0542015-07-10 19:47:55 +0000472 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
473
474 if (A->getOption().matches(options::OPT_m64)) {
475 AT = Target.get64BitArchVariant().getArch();
476 if (Target.getEnvironment() == llvm::Triple::GNUX32)
477 Target.setEnvironment(llvm::Triple::GNU);
478 } else if (A->getOption().matches(options::OPT_mx32) &&
479 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
480 AT = llvm::Triple::x86_64;
481 Target.setEnvironment(llvm::Triple::GNUX32);
482 } else if (A->getOption().matches(options::OPT_m32)) {
483 AT = Target.get32BitArchVariant().getArch();
484 if (Target.getEnvironment() == llvm::Triple::GNUX32)
485 Target.setEnvironment(llvm::Triple::GNU);
486 } else if (A->getOption().matches(options::OPT_m16) &&
487 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
488 AT = llvm::Triple::x86;
489 Target.setEnvironment(llvm::Triple::CODE16);
490 }
491
492 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
493 Target.setArch(AT);
494 }
495
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000496 // Handle -miamcu flag.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000497 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
498 if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
499 D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
500 << Target.str();
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000501
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000502 if (A && !A->getOption().matches(options::OPT_m32))
503 D.Diag(diag::err_drv_argument_not_allowed_with)
504 << "-miamcu" << A->getBaseArg().getAsString(Args);
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000505
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000506 Target.setArch(llvm::Triple::x86);
507 Target.setArchName("i586");
508 Target.setEnvironment(llvm::Triple::UnknownEnvironment);
509 Target.setEnvironmentName("");
510 Target.setOS(llvm::Triple::ELFIAMCU);
511 Target.setVendor(llvm::Triple::UnknownVendor);
512 Target.setVendorName("intel");
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000513 }
514
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000515 // If target is MIPS adjust the target triple
516 // accordingly to provided ABI name.
517 A = Args.getLastArg(options::OPT_mabi_EQ);
Simon Atanasyane60eae42018-10-16 10:19:06 +0000518 if (A && Target.isMIPS()) {
519 StringRef ABIName = A->getValue();
520 if (ABIName == "32") {
521 Target = Target.get32BitArchVariant();
522 if (Target.getEnvironment() == llvm::Triple::GNUABI64 ||
523 Target.getEnvironment() == llvm::Triple::GNUABIN32)
524 Target.setEnvironment(llvm::Triple::GNU);
525 } else if (ABIName == "n32") {
526 Target = Target.get64BitArchVariant();
527 if (Target.getEnvironment() == llvm::Triple::GNU ||
528 Target.getEnvironment() == llvm::Triple::GNUABI64)
529 Target.setEnvironment(llvm::Triple::GNUABIN32);
530 } else if (ABIName == "64") {
531 Target = Target.get64BitArchVariant();
532 if (Target.getEnvironment() == llvm::Triple::GNU ||
533 Target.getEnvironment() == llvm::Triple::GNUABIN32)
534 Target.setEnvironment(llvm::Triple::GNUABI64);
535 }
536 }
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000537
Artem Belevich959e0542015-07-10 19:47:55 +0000538 return Target;
539}
540
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000541// Parse the LTO options and record the type of LTO compilation
Teresa Johnson945bc502015-10-15 20:35:53 +0000542// based on which -f(no-)?lto(=.*)? option occurs last.
543void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
544 LTOMode = LTOK_None;
545 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
546 options::OPT_fno_lto, false))
547 return;
548
549 StringRef LTOName("full");
550
551 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
Teresa Johnson6ef80dc2015-11-02 18:03:12 +0000552 if (A)
553 LTOName = A->getValue();
Teresa Johnson945bc502015-10-15 20:35:53 +0000554
555 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
556 .Case("full", LTOK_Full)
557 .Case("thin", LTOK_Thin)
558 .Default(LTOK_Unknown);
559
560 if (LTOMode == LTOK_Unknown) {
561 assert(A);
562 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
563 << A->getValue();
564 }
565}
566
Samuel Antao39f9da22016-10-27 16:38:05 +0000567/// Compute the desired OpenMP runtime from the flags provided.
568Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
569 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
570
571 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
572 if (A)
573 RuntimeName = A->getValue();
574
575 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
576 .Case("libomp", OMPRT_OMP)
577 .Case("libgomp", OMPRT_GOMP)
578 .Case("libiomp5", OMPRT_IOMP5)
579 .Default(OMPRT_Unknown);
580
581 if (RT == OMPRT_Unknown) {
582 if (A)
583 Diag(diag::err_drv_unsupported_option_argument)
584 << A->getOption().getName() << A->getValue();
585 else
586 // FIXME: We could use a nicer diagnostic here.
587 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
588 }
589
590 return RT;
591}
592
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000593void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
594 InputList &Inputs) {
595
596 //
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000597 // CUDA/HIP
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000598 //
Yaxun Liuf6144222018-05-30 00:53:50 +0000599 // We need to generate a CUDA/HIP toolchain if any of the inputs has a CUDA
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000600 // or HIP type. However, mixed CUDA/HIP compilation is not supported.
601 bool IsCuda =
602 llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000603 return types::isCuda(I.first);
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000604 });
605 bool IsHIP =
606 llvm::any_of(Inputs,
607 [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
608 return types::isHIP(I.first);
609 }) ||
610 C.getInputArgs().hasArg(options::OPT_hip_link);
611 if (IsCuda && IsHIP) {
612 Diag(clang::diag::err_drv_mix_cuda_hip);
613 return;
614 }
Yaxun Liuf6144222018-05-30 00:53:50 +0000615 if (IsCuda) {
Justin Lebar66c4fd72016-11-18 00:41:22 +0000616 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
617 const llvm::Triple &HostTriple = HostTC->getTriple();
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000618 StringRef DeviceTripleStr;
Yaxun Liuf6144222018-05-30 00:53:50 +0000619 auto OFK = Action::OFK_Cuda;
620 DeviceTripleStr =
621 HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda" : "nvptx-nvidia-cuda";
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000622 llvm::Triple CudaTriple(DeviceTripleStr);
Yaxun Liuf6144222018-05-30 00:53:50 +0000623 // Use the CUDA and host triples as the key into the ToolChains map,
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000624 // because the device toolchain we create depends on both.
David Blaikie6ad71012017-01-13 18:53:43 +0000625 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
Justin Lebar66c4fd72016-11-18 00:41:22 +0000626 if (!CudaTC) {
David Blaikie6ad71012017-01-13 18:53:43 +0000627 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000628 *this, CudaTriple, *HostTC, C.getInputArgs(), OFK);
Justin Lebar66c4fd72016-11-18 00:41:22 +0000629 }
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000630 C.addOffloadDeviceToolChain(CudaTC.get(), OFK);
Yaxun Liuf6144222018-05-30 00:53:50 +0000631 } else if (IsHIP) {
632 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
633 const llvm::Triple &HostTriple = HostTC->getTriple();
634 StringRef DeviceTripleStr;
635 auto OFK = Action::OFK_HIP;
636 DeviceTripleStr = "amdgcn-amd-amdhsa";
637 llvm::Triple HIPTriple(DeviceTripleStr);
638 // Use the HIP and host triples as the key into the ToolChains map,
639 // because the device toolchain we create depends on both.
640 auto &HIPTC = ToolChains[HIPTriple.str() + "/" + HostTriple.str()];
641 if (!HIPTC) {
642 HIPTC = llvm::make_unique<toolchains::HIPToolChain>(
643 *this, HIPTriple, *HostTC, C.getInputArgs());
644 }
645 C.addOffloadDeviceToolChain(HIPTC.get(), OFK);
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000646 }
647
648 //
Samuel Antao39f9da22016-10-27 16:38:05 +0000649 // OpenMP
650 //
651 // We need to generate an OpenMP toolchain if the user specified targets with
652 // the -fopenmp-targets option.
653 if (Arg *OpenMPTargets =
654 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
655 if (OpenMPTargets->getNumValues()) {
656 // We expect that -fopenmp-targets is always used in conjunction with the
657 // option -fopenmp specifying a valid runtime with offloading support,
658 // i.e. libomp or libiomp.
659 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
660 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
661 options::OPT_fno_openmp, false);
662 if (HasValidOpenMPRuntime) {
663 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
664 HasValidOpenMPRuntime =
665 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
666 }
667
668 if (HasValidOpenMPRuntime) {
669 llvm::StringMap<const char *> FoundNormalizedTriples;
670 for (const char *Val : OpenMPTargets->getValues()) {
671 llvm::Triple TT(Val);
672 std::string NormalizedName = TT.normalize();
673
674 // Make sure we don't have a duplicate triple.
675 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
676 if (Duplicate != FoundNormalizedTriples.end()) {
677 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
678 << Val << Duplicate->second;
679 continue;
680 }
681
682 // Store the current triple so that we can check for duplicates in the
683 // following iterations.
684 FoundNormalizedTriples[NormalizedName] = Val;
685
686 // If the specified target is invalid, emit a diagnostic.
687 if (TT.getArch() == llvm::Triple::UnknownArch)
688 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
689 else {
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000690 const ToolChain *TC;
691 // CUDA toolchains have to be selected differently. They pair host
692 // and device in their implementation.
693 if (TT.isNVPTX()) {
694 const ToolChain *HostTC =
695 C.getSingleOffloadToolChain<Action::OFK_Host>();
696 assert(HostTC && "Host toolchain should be always defined.");
697 auto &CudaTC =
Gheorghe-Teodor Bercea52898432017-08-09 01:02:19 +0000698 ToolChains[TT.str() + "/" + HostTC->getTriple().normalize()];
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000699 if (!CudaTC)
700 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Gheorghe-Teodor Bercea2c926932017-08-08 14:33:05 +0000701 *this, TT, *HostTC, C.getInputArgs(), Action::OFK_OpenMP);
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000702 TC = CudaTC.get();
703 } else
704 TC = &getToolChain(C.getInputArgs(), TT);
705 C.addOffloadDeviceToolChain(TC, Action::OFK_OpenMP);
Samuel Antao39f9da22016-10-27 16:38:05 +0000706 }
707 }
708 } else
709 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
710 } else
711 Diag(clang::diag::warn_drv_empty_joined_argument)
712 << OpenMPTargets->getAsString(C.getInputArgs());
713 }
714
715 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000716 // TODO: Add support for other offloading programming models here.
717 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000718}
719
Serge Pavlov208ac652018-01-01 13:27:01 +0000720/// Looks the given directories for the specified file.
721///
722/// \param[out] FilePath File path, if the file was found.
723/// \param[in] Dirs Directories used for the search.
724/// \param[in] FileName Name of the file to search for.
725/// \return True if file was found.
726///
727/// Looks for file specified by FileName sequentially in directories specified
728/// by Dirs.
729///
730static bool searchForFile(SmallVectorImpl<char> &FilePath,
731 ArrayRef<std::string> Dirs,
732 StringRef FileName) {
733 SmallString<128> WPath;
734 for (const StringRef &Dir : Dirs) {
735 if (Dir.empty())
736 continue;
737 WPath.clear();
738 llvm::sys::path::append(WPath, Dir, FileName);
739 llvm::sys::path::native(WPath);
740 if (llvm::sys::fs::is_regular_file(WPath)) {
741 FilePath = std::move(WPath);
742 return true;
743 }
744 }
745 return false;
746}
747
748bool Driver::readConfigFile(StringRef FileName) {
749 // Try reading the given file.
750 SmallVector<const char *, 32> NewCfgArgs;
751 if (!llvm::cl::readConfigFile(FileName, Saver, NewCfgArgs)) {
752 Diag(diag::err_drv_cannot_read_config_file) << FileName;
753 return true;
754 }
755
756 // Read options from config file.
757 llvm::SmallString<128> CfgFileName(FileName);
758 llvm::sys::path::native(CfgFileName);
759 ConfigFile = CfgFileName.str();
760 bool ContainErrors;
761 CfgOptions = llvm::make_unique<InputArgList>(
Hans Wennborg797004d2018-11-08 11:27:04 +0000762 ParseArgStrings(NewCfgArgs, IsCLMode(), ContainErrors));
Serge Pavlov208ac652018-01-01 13:27:01 +0000763 if (ContainErrors) {
764 CfgOptions.reset();
765 return true;
766 }
767
768 if (CfgOptions->hasArg(options::OPT_config)) {
769 CfgOptions.reset();
770 Diag(diag::err_drv_nested_config_file);
771 return true;
772 }
773
774 // Claim all arguments that come from a configuration file so that the driver
775 // does not warn on any that is unused.
776 for (Arg *A : *CfgOptions)
777 A->claim();
778 return false;
779}
780
781bool Driver::loadConfigFile() {
782 std::string CfgFileName;
783 bool FileSpecifiedExplicitly = false;
784
785 // Process options that change search path for config files.
786 if (CLOptions) {
787 if (CLOptions->hasArg(options::OPT_config_system_dir_EQ)) {
788 SmallString<128> CfgDir;
789 CfgDir.append(
790 CLOptions->getLastArgValue(options::OPT_config_system_dir_EQ));
791 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000792 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000793 SystemConfigDir.clear();
794 else
795 SystemConfigDir = std::string(CfgDir.begin(), CfgDir.end());
796 }
797 }
798 if (CLOptions->hasArg(options::OPT_config_user_dir_EQ)) {
799 SmallString<128> CfgDir;
800 CfgDir.append(
801 CLOptions->getLastArgValue(options::OPT_config_user_dir_EQ));
802 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000803 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000804 UserConfigDir.clear();
805 else
806 UserConfigDir = std::string(CfgDir.begin(), CfgDir.end());
807 }
808 }
809 }
810
811 // First try to find config file specified in command line.
812 if (CLOptions) {
813 std::vector<std::string> ConfigFiles =
814 CLOptions->getAllArgValues(options::OPT_config);
815 if (ConfigFiles.size() > 1) {
816 Diag(diag::err_drv_duplicate_config);
817 return true;
818 }
819
820 if (!ConfigFiles.empty()) {
821 CfgFileName = ConfigFiles.front();
822 assert(!CfgFileName.empty());
823
824 // If argument contains directory separator, treat it as a path to
825 // configuration file.
826 if (llvm::sys::path::has_parent_path(CfgFileName)) {
827 SmallString<128> CfgFilePath;
828 if (llvm::sys::path::is_relative(CfgFileName))
829 llvm::sys::fs::current_path(CfgFilePath);
830 llvm::sys::path::append(CfgFilePath, CfgFileName);
831 if (!llvm::sys::fs::is_regular_file(CfgFilePath)) {
832 Diag(diag::err_drv_config_file_not_exist) << CfgFilePath;
833 return true;
834 }
835 return readConfigFile(CfgFilePath);
836 }
837
838 FileSpecifiedExplicitly = true;
839 }
840 }
841
842 // If config file is not specified explicitly, try to deduce configuration
843 // from executable name. For instance, an executable 'armv7l-clang' will
844 // search for config file 'armv7l-clang.cfg'.
845 if (CfgFileName.empty() && !ClangNameParts.TargetPrefix.empty())
846 CfgFileName = ClangNameParts.TargetPrefix + '-' + ClangNameParts.ModeSuffix;
847
848 if (CfgFileName.empty())
849 return false;
850
851 // Determine architecture part of the file name, if it is present.
852 StringRef CfgFileArch = CfgFileName;
853 size_t ArchPrefixLen = CfgFileArch.find('-');
854 if (ArchPrefixLen == StringRef::npos)
855 ArchPrefixLen = CfgFileArch.size();
856 llvm::Triple CfgTriple;
857 CfgFileArch = CfgFileArch.take_front(ArchPrefixLen);
858 CfgTriple = llvm::Triple(llvm::Triple::normalize(CfgFileArch));
859 if (CfgTriple.getArch() == llvm::Triple::ArchType::UnknownArch)
860 ArchPrefixLen = 0;
861
862 if (!StringRef(CfgFileName).endswith(".cfg"))
863 CfgFileName += ".cfg";
864
865 // If config file starts with architecture name and command line options
866 // redefine architecture (with options like -m32 -LE etc), try finding new
867 // config file with that architecture.
868 SmallString<128> FixedConfigFile;
869 size_t FixedArchPrefixLen = 0;
870 if (ArchPrefixLen) {
871 // Get architecture name from config file name like 'i386.cfg' or
872 // 'armv7l-clang.cfg'.
873 // Check if command line options changes effective triple.
874 llvm::Triple EffectiveTriple = computeTargetTriple(*this,
875 CfgTriple.getTriple(), *CLOptions);
876 if (CfgTriple.getArch() != EffectiveTriple.getArch()) {
877 FixedConfigFile = EffectiveTriple.getArchName();
878 FixedArchPrefixLen = FixedConfigFile.size();
879 // Append the rest of original file name so that file name transforms
880 // like: i386-clang.cfg -> x86_64-clang.cfg.
881 if (ArchPrefixLen < CfgFileName.size())
882 FixedConfigFile += CfgFileName.substr(ArchPrefixLen);
883 }
884 }
885
886 // Prepare list of directories where config file is searched for.
887 SmallVector<std::string, 3> CfgFileSearchDirs;
888 CfgFileSearchDirs.push_back(UserConfigDir);
889 CfgFileSearchDirs.push_back(SystemConfigDir);
890 CfgFileSearchDirs.push_back(Dir);
891
892 // Try to find config file. First try file with corrected architecture.
893 llvm::SmallString<128> CfgFilePath;
894 if (!FixedConfigFile.empty()) {
895 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
896 return readConfigFile(CfgFilePath);
897 // If 'x86_64-clang.cfg' was not found, try 'x86_64.cfg'.
898 FixedConfigFile.resize(FixedArchPrefixLen);
899 FixedConfigFile.append(".cfg");
900 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
901 return readConfigFile(CfgFilePath);
902 }
903
904 // Then try original file name.
905 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
906 return readConfigFile(CfgFilePath);
907
908 // Finally try removing driver mode part: 'x86_64-clang.cfg' -> 'x86_64.cfg'.
909 if (!ClangNameParts.ModeSuffix.empty() &&
910 !ClangNameParts.TargetPrefix.empty()) {
911 CfgFileName.assign(ClangNameParts.TargetPrefix);
912 CfgFileName.append(".cfg");
913 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
914 return readConfigFile(CfgFilePath);
915 }
916
917 // Report error but only if config file was specified explicitly, by option
918 // --config. If it was deduced from executable name, it is not an error.
919 if (FileSpecifiedExplicitly) {
920 Diag(diag::err_drv_config_file_not_found) << CfgFileName;
921 for (const std::string &SearchDir : CfgFileSearchDirs)
922 if (!SearchDir.empty())
923 Diag(diag::note_drv_config_file_searched_in) << SearchDir;
924 return true;
925 }
926
927 return false;
928}
929
Chris Lattner54b16772011-07-23 17:14:25 +0000930Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000931 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
932
Eric Christopherf901e852011-08-17 22:59:59 +0000933 // FIXME: Handle environment options which affect driver behavior, somewhere
Bill Wendlingadbeb9f2012-03-12 21:24:57 +0000934 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
Chad Rosier82301162011-09-14 00:47:55 +0000935
David Majnemer85c25b42016-07-24 17:44:03 +0000936 if (Optional<std::string> CompilerPathValue =
937 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
938 StringRef CompilerPath = *CompilerPathValue;
Chad Rosier82301162011-09-14 00:47:55 +0000939 while (!CompilerPath.empty()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000940 std::pair<StringRef, StringRef> Split =
941 CompilerPath.split(llvm::sys::EnvPathSeparator);
Chad Rosier82301162011-09-14 00:47:55 +0000942 PrefixDirs.push_back(Split.first);
943 CompilerPath = Split.second;
944 }
945 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000946
Hans Wennborg70850d82013-07-18 20:29:38 +0000947 // We look for the driver mode option early, because the mode can affect
948 // how other options are parsed.
Zachary Turneraff19c32016-08-12 17:47:52 +0000949 ParseDriverMode(ClangExecutable, ArgList.slice(1));
Hans Wennborg70850d82013-07-18 20:29:38 +0000950
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000951 // FIXME: What are we going to do with -V and -b?
952
Serge Pavlov208ac652018-01-01 13:27:01 +0000953 // Arguments specified in command line.
954 bool ContainsError;
955 CLOptions = llvm::make_unique<InputArgList>(
Hans Wennborg797004d2018-11-08 11:27:04 +0000956 ParseArgStrings(ArgList.slice(1), IsCLMode(), ContainsError));
Serge Pavlov208ac652018-01-01 13:27:01 +0000957
958 // Try parsing configuration file.
959 if (!ContainsError)
960 ContainsError = loadConfigFile();
961 bool HasConfigFile = !ContainsError && (CfgOptions.get() != nullptr);
962
963 // All arguments, from both config file and command line.
964 InputArgList Args = std::move(HasConfigFile ? std::move(*CfgOptions)
965 : std::move(*CLOptions));
Hans Wennborg797004d2018-11-08 11:27:04 +0000966
967 auto appendOneArg = [&Args](const Arg *Opt, const Arg *BaseArg) {
Serge Pavlovf015a562018-04-26 06:28:47 +0000968 unsigned Index = Args.MakeIndex(Opt->getSpelling());
Serge Pavlov208ac652018-01-01 13:27:01 +0000969 Arg *Copy = new llvm::opt::Arg(Opt->getOption(), Opt->getSpelling(),
Serge Pavlovf015a562018-04-26 06:28:47 +0000970 Index, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000971 Copy->getValues() = Opt->getValues();
972 if (Opt->isClaimed())
973 Copy->claim();
974 Args.append(Copy);
Hans Wennborg797004d2018-11-08 11:27:04 +0000975 };
976
977 if (HasConfigFile)
978 for (auto *Opt : *CLOptions) {
979 if (Opt->getOption().matches(options::OPT_config))
980 continue;
981 const Arg *BaseArg = &Opt->getBaseArg();
982 if (BaseArg == Opt)
983 BaseArg = nullptr;
984 appendOneArg(Opt, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000985 }
986
Hans Wennborg797004d2018-11-08 11:27:04 +0000987 // In CL mode, look for any pass-through arguments
988 if (IsCLMode() && !ContainsError) {
989 SmallVector<const char *, 16> CLModePassThroughArgList;
990 for (const auto *A : Args.filtered(options::OPT__SLASH_clang)) {
991 A->claim();
992 CLModePassThroughArgList.push_back(A->getValue());
993 }
994
995 if (!CLModePassThroughArgList.empty()) {
996 // Parse any pass through args using default clang processing rather
997 // than clang-cl processing.
998 auto CLModePassThroughOptions = llvm::make_unique<InputArgList>(
999 ParseArgStrings(CLModePassThroughArgList, false, ContainsError));
1000
1001 if (!ContainsError)
1002 for (auto *Opt : *CLModePassThroughOptions) {
1003 appendOneArg(Opt, nullptr);
1004 }
1005 }
1006 }
1007
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001008 // Check for working directory option before accessing any files
1009 if (Arg *WD = Args.getLastArg(options::OPT_working_directory))
1010 if (std::error_code EC = VFS->setCurrentWorkingDirectory(WD->getValue()))
1011 Diag(diag::err_drv_unable_to_set_working_directory) << WD->getValue();
1012
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001013 // FIXME: This stuff needs to go into the Compilation, not the driver.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001014 bool CCCPrintPhases;
Daniel Dunbard02cb1d2009-03-05 06:38:47 +00001015
Filipe Cabecinhas136f35e2015-07-18 06:35:24 +00001016 // Silence driver warnings if requested
1017 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
1018
Rafael Espindola59ae7992009-12-07 18:28:29 +00001019 // -no-canonical-prefixes is used very early in main.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001020 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
Rafael Espindola59ae7992009-12-07 18:28:29 +00001021
Daniel Dunbar926f81f2010-08-02 02:38:03 +00001022 // Ignore -pipe.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001023 Args.ClaimAllArgs(options::OPT_pipe);
Daniel Dunbar926f81f2010-08-02 02:38:03 +00001024
Daniel Dunbaracd69572009-12-04 21:55:23 +00001025 // Extract -ccc args.
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001026 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001027 // FIXME: We need to figure out where this behavior should live. Most of it
1028 // should be outside in the client; the parts that aren't should have proper
1029 // options, either by introducing new ones or by overloading gcc ones like -V
1030 // or -b.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001031 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
David Blaikie69a1d8c2015-06-22 22:07:27 +00001032 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
1033 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
Richard Smithbd55daf2012-11-01 04:30:05 +00001034 CCCGenericGCCName = A->getValue();
Bruno Cardoso Lopes52dfe712017-04-12 21:46:20 +00001035 GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
1036 options::OPT_fno_crash_diagnostics,
1037 !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
Petr Hosekdd38d932018-05-29 22:35:39 +00001038 // FIXME: TargetTriple is used by the target-prefixed calls to as/ld
Joerg Sonnenberger17d75512012-02-22 19:15:16 +00001039 // and getToolChain is const.
Hans Wennborg2e274592013-08-13 23:38:57 +00001040 if (IsCLMode()) {
Hans Wennborg73609a02014-03-28 01:19:04 +00001041 // clang-cl targets MSVC-style Win32.
Petr Hosekdd38d932018-05-29 22:35:39 +00001042 llvm::Triple T(TargetTriple);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +00001043 T.setOS(llvm::Triple::Win32);
Hans Wennborg0f0e8d62015-09-18 17:11:50 +00001044 T.setVendor(llvm::Triple::PC);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +00001045 T.setEnvironment(llvm::Triple::MSVC);
Oleg Ranevskyy80523182017-08-31 20:31:30 +00001046 T.setObjectFormat(llvm::Triple::COFF);
Petr Hosekdd38d932018-05-29 22:35:39 +00001047 TargetTriple = T.str();
Hans Wennborg2e274592013-08-13 23:38:57 +00001048 }
David Blaikie69a1d8c2015-06-22 22:07:27 +00001049 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +00001050 TargetTriple = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001051 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
Richard Smithbd55daf2012-11-01 04:30:05 +00001052 Dir = InstalledDir = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001053 for (const Arg *A : Args.filtered(options::OPT_B)) {
Benjamin Kramer1a648d12011-02-08 20:31:42 +00001054 A->claim();
Richard Smithbd55daf2012-11-01 04:30:05 +00001055 PrefixDirs.push_back(A->getValue(0));
Benjamin Kramer1a648d12011-02-08 20:31:42 +00001056 }
David Blaikie69a1d8c2015-06-22 22:07:27 +00001057 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
Richard Smithbd55daf2012-11-01 04:30:05 +00001058 SysRoot = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001059 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
Peter Collingbourne9d9e1fc2013-05-27 21:40:20 +00001060 DyldPrefix = A->getValue();
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001061
David Blaikie69a1d8c2015-06-22 22:07:27 +00001062 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
Bob Wilsona20a1da2013-03-23 05:17:59 +00001063 ResourceDir = A->getValue();
Jim Grosbach061dabf2013-03-12 20:17:58 +00001064
David Blaikie69a1d8c2015-06-22 22:07:27 +00001065 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001066 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
1067 .Case("cwd", SaveTempsCwd)
1068 .Case("obj", SaveTempsObj)
1069 .Default(SaveTempsCwd);
1070 }
1071
Steven Wu1257cd82016-05-18 17:04:52 +00001072 setLTOMode(Args);
1073
Steven Wu844ab6a2016-11-16 06:06:44 +00001074 // Process -fembed-bitcode= flags.
1075 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
1076 StringRef Name = A->getValue();
1077 unsigned Model = llvm::StringSwitch<unsigned>(Name)
1078 .Case("off", EmbedNone)
1079 .Case("all", EmbedBitcode)
1080 .Case("bitcode", EmbedBitcode)
1081 .Case("marker", EmbedMarker)
1082 .Default(~0U);
1083 if (Model == ~0U) {
1084 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
1085 << Name;
1086 } else
1087 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
Steven Wu574b0f22016-03-01 01:07:58 +00001088 }
1089
David Blaikie69a1d8c2015-06-22 22:07:27 +00001090 std::unique_ptr<llvm::opt::InputArgList> UArgs =
1091 llvm::make_unique<InputArgList>(std::move(Args));
1092
Daniel Dunbar775d4062010-06-11 22:00:26 +00001093 // Perform the default argument translations.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001094 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
Daniel Dunbar775d4062010-06-11 22:00:26 +00001095
Chandler Carruthcb916192012-01-25 08:49:21 +00001096 // Owned by the host.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00001097 const ToolChain &TC = getToolChain(
Petr Hosekdd38d932018-05-29 22:35:39 +00001098 *UArgs, computeTargetTriple(*this, TargetTriple, *UArgs));
Chandler Carruthcb916192012-01-25 08:49:21 +00001099
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00001100 // The compilation takes ownership of Args.
Benjamin Kramer43c0f482017-06-30 13:21:27 +00001101 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs,
1102 ContainsError);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001103
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001104 if (!HandleImmediateArgs(*C))
1105 return C;
1106
Chad Rosierecdede82011-08-12 22:08:57 +00001107 // Construct the list of inputs.
1108 InputList Inputs;
Hans Wennborged1d0722013-08-13 21:32:29 +00001109 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
Chad Rosierecdede82011-08-12 22:08:57 +00001110
Samuel Antaoc1ffba52016-06-13 18:10:57 +00001111 // Populate the tool chains for the offloading devices, if any.
1112 CreateOffloadingDeviceToolChains(*C, Inputs);
Justin Lebar0e450a52016-03-30 23:30:25 +00001113
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001114 // Construct the list of abstract actions to perform for this compilation. On
Tim Northover157d9112014-01-16 08:48:16 +00001115 // MachO targets this uses the driver-driver and universal actions.
1116 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001117 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001118 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001119 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001120
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001121 if (CCCPrintPhases) {
Daniel Dunbareb843be2009-03-18 03:13:20 +00001122 PrintActions(*C);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001123 return C;
1124 }
1125
1126 BuildJobs(*C);
Daniel Dunbaradc91e62009-03-15 01:38:15 +00001127
1128 return C;
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001129}
1130
Justin Bognered9cbe02015-07-09 06:58:31 +00001131static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
1132 llvm::opt::ArgStringList ASL;
1133 for (const auto *A : Args)
1134 A->render(Args, ASL);
1135
1136 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
1137 if (I != ASL.begin())
1138 OS << ' ';
1139 Command::printArg(OS, *I, true);
1140 }
1141 OS << '\n';
1142}
1143
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001144bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
1145 SmallString<128> &CrashDiagDir) {
1146 using namespace llvm::sys;
1147 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
1148 "Only knows about .crash files on Darwin");
1149
1150 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
1151 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
1152 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
1153 path::home_directory(CrashDiagDir);
1154 if (CrashDiagDir.startswith("/var/root"))
1155 CrashDiagDir = "/";
1156 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
1157 int PID =
1158#if LLVM_ON_UNIX
1159 getpid();
1160#else
1161 0;
1162#endif
1163 std::error_code EC;
1164 fs::file_status FileStatus;
1165 TimePoint<> LastAccessTime;
1166 SmallString<128> CrashFilePath;
1167 // Lookup the .crash files and get the one generated by a subprocess spawned
1168 // by this driver invocation.
1169 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
1170 File != FileEnd && !EC; File.increment(EC)) {
1171 StringRef FileName = path::filename(File->path());
1172 if (!FileName.startswith(Name))
1173 continue;
1174 if (fs::status(File->path(), FileStatus))
1175 continue;
1176 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
1177 llvm::MemoryBuffer::getFile(File->path());
1178 if (!CrashFile)
1179 continue;
1180 // The first line should start with "Process:", otherwise this isn't a real
1181 // .crash file.
1182 StringRef Data = CrashFile.get()->getBuffer();
1183 if (!Data.startswith("Process:"))
1184 continue;
1185 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
1186 size_t ParentProcPos = Data.find("Parent Process:");
1187 if (ParentProcPos == StringRef::npos)
1188 continue;
1189 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
1190 if (LineEnd == StringRef::npos)
1191 continue;
1192 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
1193 int OpenBracket = -1, CloseBracket = -1;
1194 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
1195 if (ParentProcess[i] == '[')
1196 OpenBracket = i;
1197 if (ParentProcess[i] == ']')
1198 CloseBracket = i;
1199 }
1200 // Extract the parent process PID from the .crash file and check whether
1201 // it matches this driver invocation pid.
1202 int CrashPID;
1203 if (OpenBracket < 0 || CloseBracket < 0 ||
1204 ParentProcess.slice(OpenBracket + 1, CloseBracket)
1205 .getAsInteger(10, CrashPID) || CrashPID != PID) {
1206 continue;
1207 }
1208
1209 // Found a .crash file matching the driver pid. To avoid getting an older
1210 // and misleading crash file, continue looking for the most recent.
1211 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
1212 // multiple crashes poiting to the same parent process. Since the driver
1213 // does not collect pid information for the dispatched invocation there's
1214 // currently no way to distinguish among them.
1215 const auto FileAccessTime = FileStatus.getLastModificationTime();
1216 if (FileAccessTime > LastAccessTime) {
1217 CrashFilePath.assign(File->path());
1218 LastAccessTime = FileAccessTime;
1219 }
1220 }
1221
1222 // If found, copy it over to the location of other reproducer files.
1223 if (!CrashFilePath.empty()) {
1224 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
1225 if (EC)
1226 return false;
1227 return true;
1228 }
1229
1230 return false;
1231}
1232
Eric Christopherf901e852011-08-17 22:59:59 +00001233// When clang crashes, produce diagnostic information including the fully
1234// preprocessed source file(s). Request that the developer attach the
Chad Rosierbe10f982011-08-02 17:58:04 +00001235// diagnostic information to a bug report.
Alex Lorenz045c5142018-04-07 00:03:27 +00001236void Driver::generateCompilationDiagnostics(
1237 Compilation &C, const Command &FailingCommand,
1238 StringRef AdditionalInformation, CompilationDiagnosticReport *Report) {
Chad Rosier877c0a22012-02-22 00:30:39 +00001239 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
Chad Rosier62135492012-07-09 17:31:28 +00001240 return;
Chad Rosierbee5a1d2012-03-07 00:30:40 +00001241
Chad Rosierdbf46a12013-02-01 18:30:26 +00001242 // Don't try to generate diagnostics for link or dsymutil jobs.
Justin Bognere1a33d12014-10-20 21:02:05 +00001243 if (FailingCommand.getCreator().isLinkJob() ||
1244 FailingCommand.getCreator().isDsymutilJob())
Chad Rosier877c0a22012-02-22 00:30:39 +00001245 return;
1246
Chad Rosier8179f112012-06-19 17:51:34 +00001247 // Print the version of the compiler.
1248 PrintVersion(C, llvm::errs());
1249
Chad Rosierbe10f982011-08-02 17:58:04 +00001250 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001251 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
1252 "crash backtrace, preprocessed source, and associated run script.";
Chad Rosierbe10f982011-08-02 17:58:04 +00001253
1254 // Suppress driver output and emit preprocessor output to temp file.
Hans Wennborg70850d82013-07-18 20:29:38 +00001255 Mode = CPPMode;
Chad Rosierbe10f982011-08-02 17:58:04 +00001256 CCGenDiagnostics = true;
1257
Chad Rosiercdb008d2011-11-02 21:29:05 +00001258 // Save the original job command(s).
Justin Bogner25645152014-10-21 17:24:44 +00001259 Command Cmd = FailingCommand;
Chad Rosiercdb008d2011-11-02 21:29:05 +00001260
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001261 // Keep track of whether we produce any errors while trying to produce
1262 // preprocessed sources.
1263 DiagnosticErrorTrap Trap(Diags);
1264
1265 // Suppress tool output.
Chad Rosierbe10f982011-08-02 17:58:04 +00001266 C.initCompilationForDiagnostics();
Chad Rosierecdede82011-08-12 22:08:57 +00001267
1268 // Construct the list of inputs.
1269 InputList Inputs;
1270 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001271
Chad Rosier4f81fc22011-08-12 23:30:05 +00001272 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001273 bool IgnoreInput = false;
1274
1275 // Ignore input from stdin or any inputs that cannot be preprocessed.
Paul Robinsonf44157d2014-04-28 22:24:44 +00001276 // Check type first as not all linker inputs have a value.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001277 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
Paul Robinsonf44157d2014-04-28 22:24:44 +00001278 IgnoreInput = true;
1279 } else if (!strcmp(it->second->getValue(), "-")) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001280 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001281 << "Error generating preprocessed source(s) - "
1282 "ignoring input from stdin.";
Chad Rosierd57133d2011-08-18 00:22:25 +00001283 IgnoreInput = true;
Chad Rosierd57133d2011-08-18 00:22:25 +00001284 }
1285
1286 if (IgnoreInput) {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001287 it = Inputs.erase(it);
1288 ie = Inputs.end();
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001289 } else {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001290 ++it;
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001291 }
Chad Rosier4f81fc22011-08-12 23:30:05 +00001292 }
Chad Rosierd57133d2011-08-18 00:22:25 +00001293
Chad Rosierc5103c32013-01-29 23:57:10 +00001294 if (Inputs.empty()) {
1295 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001296 << "Error generating preprocessed source(s) - "
1297 "no preprocessable inputs.";
Chad Rosierc5103c32013-01-29 23:57:10 +00001298 return;
1299 }
1300
Chad Rosiere75ef402011-09-06 23:52:36 +00001301 // Don't attempt to generate preprocessed files if multiple -arch options are
Chad Rosier636d2832012-02-13 18:16:28 +00001302 // used, unless they're all duplicates.
1303 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001304 for (const Arg *A : C.getArgs()) {
Chad Rosiere75ef402011-09-06 23:52:36 +00001305 if (A->getOption().matches(options::OPT_arch)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001306 StringRef ArchName = A->getValue();
Chad Rosier636d2832012-02-13 18:16:28 +00001307 ArchNames.insert(ArchName);
Chad Rosiere75ef402011-09-06 23:52:36 +00001308 }
1309 }
Chad Rosier636d2832012-02-13 18:16:28 +00001310 if (ArchNames.size() > 1) {
1311 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001312 << "Error generating preprocessed source(s) - cannot generate "
1313 "preprocessed source with multiple -arch options.";
Chad Rosier636d2832012-02-13 18:16:28 +00001314 return;
1315 }
Chad Rosiere75ef402011-09-06 23:52:36 +00001316
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001317 // Construct the list of abstract actions to perform for this compilation. On
1318 // Darwin OSes this uses the driver-driver and builds universal actions.
Chandler Carruthcb916192012-01-25 08:49:21 +00001319 const ToolChain &TC = C.getDefaultToolChain();
Tim Northover157d9112014-01-16 08:48:16 +00001320 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001321 BuildUniversalActions(C, TC, Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001322 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001323 BuildActions(C, C.getArgs(), Inputs, C.getActions());
Chad Rosierbe10f982011-08-02 17:58:04 +00001324
1325 BuildJobs(C);
1326
1327 // If there were errors building the compilation, quit now.
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001328 if (Trap.hasErrorOccurred()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001329 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001330 << "Error generating preprocessed source(s).";
Chad Rosierbe10f982011-08-02 17:58:04 +00001331 return;
1332 }
1333
1334 // Generate preprocessed output.
Chad Rosierdd60e092013-01-29 20:15:05 +00001335 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
Justin Bogner0cd92482015-07-02 22:52:08 +00001336 C.ExecuteJobs(C.getJobs(), FailingCommands);
Chad Rosierbe10f982011-08-02 17:58:04 +00001337
Justin Bognerbc89b182014-10-20 21:20:27 +00001338 // If any of the preprocessing commands failed, clean up and exit.
1339 if (!FailingCommands.empty()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001340 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001341 << "Error generating preprocessed source(s).";
Justin Bognerbc89b182014-10-20 21:20:27 +00001342 return;
Chad Rosierbe10f982011-08-02 17:58:04 +00001343 }
Justin Bognerbc89b182014-10-20 21:20:27 +00001344
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001345 const ArgStringList &TempFiles = C.getTempFiles();
1346 if (TempFiles.empty()) {
1347 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001348 << "Error generating preprocessed source(s).";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001349 return;
1350 }
1351
Justin Bognerbc89b182014-10-20 21:20:27 +00001352 Diag(clang::diag::note_drv_command_failed_diag_msg)
1353 << "\n********************\n\n"
1354 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
1355 "Preprocessed source(s) and associated run script(s) are located at:";
Justin Bognerbc89b182014-10-20 21:20:27 +00001356
Justin Bogner659ecc32014-10-20 22:47:23 +00001357 SmallString<128> VFS;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001358 SmallString<128> ReproCrashFilename;
Justin Bogner659ecc32014-10-20 22:47:23 +00001359 for (const char *TempFile : TempFiles) {
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001360 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
Alex Lorenz045c5142018-04-07 00:03:27 +00001361 if (Report)
1362 Report->TemporaryFiles.push_back(TempFile);
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001363 if (ReproCrashFilename.empty()) {
1364 ReproCrashFilename = TempFile;
1365 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
1366 }
Justin Bogner659ecc32014-10-20 22:47:23 +00001367 if (StringRef(TempFile).endswith(".cache")) {
1368 // In some cases (modules) we'll dump extra data to help with reproducing
1369 // the crash into a directory next to the output.
1370 VFS = llvm::sys::path::filename(TempFile);
1371 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
1372 }
1373 }
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001374
1375 // Assume associated files are based off of the first temporary file.
Justin Bogner25645152014-10-21 17:24:44 +00001376 CrashReportInfo CrashInfo(TempFiles[0], VFS);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001377
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001378 llvm::SmallString<128> Script(CrashInfo.Filename);
1379 llvm::sys::path::replace_extension(Script, "sh");
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001380 std::error_code EC;
Zachary Turner1f67a3c2018-06-07 19:58:58 +00001381 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::CD_CreateNew);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001382 if (EC) {
1383 Diag(clang::diag::note_drv_command_failed_diag_msg)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001384 << "Error generating run script: " << Script << " " << EC.message();
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001385 } else {
Justin Bogner42220ed2015-03-12 00:14:35 +00001386 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
Justin Bognered9cbe02015-07-09 06:58:31 +00001387 << "# Driver args: ";
1388 printArgList(ScriptOS, C.getInputArgs());
1389 ScriptOS << "# Original command: ";
Justin Bogner42220ed2015-03-12 00:14:35 +00001390 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
Justin Bogner33bdbc62014-10-21 18:03:08 +00001391 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
Alex Lorenz045c5142018-04-07 00:03:27 +00001392 if (!AdditionalInformation.empty())
1393 ScriptOS << "\n# Additional information: " << AdditionalInformation
1394 << "\n";
1395 if (Report)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001396 Report->TemporaryFiles.push_back(Script.str());
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001397 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
Justin Bognerbc89b182014-10-20 21:20:27 +00001398 }
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001399
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001400 // On darwin, provide information about the .crash diagnostic report.
1401 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
1402 SmallString<128> CrashDiagDir;
1403 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
1404 Diag(clang::diag::note_drv_command_failed_diag_msg)
1405 << ReproCrashFilename.str();
1406 } else { // Suggest a directory for the user to look for .crash files.
1407 llvm::sys::path::append(CrashDiagDir, Name);
1408 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
1409 Diag(clang::diag::note_drv_command_failed_diag_msg)
1410 << "Crash backtrace is located in";
1411 Diag(clang::diag::note_drv_command_failed_diag_msg)
1412 << CrashDiagDir.str();
1413 Diag(clang::diag::note_drv_command_failed_diag_msg)
1414 << "(choose the .crash file that corresponds to your crash)";
1415 }
1416 }
1417
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001418 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1419 options::OPT_frewrite_map_file_EQ))
1420 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1421
Justin Bognerbc89b182014-10-20 21:20:27 +00001422 Diag(clang::diag::note_drv_command_failed_diag_msg)
1423 << "\n\n********************";
Chad Rosierbe10f982011-08-02 17:58:04 +00001424}
1425
Justin Bogner0cd92482015-07-02 22:52:08 +00001426void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
Simon Atanasyan27c0f202019-04-02 18:03:15 +00001427 // Since commandLineFitsWithinSystemLimits() may underestimate system's
1428 // capacity if the tool does not support response files, there is a chance/
1429 // that things will just work without a response file, so we silently just
1430 // skip it.
Justin Bogner0cd92482015-07-02 22:52:08 +00001431 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
Simon Atanasyan27c0f202019-04-02 18:03:15 +00001432 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(),
1433 Cmd.getArguments()))
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001434 return;
1435
1436 std::string TmpName = GetTemporaryPath("response", "txt");
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00001437 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001438}
1439
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001440int Driver::ExecuteCompilation(
1441 Compilation &C,
1442 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001443 // Just print if -### was present.
1444 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Hans Wennborgb212b342013-09-12 18:23:34 +00001445 C.getJobs().Print(llvm::errs(), "\n", true);
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001446 return 0;
1447 }
1448
1449 // If there were errors building the compilation, quit now.
Chad Rosierbe10f982011-08-02 17:58:04 +00001450 if (Diags.hasErrorOccurred())
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001451 return 1;
1452
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001453 // Set up response file names for each command, if necessary
Justin Bogner0cd92482015-07-02 22:52:08 +00001454 for (auto &Job : C.getJobs())
1455 setUpResponseFiles(C, Job);
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001456
Justin Bogner0cd92482015-07-02 22:52:08 +00001457 C.ExecuteJobs(C.getJobs(), FailingCommands);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001458
Daniel Dunbar07494792010-05-22 00:37:20 +00001459 // If the command succeeded, we are done.
Chad Rosierdd60e092013-01-29 20:15:05 +00001460 if (FailingCommands.empty())
1461 return 0;
Daniel Dunbar07494792010-05-22 00:37:20 +00001462
Chad Rosierdd60e092013-01-29 20:15:05 +00001463 // Otherwise, remove result files and print extra information about abnormal
1464 // failures.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001465 int Res = 0;
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001466 for (const auto &CmdPair : FailingCommands) {
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001467 int CommandRes = CmdPair.first;
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001468 const Command *FailingCommand = CmdPair.second;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001469
Chad Rosierdd60e092013-01-29 20:15:05 +00001470 // Remove result files if we're not saving temps.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001471 if (!isSaveTempsEnabled()) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001472 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1473 C.CleanupFileMap(C.getResultFiles(), JA, true);
1474
1475 // Failure result files are valid unless we crashed.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001476 if (CommandRes < 0)
Chad Rosierdd60e092013-01-29 20:15:05 +00001477 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1478 }
1479
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001480#if LLVM_ON_UNIX
1481 // llvm/lib/Support/Unix/Signals.inc will exit with a special return code
1482 // for SIGPIPE. Do not print diagnostics for this case.
1483 if (CommandRes == EX_IOERR) {
1484 Res = CommandRes;
1485 continue;
1486 }
1487#endif
1488
Chad Rosierdd60e092013-01-29 20:15:05 +00001489 // Print extra information about abnormal failures, if possible.
1490 //
1491 // This is ad-hoc, but we don't want to be excessively noisy. If the result
Justin Bogner5aaf2e72014-06-26 20:59:36 +00001492 // status was 1, assume the command failed normally. In particular, if it
Chad Rosierdd60e092013-01-29 20:15:05 +00001493 // was the compiler then assume it gave a reasonable error code. Failures
1494 // in other tools are less common, and they generally have worse
1495 // diagnostics, so always print the diagnostic there.
1496 const Tool &FailingTool = FailingCommand->getCreator();
1497
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001498 if (!FailingCommand->getCreator().hasGoodDiagnostics() || CommandRes != 1) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001499 // FIXME: See FIXME above regarding result code interpretation.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001500 if (CommandRes < 0)
Chad Rosierdd60e092013-01-29 20:15:05 +00001501 Diag(clang::diag::err_drv_command_signalled)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001502 << FailingTool.getShortName();
Chad Rosierdd60e092013-01-29 20:15:05 +00001503 else
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001504 Diag(clang::diag::err_drv_command_failed)
1505 << FailingTool.getShortName() << CommandRes;
Chad Rosierdd60e092013-01-29 20:15:05 +00001506 }
Peter Collingbourne119cfaa2011-11-21 00:01:05 +00001507 }
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001508 return Res;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001509}
1510
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001511void Driver::PrintHelp(bool ShowHidden) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001512 unsigned IncludedFlagsBitmask;
1513 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001514 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Hans Wennborg797004d2018-11-08 11:27:04 +00001515 getIncludeExcludeOptionFlagMasks(IsCLMode());
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001516
1517 ExcludedFlagsBitmask |= options::NoDriverOption;
1518 if (!ShowHidden)
1519 ExcludedFlagsBitmask |= HelpHidden;
1520
Fangrui Songd0028232018-10-10 00:15:33 +00001521 std::string Usage = llvm::formatv("{0} [options] file...", Name).str();
1522 getOpts().PrintHelp(llvm::outs(), Usage.c_str(), DriverTitle.c_str(),
George Rimar5dbfa4e2017-07-26 09:10:17 +00001523 IncludedFlagsBitmask, ExcludedFlagsBitmask,
1524 /*ShowAllAliases=*/false);
Daniel Dunbar7c925282009-03-31 21:38:17 +00001525}
1526
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001527void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001528 // FIXME: The following handlers should use a callback mechanism, we don't
1529 // know what the client would like to do.
Ted Kremenek4c0df3d2010-01-23 02:11:34 +00001530 OS << getClangFullVersion() << '\n';
Daniel Dunbarb10248802009-03-26 16:09:13 +00001531 const ToolChain &TC = C.getDefaultToolChain();
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001532 OS << "Target: " << TC.getTripleString() << '\n';
Daniel Dunbar10978e42009-06-16 23:32:58 +00001533
1534 // Print the threading model.
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001535 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1536 // Don't print if the ToolChain would have barfed on it already
1537 if (TC.isThreadModelSupported(A->getValue()))
1538 OS << "Thread model: " << A->getValue();
1539 } else
Thomas Livelyf3b4f992019-02-28 18:39:08 +00001540 OS << "Thread model: " << TC.getThreadModel();
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001541 OS << '\n';
Chandler Carruth9ade6a92015-08-05 17:07:33 +00001542
1543 // Print out the install directory.
1544 OS << "InstalledDir: " << InstalledDir << '\n';
Serge Pavlov208ac652018-01-01 13:27:01 +00001545
1546 // If configuration file was used, print its path.
1547 if (!ConfigFile.empty())
1548 OS << "Configuration file: " << ConfigFile << '\n';
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001549}
1550
Chris Lattner86ed5b02010-05-05 05:53:24 +00001551/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1552/// option.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001553static void PrintDiagnosticCategories(raw_ostream &OS) {
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001554 // Skip the empty category.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001555 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1556 ++i)
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001557 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
Chris Lattner86ed5b02010-05-05 05:53:24 +00001558}
1559
Yuka Takahashi41789e42018-03-05 08:54:20 +00001560void Driver::HandleAutocompletions(StringRef PassedFlags) const {
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001561 if (PassedFlags == "")
1562 return;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001563 // Print out all options that start with a given argument. This is used for
1564 // shell autocompletion.
1565 std::vector<std::string> SuggestedCompletions;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001566 std::vector<std::string> Flags;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001567
1568 unsigned short DisableFlags =
1569 options::NoDriverOption | options::Unsupported | options::Ignored;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001570
Yuka Takahashi46106f52018-10-24 12:43:25 +00001571 // Distinguish "--autocomplete=-someflag" and "--autocomplete=-someflag,"
1572 // because the latter indicates that the user put space before pushing tab
1573 // which should end up in a file completion.
1574 const bool HasSpace = PassedFlags.endswith(",");
1575
Yuka Takahashi41789e42018-03-05 08:54:20 +00001576 // Parse PassedFlags by "," as all the command-line flags are passed to this
1577 // function separated by ","
1578 StringRef TargetFlags = PassedFlags;
1579 while (TargetFlags != "") {
1580 StringRef CurFlag;
1581 std::tie(CurFlag, TargetFlags) = TargetFlags.split(",");
1582 Flags.push_back(std::string(CurFlag));
Yuka Takahashi1a895202017-08-29 17:46:46 +00001583 }
1584
Yuka Takahashi41789e42018-03-05 08:54:20 +00001585 // We want to show cc1-only options only when clang is invoked with -cc1 or
1586 // -Xclang.
Fangrui Song9ac13a12019-02-10 05:54:57 +00001587 if (llvm::is_contained(Flags, "-Xclang") || llvm::is_contained(Flags, "-cc1"))
Yuka Takahashi41789e42018-03-05 08:54:20 +00001588 DisableFlags &= ~options::NoDriverOption;
1589
1590 StringRef Cur;
1591 Cur = Flags.at(Flags.size() - 1);
1592 StringRef Prev;
1593 if (Flags.size() >= 2) {
1594 Prev = Flags.at(Flags.size() - 2);
1595 SuggestedCompletions = Opts->suggestValueCompletions(Prev, Cur);
1596 }
1597
1598 if (SuggestedCompletions.empty())
1599 SuggestedCompletions = Opts->suggestValueCompletions(Cur, "");
1600
Yuka Takahashi46106f52018-10-24 12:43:25 +00001601 // If Flags were empty, it means the user typed `clang [tab]` where we should
1602 // list all possible flags. If there was no value completion and the user
1603 // pressed tab after a space, we should fall back to a file completion.
1604 // We're printing a newline to be consistent with what we print at the end of
1605 // this function.
1606 if (SuggestedCompletions.empty() && HasSpace && !Flags.empty()) {
1607 llvm::outs() << '\n';
1608 return;
1609 }
1610
Yuka Takahashidf9c7e32018-10-24 08:24:16 +00001611 // When flag ends with '=' and there was no value completion, return empty
1612 // string and fall back to the file autocompletion.
1613 if (SuggestedCompletions.empty() && !Cur.endswith("=")) {
Yuka Takahashi1a895202017-08-29 17:46:46 +00001614 // If the flag is in the form of "--autocomplete=-foo",
1615 // we were requested to print out all option names that start with "-foo".
1616 // For example, "--autocomplete=-fsyn" is expanded to "-fsyntax-only".
Yuka Takahashi41789e42018-03-05 08:54:20 +00001617 SuggestedCompletions = Opts->findByPrefix(Cur, DisableFlags);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001618
1619 // We have to query the -W flags manually as they're not in the OptTable.
1620 // TODO: Find a good way to add them to OptTable instead and them remove
1621 // this code.
1622 for (StringRef S : DiagnosticIDs::getDiagnosticFlags())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001623 if (S.startswith(Cur))
Yuka Takahashi1a895202017-08-29 17:46:46 +00001624 SuggestedCompletions.push_back(S);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001625 }
1626
1627 // Sort the autocomplete candidates so that shells print them out in a
1628 // deterministic order. We could sort in any way, but we chose
1629 // case-insensitive sorting for consistency with the -help option
1630 // which prints out options in the case-insensitive alphabetical order.
Fangrui Song55fab262018-09-26 22:16:28 +00001631 llvm::sort(SuggestedCompletions, [](StringRef A, StringRef B) {
1632 if (int X = A.compare_lower(B))
1633 return X < 0;
1634 return A.compare(B) > 0;
1635 });
Yuka Takahashi1a895202017-08-29 17:46:46 +00001636
1637 llvm::outs() << llvm::join(SuggestedCompletions, "\n") << '\n';
1638}
1639
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001640bool Driver::HandleImmediateArgs(const Compilation &C) {
Daniel Dunbar18974bd2010-06-11 22:00:19 +00001641 // The order these options are handled in gcc is all over the place, but we
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001642 // don't expect inconsistencies w.r.t. that to matter in practice.
Daniel Dunbar7c925282009-03-31 21:38:17 +00001643
Daniel Dunbar1b09e042010-09-17 02:47:28 +00001644 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1645 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1646 return false;
1647 }
1648
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001649 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
Daniel Dunbare26e5002011-01-12 00:43:47 +00001650 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1651 // return an answer which matches our definition of __VERSION__.
Sylvestre Ledrua199a9b2019-03-25 18:06:20 +00001652 llvm::outs() << CLANG_VERSION_STRING << "\n";
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001653 return false;
1654 }
Daniel Dunbarfb3d7472010-06-14 21:23:12 +00001655
Chris Lattner86ed5b02010-05-05 05:53:24 +00001656 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1657 PrintDiagnosticCategories(llvm::outs());
1658 return false;
1659 }
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001660
James Molloya3c85b82012-05-01 14:57:16 +00001661 if (C.getArgs().hasArg(options::OPT_help) ||
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001662 C.getArgs().hasArg(options::OPT__help_hidden)) {
1663 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
Daniel Dunbar7c925282009-03-31 21:38:17 +00001664 return false;
1665 }
1666
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001667 if (C.getArgs().hasArg(options::OPT__version)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001668 // Follow gcc behavior and use stdout for --version and stderr for -v.
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001669 PrintVersion(C, llvm::outs());
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001670 return false;
1671 }
1672
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001673 if (C.getArgs().hasArg(options::OPT_v) ||
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001674 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001675 PrintVersion(C, llvm::errs());
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001676 SuppressMissingInputWarning = true;
1677 }
1678
Serge Pavlov208ac652018-01-01 13:27:01 +00001679 if (C.getArgs().hasArg(options::OPT_v)) {
1680 if (!SystemConfigDir.empty())
1681 llvm::errs() << "System configuration file directory: "
1682 << SystemConfigDir << "\n";
1683 if (!UserConfigDir.empty())
1684 llvm::errs() << "User configuration file directory: "
1685 << UserConfigDir << "\n";
1686 }
1687
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001688 const ToolChain &TC = C.getDefaultToolChain();
Chandler Carruth0ae39aa2013-07-30 17:57:09 +00001689
1690 if (C.getArgs().hasArg(options::OPT_v))
1691 TC.printVerboseInfo(llvm::errs());
1692
Meador Inge51208a32017-04-04 21:46:50 +00001693 if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
Meador Ingea9113952017-04-05 22:27:20 +00001694 llvm::outs() << ResourceDir << '\n';
Meador Inge51208a32017-04-04 21:46:50 +00001695 return false;
1696 }
1697
Daniel Dunbard972e222009-03-20 04:37:21 +00001698 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1699 llvm::outs() << "programs: =";
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001700 bool separator = false;
1701 for (const std::string &Path : TC.getProgramPaths()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001702 if (separator)
Martin Storsjoceb71e82019-04-25 20:03:20 +00001703 llvm::outs() << llvm::sys::EnvPathSeparator;
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001704 llvm::outs() << Path;
1705 separator = true;
Daniel Dunbard972e222009-03-20 04:37:21 +00001706 }
1707 llvm::outs() << "\n";
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001708 llvm::outs() << "libraries: =" << ResourceDir;
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001709
Sebastian Pop980920a2012-04-16 04:16:43 +00001710 StringRef sysroot = C.getSysRoot();
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001711
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001712 for (const std::string &Path : TC.getFilePaths()) {
1713 // Always print a separator. ResourceDir was the first item shown.
Martin Storsjoceb71e82019-04-25 20:03:20 +00001714 llvm::outs() << llvm::sys::EnvPathSeparator;
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001715 // Interpretation of leading '=' is needed only for NetBSD.
1716 if (Path[0] == '=')
Douglas Katzman26eabf62015-06-24 15:10:30 +00001717 llvm::outs() << sysroot << Path.substr(1);
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001718 else
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001719 llvm::outs() << Path;
Daniel Dunbard972e222009-03-20 04:37:21 +00001720 }
1721 llvm::outs() << "\n";
Daniel Dunbar7c925282009-03-31 21:38:17 +00001722 return false;
Daniel Dunbard972e222009-03-20 04:37:21 +00001723 }
1724
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001725 // FIXME: The following handlers should use a callback mechanism, we don't
1726 // know what the client would like to do.
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001727 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001728 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001729 return false;
1730 }
1731
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001732 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
Saleem Abdulrasoole5f3cf82018-05-01 18:40:42 +00001733 StringRef ProgName = A->getValue();
1734
1735 // Null program name cannot have a path.
1736 if (! ProgName.empty())
1737 llvm::outs() << GetProgramPath(ProgName, TC);
1738
1739 llvm::outs() << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001740 return false;
1741 }
1742
Yuka Takahashic8068db2017-05-23 18:39:08 +00001743 if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
Yuka Takahashiba5d4af2017-06-20 16:31:31 +00001744 StringRef PassedFlags = A->getValue();
Yuka Takahashi41789e42018-03-05 08:54:20 +00001745 HandleAutocompletions(PassedFlags);
Yuka Takahashic8068db2017-05-23 18:39:08 +00001746 return false;
1747 }
1748
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001749 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
Michal Gorny7cfe4802016-10-10 12:23:40 +00001750 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
Leo Li23bb21c2017-08-24 01:51:51 +00001751 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1752 RegisterEffectiveTriple TripleRAII(TC, Triple);
Michal Gorny7cfe4802016-10-10 12:23:40 +00001753 switch (RLT) {
1754 case ToolChain::RLT_CompilerRT:
1755 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1756 break;
1757 case ToolChain::RLT_Libgcc:
1758 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1759 break;
1760 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001761 return false;
1762 }
1763
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001764 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001765 for (const Multilib &Multilib : TC.getMultilibs())
1766 llvm::outs() << Multilib << "\n";
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001767 return false;
1768 }
1769
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001770 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
Christian Bruel6ccc4a72018-09-06 14:03:44 +00001771 const Multilib &Multilib = TC.getMultilib();
1772 if (Multilib.gccSuffix().empty())
1773 llvm::outs() << ".\n";
1774 else {
1775 StringRef Suffix(Multilib.gccSuffix());
1776 assert(Suffix.front() == '/');
1777 llvm::outs() << Suffix.substr(1) << "\n";
Jonathan Roelofs3fa96d82014-02-12 01:36:51 +00001778 }
Jonathan Roelofs0e7ec602014-02-12 01:29:25 +00001779 return false;
1780 }
Petr Hosekbc86a992018-08-16 00:22:03 +00001781
1782 if (C.getArgs().hasArg(options::OPT_print_target_triple)) {
1783 llvm::outs() << TC.getTripleString() << "\n";
1784 return false;
1785 }
1786
1787 if (C.getArgs().hasArg(options::OPT_print_effective_triple)) {
1788 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1789 llvm::outs() << Triple.getTriple() << "\n";
1790 return false;
1791 }
1792
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001793 return true;
1794}
1795
Douglas Katzmanfd528672015-06-11 15:05:22 +00001796// Display an action graph human-readably. Action A is the "sink" node
1797// and latest-occuring action. Traversal is in pre-order, visiting the
1798// inputs to each action before printing the action itself.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001799static unsigned PrintActions1(const Compilation &C, Action *A,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001800 std::map<Action *, unsigned> &Ids) {
Douglas Katzmanfd528672015-06-11 15:05:22 +00001801 if (Ids.count(A)) // A was already visited.
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001802 return Ids[A];
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001803
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001804 std::string str;
1805 llvm::raw_string_ostream os(str);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001806
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001807 os << Action::getClassName(A->getKind()) << ", ";
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001808 if (InputAction *IA = dyn_cast<InputAction>(A)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001809 os << "\"" << IA->getInputArg().getValue() << "\"";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001810 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001811 os << '"' << BIA->getArchName() << '"' << ", {"
Nico Weber5a459f82016-02-23 19:30:43 +00001812 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
Samuel Antaod06239d2016-07-15 23:13:27 +00001813 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1814 bool IsFirst = true;
1815 OA->doOnEachDependence(
1816 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1817 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1818 // sm_35 this will generate:
1819 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1820 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1821 if (!IsFirst)
1822 os << ", ";
1823 os << '"';
1824 if (TC)
1825 os << A->getOffloadingKindPrefix();
1826 else
1827 os << "host";
1828 os << " (";
1829 os << TC->getTriple().normalize();
1830
1831 if (BoundArch)
1832 os << ":" << BoundArch;
1833 os << ")";
1834 os << '"';
1835 os << " {" << PrintActions1(C, A, Ids) << "}";
1836 IsFirst = false;
1837 });
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001838 } else {
Samuel Antaod06239d2016-07-15 23:13:27 +00001839 const ActionList *AL = &A->getInputs();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00001840
Artem Belevich23256752015-09-22 17:23:09 +00001841 if (AL->size()) {
1842 const char *Prefix = "{";
1843 for (Action *PreRequisite : *AL) {
1844 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1845 Prefix = ", ";
1846 }
1847 os << "}";
1848 } else
1849 os << "{}";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001850 }
1851
Samuel Antaod06239d2016-07-15 23:13:27 +00001852 // Append offload info for all options other than the offloading action
1853 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1854 std::string offload_str;
1855 llvm::raw_string_ostream offload_os(offload_str);
1856 if (!isa<OffloadAction>(A)) {
1857 auto S = A->getOffloadingKindPrefix();
1858 if (!S.empty()) {
1859 offload_os << ", (" << S;
1860 if (A->getOffloadingArch())
1861 offload_os << ", " << A->getOffloadingArch();
1862 offload_os << ")";
1863 }
1864 }
1865
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001866 unsigned Id = Ids.size();
1867 Ids[A] = Id;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001868 llvm::errs() << Id << ": " << os.str() << ", "
Samuel Antaod06239d2016-07-15 23:13:27 +00001869 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001870
1871 return Id;
1872}
1873
Douglas Katzmanfd528672015-06-11 15:05:22 +00001874// Print the action graphs in a compilation C.
1875// For example "clang -c file1.c file2.c" is composed of two subgraphs.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001876void Driver::PrintActions(const Compilation &C) const {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001877 std::map<Action *, unsigned> Ids;
1878 for (Action *A : C.getActions())
1879 PrintActions1(C, A, Ids);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001880}
1881
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001882/// Check whether the given input tree contains any compilation or
Joerg Sonnenberger5fe4a7d2011-05-06 14:05:11 +00001883/// assembly actions.
1884static bool ContainsCompileOrAssembleAction(const Action *A) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001885 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
Bob Wilson23a55f12014-12-21 07:00:00 +00001886 isa<AssembleJobAction>(A))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001887 return true;
1888
Nico Weber5a459f82016-02-23 19:30:43 +00001889 for (const Action *Input : A->inputs())
Nico Weberfb80f962015-09-19 21:36:51 +00001890 if (ContainsCompileOrAssembleAction(Input))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001891 return true;
1892
1893 return false;
1894}
1895
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001896void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1897 const InputList &BAInputs) const {
1898 DerivedArgList &Args = C.getArgs();
1899 ActionList &Actions = C.getActions();
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001900 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1901 // Collect the list of architectures. Duplicates are allowed, but should only
1902 // be handled once (in the order seen).
Daniel Dunbare5dc4822009-03-13 20:33:35 +00001903 llvm::StringSet<> ArchNames;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001904 SmallVector<const char *, 4> Archs;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001905 for (Arg *A : Args) {
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001906 if (A->getOption().matches(options::OPT_arch)) {
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001907 // Validate the option here; we don't save the type here because its
1908 // particular spelling may participate in other driver choices.
1909 llvm::Triple::ArchType Arch =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001910 tools::darwin::getArchTypeForMachOArchName(A->getValue());
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001911 if (Arch == llvm::Triple::UnknownArch) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001912 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001913 continue;
1914 }
1915
Daniel Dunbar2da02722009-03-19 07:55:12 +00001916 A->claim();
David Blaikie61b86d42014-11-19 02:56:13 +00001917 if (ArchNames.insert(A->getValue()).second)
Richard Smithbd55daf2012-11-01 04:30:05 +00001918 Archs.push_back(A->getValue());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001919 }
1920 }
1921
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001922 // When there is no explicit arch for this platform, make sure we still bind
1923 // the architecture (to the default) so that -Xarch_ is handled correctly.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001924 if (!Archs.size())
Daniel Dunbarc3bd9f52012-11-08 03:38:26 +00001925 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001926
Daniel Dunbarf479c122009-03-12 18:40:18 +00001927 ActionList SingleActions;
Justin Lebar0f3474c2016-02-11 02:00:50 +00001928 BuildActions(C, Args, BAInputs, SingleActions);
Daniel Dunbarf479c122009-03-12 18:40:18 +00001929
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001930 // Add in arch bindings for every top level action, as well as lipo and
1931 // dsymutil steps if needed.
Nico Weberfb80f962015-09-19 21:36:51 +00001932 for (Action* Act : SingleActions) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001933 // Make sure we can lipo this kind of output. If not (and it is an actual
1934 // output) then we disallow, since we can't create an output file with the
1935 // right name without overwriting it. We could remove this oddity by just
1936 // changing the output names to include the arch, which would also fix
Daniel Dunbarf479c122009-03-12 18:40:18 +00001937 // -save-temps. Compatibility wins for now.
1938
Daniel Dunbare2ca3bd2009-03-13 17:46:02 +00001939 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
Daniel Dunbarf479c122009-03-12 18:40:18 +00001940 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001941 << types::getTypeName(Act->getType());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001942
1943 ActionList Inputs;
Justin Lebar41094612016-01-11 23:07:27 +00001944 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1945 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001946
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001947 // Lipo if necessary, we do it this way because we need to set the arch flag
1948 // so that -Xarch_ gets overwritten.
Daniel Dunbarf479c122009-03-12 18:40:18 +00001949 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1950 Actions.append(Inputs.begin(), Inputs.end());
1951 else
Justin Lebar41094612016-01-11 23:07:27 +00001952 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001953
Eric Christopher65c05fa2012-02-06 19:43:51 +00001954 // Handle debug info queries.
1955 Arg *A = Args.getLastArg(options::OPT_g_Group);
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001956 if (A && !A->getOption().matches(options::OPT_g0) &&
1957 !A->getOption().matches(options::OPT_gstabs) &&
1958 ContainsCompileOrAssembleAction(Actions.back())) {
Chad Rosier62135492012-07-09 17:31:28 +00001959
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001960 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1961 // have a compile input. We need to run 'dsymutil' ourselves in such cases
Eric Christopher776c26f2013-01-28 17:39:03 +00001962 // because the debug info will refer to a temporary object file which
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001963 // will be removed at the end of the compilation process.
1964 if (Act->getType() == types::TY_Image) {
1965 ActionList Inputs;
1966 Inputs.push_back(Actions.back());
1967 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001968 Actions.push_back(
1969 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001970 }
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001971
Ben Langmuir9b9a8d32014-02-06 18:53:25 +00001972 // Verify the debug info output.
Alp Tokere9d2bfc2014-01-17 02:06:23 +00001973 if (Args.hasArg(options::OPT_verify_debug_info)) {
Justin Lebar41094612016-01-11 23:07:27 +00001974 Action* LastAction = Actions.back();
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001975 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001976 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1977 LastAction, types::TY_Nothing));
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001978 }
1979 }
Daniel Dunbarf479c122009-03-12 18:40:18 +00001980 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001981}
1982
Nico Weber9b2830b2019-05-23 17:58:33 +00001983bool Driver::DiagnoseInputExistence(const DerivedArgList &Args, StringRef Value,
1984 types::ID Ty, bool TypoCorrect) const {
1985 if (!getCheckInputsExist())
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001986 return true;
1987
1988 // stdin always exists.
1989 if (Value == "-")
1990 return true;
1991
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001992 if (getVFS().exists(Value))
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001993 return true;
1994
Nico Weber9b2830b2019-05-23 17:58:33 +00001995 if (IsCLMode()) {
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001996 if (!llvm::sys::path::is_absolute(Twine(Value)) &&
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001997 llvm::sys::Process::FindInEnvPath("LIB", Value))
1998 return true;
1999
2000 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
2001 // Arguments to the /link flag might cause the linker to search for object
2002 // and library files in paths we don't know about. Don't error in such
2003 // cases.
2004 return true;
2005 }
2006 }
Hans Wennborg23d26a32014-06-18 17:21:50 +00002007
Nico Weber9b2830b2019-05-23 17:58:33 +00002008 if (TypoCorrect) {
2009 // Check if the filename is a typo for an option flag. OptTable thinks
2010 // that all args that are not known options and that start with / are
2011 // filenames, but e.g. `/diagnostic:caret` is more likely a typo for
2012 // the option `/diagnostics:caret` than a reference to a file in the root
2013 // directory.
2014 unsigned IncludedFlagsBitmask;
2015 unsigned ExcludedFlagsBitmask;
2016 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
2017 getIncludeExcludeOptionFlagMasks(IsCLMode());
2018 std::string Nearest;
2019 if (getOpts().findNearest(Value, Nearest, IncludedFlagsBitmask,
2020 ExcludedFlagsBitmask) <= 1) {
2021 Diag(clang::diag::err_drv_no_such_file_with_suggestion)
Michael J. Spencer7e48b402019-05-28 22:21:47 +00002022 << Value << Nearest;
Nico Weber9b2830b2019-05-23 17:58:33 +00002023 return false;
2024 }
2025 }
2026
Michael J. Spencer7e48b402019-05-28 22:21:47 +00002027 Diag(clang::diag::err_drv_no_such_file) << Value;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002028 return false;
2029}
2030
Chad Rosierecdede82011-08-12 22:08:57 +00002031// Construct a the list of inputs and their types.
Hans Wennborg55362852014-05-02 22:55:30 +00002032void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
Chad Rosierecdede82011-08-12 22:08:57 +00002033 InputList &Inputs) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002034 // Track the current user specified (-x) input. We also explicitly track the
2035 // argument used to set the type; we only want to claim the type when we
2036 // actually use it, so we warn about unused -x arguments.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002037 types::ID InputType = types::TY_Nothing;
Craig Topper92fc2df2014-05-17 16:56:41 +00002038 Arg *InputTypeArg = nullptr;
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002039
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002040 // The last /TC or /TP option sets the input type to C or C++ globally.
Ehsan Akhgaric249abb2014-09-12 21:44:24 +00002041 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
2042 options::OPT__SLASH_TP)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002043 InputTypeArg = TCTP;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002044 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002045 ? types::TY_C
2046 : types::TY_CXX;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002047
Richard Smith0aef3052017-02-18 01:14:43 +00002048 Arg *Previous = nullptr;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002049 bool ShowNote = false;
Simon Atanasyan27c0f202019-04-02 18:03:15 +00002050 for (Arg *A :
2051 Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
Richard Smith0aef3052017-02-18 01:14:43 +00002052 if (Previous) {
2053 Diag(clang::diag::warn_drv_overriding_flag_option)
2054 << Previous->getSpelling() << A->getSpelling();
2055 ShowNote = true;
2056 }
2057 Previous = A;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002058 }
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002059 if (ShowNote)
2060 Diag(clang::diag::note_drv_t_option_is_global);
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002061
2062 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
2063 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
2064 }
2065
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00002066 for (Arg *A : Args) {
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00002067 if (A->getOption().getKind() == Option::InputClass) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002068 const char *Value = A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002069 types::ID Ty = types::TY_INVALID;
2070
2071 // Infer the input type if necessary.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002072 if (InputType == types::TY_Nothing) {
2073 // If there was an explicit arg for this, claim it.
2074 if (InputTypeArg)
2075 InputTypeArg->claim();
2076
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002077 // stdin must be handled specially.
2078 if (memcmp(Value, "-", 2) == 0) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002079 // If running with -E, treat as a C input (this changes the builtin
2080 // macros, for example). This may be overridden by -ObjC below.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002081 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002082 // Otherwise emit an error but still use a valid type to avoid
2083 // spurious errors (e.g., no inputs).
Hans Wennborg70850d82013-07-18 20:29:38 +00002084 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
Hans Wennborgcfdd8b52014-01-29 01:04:40 +00002085 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
2086 : clang::diag::err_drv_unknown_stdin_type);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002087 Ty = types::TY_C;
2088 } else {
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002089 // Otherwise lookup by extension.
Reid Klecknera643e642018-12-26 21:04:08 +00002090 // Fallback is C if invoked as C preprocessor, C++ if invoked with
2091 // clang-cl /E, or Object otherwise.
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002092 // We use a host hook here because Darwin at least has its own
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002093 // idea of what .s is.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002094 if (const char *Ext = strrchr(Value, '.'))
Daniel Dunbarcc7df6c2010-08-02 05:43:56 +00002095 Ty = TC.LookupTypeForExtension(Ext + 1);
Daniel Dunbarea9f0322009-03-20 23:39:23 +00002096
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002097 if (Ty == types::TY_INVALID) {
Hans Wennborg70850d82013-07-18 20:29:38 +00002098 if (CCCIsCPP())
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002099 Ty = types::TY_C;
Reid Klecknera643e642018-12-26 21:04:08 +00002100 else if (IsCLMode() && Args.hasArgNoClaim(options::OPT_E))
2101 Ty = types::TY_CXX;
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002102 else
2103 Ty = types::TY_Object;
2104 }
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002105
2106 // If the driver is invoked as C++ compiler (like clang++ or c++) it
2107 // should autodetect some input files as C++ for g++ compatibility.
Hans Wennborg70850d82013-07-18 20:29:38 +00002108 if (CCCIsCXX()) {
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002109 types::ID OldTy = Ty;
2110 Ty = types::lookupCXXTypeForCType(Ty);
2111
2112 if (Ty != OldTy)
2113 Diag(clang::diag::warn_drv_treating_input_as_cxx)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002114 << getTypeName(OldTy) << getTypeName(Ty);
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002115 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002116 }
2117
Daniel Dunbar82b22102009-05-18 21:47:54 +00002118 // -ObjC and -ObjC++ override the default language, but only for "source
2119 // files". We just treat everything that isn't a linker input as a
2120 // source file.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002121 //
Daniel Dunbar82b22102009-05-18 21:47:54 +00002122 // FIXME: Clean this up if we move the phase sequence into the type.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002123 if (Ty != types::TY_Object) {
2124 if (Args.hasArg(options::OPT_ObjC))
2125 Ty = types::TY_ObjC;
2126 else if (Args.hasArg(options::OPT_ObjCXX))
2127 Ty = types::TY_ObjCXX;
2128 }
2129 } else {
2130 assert(InputTypeArg && "InputType set w/o InputTypeArg");
Ehsan Akhgari7e954ea2014-09-12 18:15:10 +00002131 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
2132 // If emulating cl.exe, make sure that /TC and /TP don't affect input
2133 // object files.
2134 const char *Ext = strrchr(Value, '.');
2135 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
2136 Ty = types::TY_Object;
2137 }
2138 if (Ty == types::TY_INVALID) {
2139 Ty = InputType;
2140 InputTypeArg->claim();
2141 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002142 }
2143
Nico Weber9b2830b2019-05-23 17:58:33 +00002144 if (DiagnoseInputExistence(Args, Value, Ty, /*TypoCorrect=*/true))
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002145 Inputs.push_back(std::make_pair(Ty, A));
2146
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002147 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
2148 StringRef Value = A->getValue();
Nico Weber9b2830b2019-05-23 17:58:33 +00002149 if (DiagnoseInputExistence(Args, Value, types::TY_C,
2150 /*TypoCorrect=*/false)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002151 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002152 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
2153 }
2154 A->claim();
2155 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
2156 StringRef Value = A->getValue();
Nico Weber9b2830b2019-05-23 17:58:33 +00002157 if (DiagnoseInputExistence(Args, Value, types::TY_CXX,
2158 /*TypoCorrect=*/false)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002159 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002160 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
2161 }
2162 A->claim();
Michael J. Spencer66e2b202012-10-19 22:37:06 +00002163 } else if (A->getOption().hasFlag(options::LinkerInput)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002164 // Just treat as object type, we could make a special type for this if
2165 // necessary.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002166 Inputs.push_back(std::make_pair(types::TY_Object, A));
2167
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00002168 } else if (A->getOption().matches(options::OPT_x)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002169 InputTypeArg = A;
Richard Smithbd55daf2012-11-01 04:30:05 +00002170 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
Chad Rosier706c2352012-04-07 00:01:31 +00002171 A->claim();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002172
2173 // Follow gcc behavior and treat as linker input for invalid -x
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002174 // options. Its not clear why we shouldn't just revert to unknown; but
Michael J. Spencer1a4fe8c2010-12-17 21:22:33 +00002175 // this isn't very important, we might as well be bug compatible.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002176 if (!InputType) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002177 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002178 InputType = types::TY_Object;
2179 }
Hans Wennborg091f1b62017-01-27 17:09:41 +00002180 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
2181 assert(A->getNumValues() == 1 && "The /U option has one value.");
2182 StringRef Val = A->getValue(0);
2183 if (Val.find_first_of("/\\") != StringRef::npos) {
2184 // Warn about e.g. "/Users/me/myfile.c".
2185 Diag(diag::warn_slash_u_filename) << Val;
2186 Diag(diag::note_use_dashdash);
2187 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002188 }
2189 }
Hans Wennborg70850d82013-07-18 20:29:38 +00002190 if (CCCIsCPP() && Inputs.empty()) {
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002191 // If called as standalone preprocessor, stdin is processed
2192 // if no other input is present.
David Blaikie0aaa7622017-01-13 17:34:15 +00002193 Arg *A = MakeInputArg(Args, *Opts, "-");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002194 Inputs.push_back(std::make_pair(types::TY_C, A));
2195 }
Chad Rosierecdede82011-08-12 22:08:57 +00002196}
2197
Samuel Antao64e965e2016-09-30 15:34:19 +00002198namespace {
2199/// Provides a convenient interface for different programming models to generate
2200/// the required device actions.
2201class OffloadingActionBuilder final {
2202 /// Flag used to trace errors in the builder.
2203 bool IsValid = false;
2204
2205 /// The compilation that is using this builder.
2206 Compilation &C;
2207
Samuel Antao64e965e2016-09-30 15:34:19 +00002208 /// Map between an input argument and the offload kinds used to process it.
2209 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
2210
2211 /// Builder interface. It doesn't build anything or keep any state.
2212 class DeviceActionBuilder {
2213 public:
2214 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
2215
2216 enum ActionBuilderReturnCode {
2217 // The builder acted successfully on the current action.
2218 ABRT_Success,
2219 // The builder didn't have to act on the current action.
2220 ABRT_Inactive,
2221 // The builder was successful and requested the host action to not be
2222 // generated.
2223 ABRT_Ignore_Host,
2224 };
2225
2226 protected:
2227 /// Compilation associated with this builder.
2228 Compilation &C;
2229
2230 /// Tool chains associated with this builder. The same programming
2231 /// model may have associated one or more tool chains.
2232 SmallVector<const ToolChain *, 2> ToolChains;
2233
2234 /// The derived arguments associated with this builder.
2235 DerivedArgList &Args;
2236
2237 /// The inputs associated with this builder.
2238 const Driver::InputList &Inputs;
2239
2240 /// The associated offload kind.
2241 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
2242
2243 public:
2244 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
2245 const Driver::InputList &Inputs,
2246 Action::OffloadKind AssociatedOffloadKind)
2247 : C(C), Args(Args), Inputs(Inputs),
2248 AssociatedOffloadKind(AssociatedOffloadKind) {}
2249 virtual ~DeviceActionBuilder() {}
2250
2251 /// Fill up the array \a DA with all the device dependences that should be
2252 /// added to the provided host action \a HostAction. By default it is
2253 /// inactive.
2254 virtual ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002255 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2256 phases::ID CurPhase, phases::ID FinalPhase,
2257 PhasesTy &Phases) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002258 return ABRT_Inactive;
2259 }
2260
2261 /// Update the state to include the provided host action \a HostAction as a
2262 /// dependency of the current device action. By default it is inactive.
2263 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
2264 return ABRT_Inactive;
2265 }
2266
2267 /// Append top level actions generated by the builder. Return true if errors
2268 /// were found.
2269 virtual void appendTopLevelActions(ActionList &AL) {}
2270
2271 /// Append linker actions generated by the builder. Return true if errors
2272 /// were found.
2273 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
2274
2275 /// Initialize the builder. Return true if any initialization errors are
2276 /// found.
2277 virtual bool initialize() { return false; }
2278
Samuel Antao69d6f312016-10-27 17:50:43 +00002279 /// Return true if the builder can use bundling/unbundling.
2280 virtual bool canUseBundlerUnbundler() const { return false; }
2281
Samuel Antao64e965e2016-09-30 15:34:19 +00002282 /// Return true if this builder is valid. We have a valid builder if we have
2283 /// associated device tool chains.
2284 bool isValid() { return !ToolChains.empty(); }
2285
2286 /// Return the associated offload kind.
2287 Action::OffloadKind getAssociatedOffloadKind() {
2288 return AssociatedOffloadKind;
2289 }
2290 };
2291
Yaxun Liu3af038b2018-05-30 00:49:10 +00002292 /// Base class for CUDA/HIP action builder. It injects device code in
2293 /// the host backend action.
2294 class CudaActionBuilderBase : public DeviceActionBuilder {
2295 protected:
Samuel Antao64e965e2016-09-30 15:34:19 +00002296 /// Flags to signal if the user requested host-only or device-only
2297 /// compilation.
2298 bool CompileHostOnly = false;
2299 bool CompileDeviceOnly = false;
2300
2301 /// List of GPU architectures to use in this compilation.
2302 SmallVector<CudaArch, 4> GpuArchList;
2303
2304 /// The CUDA actions for the current input.
2305 ActionList CudaDeviceActions;
2306
2307 /// The CUDA fat binary if it was generated for the current input.
2308 Action *CudaFatBinary = nullptr;
2309
2310 /// Flag that is set to true if this builder acted on the current input.
2311 bool IsActive = false;
Yaxun Liuab851932019-03-05 16:07:56 +00002312
2313 /// Flag for -fgpu-rdc.
2314 bool Relocatable = false;
Yaxun Liu3af038b2018-05-30 00:49:10 +00002315 public:
2316 CudaActionBuilderBase(Compilation &C, DerivedArgList &Args,
2317 const Driver::InputList &Inputs,
2318 Action::OffloadKind OFKind)
2319 : DeviceActionBuilder(C, Args, Inputs, OFKind) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002320
Yaxun Liu3af038b2018-05-30 00:49:10 +00002321 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2322 // While generating code for CUDA, we only depend on the host input action
2323 // to trigger the creation of all the CUDA device actions.
2324
2325 // If we are dealing with an input action, replicate it for each GPU
2326 // architecture. If we are in host-only mode we return 'success' so that
2327 // the host uses the CUDA offload kind.
2328 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2329 assert(!GpuArchList.empty() &&
2330 "We should have at least one GPU architecture.");
2331
2332 // If the host input is not CUDA or HIP, we don't need to bother about
2333 // this input.
2334 if (IA->getType() != types::TY_CUDA &&
2335 IA->getType() != types::TY_HIP) {
2336 // The builder will ignore this input.
2337 IsActive = false;
2338 return ABRT_Inactive;
2339 }
2340
2341 // Set the flag to true, so that the builder acts on the current input.
2342 IsActive = true;
2343
2344 if (CompileHostOnly)
2345 return ABRT_Success;
2346
2347 // Replicate inputs for each GPU architecture.
2348 auto Ty = IA->getType() == types::TY_HIP ? types::TY_HIP_DEVICE
2349 : types::TY_CUDA_DEVICE;
2350 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2351 CudaDeviceActions.push_back(
2352 C.MakeAction<InputAction>(IA->getInputArg(), Ty));
2353 }
2354
2355 return ABRT_Success;
2356 }
2357
2358 // If this is an unbundling action use it as is for each CUDA toolchain.
2359 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
Yaxun Liuab851932019-03-05 16:07:56 +00002360
2361 // If -fgpu-rdc is disabled, should not unbundle since there is no
2362 // device code to link.
2363 if (!Relocatable)
2364 return ABRT_Inactive;
2365
Yaxun Liu3af038b2018-05-30 00:49:10 +00002366 CudaDeviceActions.clear();
Aaron Enye Shibea57bb2019-01-04 19:05:41 +00002367 auto *IA = cast<InputAction>(UA->getInputs().back());
2368 std::string FileName = IA->getInputArg().getAsString(Args);
2369 // Check if the type of the file is the same as the action. Do not
2370 // unbundle it if it is not. Do not unbundle .so files, for example,
2371 // which are not object files.
2372 if (IA->getType() == types::TY_Object &&
2373 (!llvm::sys::path::has_extension(FileName) ||
2374 types::lookupTypeForExtension(
2375 llvm::sys::path::extension(FileName).drop_front()) !=
2376 types::TY_Object))
2377 return ABRT_Inactive;
2378
Yaxun Liu3af038b2018-05-30 00:49:10 +00002379 for (auto Arch : GpuArchList) {
2380 CudaDeviceActions.push_back(UA);
2381 UA->registerDependentActionInfo(ToolChains[0], CudaArchToString(Arch),
2382 AssociatedOffloadKind);
2383 }
2384 return ABRT_Success;
2385 }
2386
2387 return IsActive ? ABRT_Success : ABRT_Inactive;
2388 }
2389
2390 void appendTopLevelActions(ActionList &AL) override {
2391 // Utility to append actions to the top level list.
2392 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
2393 OffloadAction::DeviceDependences Dep;
2394 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
2395 AssociatedOffloadKind);
2396 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2397 };
2398
2399 // If we have a fat binary, add it to the list.
2400 if (CudaFatBinary) {
2401 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
2402 CudaDeviceActions.clear();
2403 CudaFatBinary = nullptr;
2404 return;
2405 }
2406
2407 if (CudaDeviceActions.empty())
2408 return;
2409
2410 // If we have CUDA actions at this point, that's because we have a have
2411 // partial compilation, so we should have an action for each GPU
2412 // architecture.
2413 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2414 "Expecting one action per GPU architecture.");
2415 assert(ToolChains.size() == 1 &&
2416 "Expecting to have a sing CUDA toolchain.");
2417 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
2418 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
2419
2420 CudaDeviceActions.clear();
2421 }
2422
2423 bool initialize() override {
2424 assert(AssociatedOffloadKind == Action::OFK_Cuda ||
2425 AssociatedOffloadKind == Action::OFK_HIP);
2426
2427 // We don't need to support CUDA.
2428 if (AssociatedOffloadKind == Action::OFK_Cuda &&
2429 !C.hasOffloadToolChain<Action::OFK_Cuda>())
2430 return false;
2431
2432 // We don't need to support HIP.
2433 if (AssociatedOffloadKind == Action::OFK_HIP &&
2434 !C.hasOffloadToolChain<Action::OFK_HIP>())
2435 return false;
2436
Yaxun Liuab851932019-03-05 16:07:56 +00002437 Relocatable = Args.hasFlag(options::OPT_fgpu_rdc,
2438 options::OPT_fno_gpu_rdc, /*Default=*/false);
2439
Yaxun Liu3af038b2018-05-30 00:49:10 +00002440 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
2441 assert(HostTC && "No toolchain for host compilation.");
2442 if (HostTC->getTriple().isNVPTX() ||
2443 HostTC->getTriple().getArch() == llvm::Triple::amdgcn) {
2444 // We do not support targeting NVPTX/AMDGCN for host compilation. Throw
2445 // an error and abort pipeline construction early so we don't trip
2446 // asserts that assume device-side compilation.
2447 C.getDriver().Diag(diag::err_drv_cuda_host_arch)
2448 << HostTC->getTriple().getArchName();
2449 return true;
2450 }
2451
2452 ToolChains.push_back(
2453 AssociatedOffloadKind == Action::OFK_Cuda
2454 ? C.getSingleOffloadToolChain<Action::OFK_Cuda>()
2455 : C.getSingleOffloadToolChain<Action::OFK_HIP>());
2456
2457 Arg *PartialCompilationArg = Args.getLastArg(
2458 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
2459 options::OPT_cuda_compile_host_device);
2460 CompileHostOnly = PartialCompilationArg &&
2461 PartialCompilationArg->getOption().matches(
2462 options::OPT_cuda_host_only);
2463 CompileDeviceOnly = PartialCompilationArg &&
2464 PartialCompilationArg->getOption().matches(
2465 options::OPT_cuda_device_only);
2466
2467 // Collect all cuda_gpu_arch parameters, removing duplicates.
2468 std::set<CudaArch> GpuArchs;
2469 bool Error = false;
2470 for (Arg *A : Args) {
2471 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
2472 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
2473 continue;
2474 A->claim();
2475
2476 const StringRef ArchStr = A->getValue();
2477 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
2478 ArchStr == "all") {
2479 GpuArchs.clear();
2480 continue;
2481 }
2482 CudaArch Arch = StringToCudaArch(ArchStr);
2483 if (Arch == CudaArch::UNKNOWN) {
2484 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
2485 Error = true;
2486 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
2487 GpuArchs.insert(Arch);
2488 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
2489 GpuArchs.erase(Arch);
2490 else
2491 llvm_unreachable("Unexpected option.");
2492 }
2493
2494 // Collect list of GPUs remaining in the set.
2495 for (CudaArch Arch : GpuArchs)
2496 GpuArchList.push_back(Arch);
2497
2498 // Default to sm_20 which is the lowest common denominator for
2499 // supported GPUs. sm_20 code should work correctly, if
2500 // suboptimally, on all newer GPUs.
2501 if (GpuArchList.empty())
2502 GpuArchList.push_back(CudaArch::SM_20);
2503
2504 return Error;
2505 }
2506 };
2507
2508 /// \brief CUDA action builder. It injects device code in the host backend
2509 /// action.
2510 class CudaActionBuilder final : public CudaActionBuilderBase {
Samuel Antao64e965e2016-09-30 15:34:19 +00002511 public:
2512 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
2513 const Driver::InputList &Inputs)
Yaxun Liu3af038b2018-05-30 00:49:10 +00002514 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_Cuda) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002515
2516 ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002517 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2518 phases::ID CurPhase, phases::ID FinalPhase,
2519 PhasesTy &Phases) override {
Samuel Antao64e965e2016-09-30 15:34:19 +00002520 if (!IsActive)
2521 return ABRT_Inactive;
2522
2523 // If we don't have more CUDA actions, we don't have any dependences to
2524 // create for the host.
2525 if (CudaDeviceActions.empty())
2526 return ABRT_Success;
2527
2528 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2529 "Expecting one action per GPU architecture.");
2530 assert(!CompileHostOnly &&
2531 "Not expecting CUDA actions in host-only compilation.");
2532
2533 // If we are generating code for the device or we are in a backend phase,
2534 // we attempt to generate the fat binary. We compile each arch to ptx and
2535 // assemble to cubin, then feed the cubin *and* the ptx into a device
2536 // "link" action, which uses fatbinary to combine these cubins into one
2537 // fatbin. The fatbin is then an input to the host action if not in
2538 // device-only mode.
2539 if (CompileDeviceOnly || CurPhase == phases::Backend) {
2540 ActionList DeviceActions;
2541 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2542 // Produce the device action from the current phase up to the assemble
2543 // phase.
2544 for (auto Ph : Phases) {
2545 // Skip the phases that were already dealt with.
2546 if (Ph < CurPhase)
2547 continue;
2548 // We have to be consistent with the host final phase.
2549 if (Ph > FinalPhase)
2550 break;
2551
2552 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
Artem Belevichecb178b2018-03-21 22:22:59 +00002553 C, Args, Ph, CudaDeviceActions[I], Action::OFK_Cuda);
Samuel Antao64e965e2016-09-30 15:34:19 +00002554
2555 if (Ph == phases::Assemble)
2556 break;
2557 }
2558
2559 // If we didn't reach the assemble phase, we can't generate the fat
2560 // binary. We don't need to generate the fat binary if we are not in
2561 // device-only mode.
2562 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
2563 CompileDeviceOnly)
2564 continue;
2565
2566 Action *AssembleAction = CudaDeviceActions[I];
2567 assert(AssembleAction->getType() == types::TY_Object);
2568 assert(AssembleAction->getInputs().size() == 1);
2569
2570 Action *BackendAction = AssembleAction->getInputs()[0];
2571 assert(BackendAction->getType() == types::TY_PP_Asm);
2572
2573 for (auto &A : {AssembleAction, BackendAction}) {
2574 OffloadAction::DeviceDependences DDep;
2575 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
2576 Action::OFK_Cuda);
2577 DeviceActions.push_back(
2578 C.MakeAction<OffloadAction>(DDep, A->getType()));
2579 }
2580 }
2581
2582 // We generate the fat binary if we have device input actions.
2583 if (!DeviceActions.empty()) {
2584 CudaFatBinary =
2585 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
2586
2587 if (!CompileDeviceOnly) {
2588 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2589 Action::OFK_Cuda);
2590 // Clear the fat binary, it is already a dependence to an host
2591 // action.
2592 CudaFatBinary = nullptr;
2593 }
2594
2595 // Remove the CUDA actions as they are already connected to an host
2596 // action or fat binary.
2597 CudaDeviceActions.clear();
2598 }
2599
2600 // We avoid creating host action in device-only mode.
2601 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Samuel Antao5b1a89a2016-10-27 00:53:34 +00002602 } else if (CurPhase > phases::Backend) {
2603 // If we are past the backend phase and still have a device action, we
2604 // don't have to do anything as this action is already a device
2605 // top-level action.
2606 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002607 }
2608
2609 assert(CurPhase < phases::Backend && "Generating single CUDA "
2610 "instructions should only occur "
2611 "before the backend phase!");
2612
2613 // By default, we produce an action for each device arch.
2614 for (Action *&A : CudaDeviceActions)
2615 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2616
2617 return ABRT_Success;
2618 }
Yaxun Liu3af038b2018-05-30 00:49:10 +00002619 };
2620 /// \brief HIP action builder. It injects device code in the host backend
2621 /// action.
2622 class HIPActionBuilder final : public CudaActionBuilderBase {
2623 /// The linker inputs obtained for each device arch.
2624 SmallVector<ActionList, 8> DeviceLinkerInputs;
Samuel Antao64e965e2016-09-30 15:34:19 +00002625
Yaxun Liu3af038b2018-05-30 00:49:10 +00002626 public:
2627 HIPActionBuilder(Compilation &C, DerivedArgList &Args,
2628 const Driver::InputList &Inputs)
Yaxun Liuab851932019-03-05 16:07:56 +00002629 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_HIP) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002630
Yaxun Liu3af038b2018-05-30 00:49:10 +00002631 bool canUseBundlerUnbundler() const override { return true; }
Samuel Antao64e965e2016-09-30 15:34:19 +00002632
Yaxun Liu3af038b2018-05-30 00:49:10 +00002633 ActionBuilderReturnCode
2634 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2635 phases::ID CurPhase, phases::ID FinalPhase,
2636 PhasesTy &Phases) override {
2637 // amdgcn does not support linking of object files, therefore we skip
Yaxun Liu97670892018-10-02 17:48:54 +00002638 // backend and assemble phases to output LLVM IR. Except for generating
2639 // non-relocatable device coee, where we generate fat binary for device
2640 // code and pass to host in Backend phase.
2641 if (CudaDeviceActions.empty() ||
2642 (CurPhase == phases::Backend && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002643 CurPhase == phases::Assemble)
2644 return ABRT_Success;
2645
Yaxun Liu97670892018-10-02 17:48:54 +00002646 assert(((CurPhase == phases::Link && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002647 CudaDeviceActions.size() == GpuArchList.size()) &&
2648 "Expecting one action per GPU architecture.");
2649 assert(!CompileHostOnly &&
2650 "Not expecting CUDA actions in host-only compilation.");
2651
Yaxun Liu97670892018-10-02 17:48:54 +00002652 if (!Relocatable && CurPhase == phases::Backend) {
2653 // If we are in backend phase, we attempt to generate the fat binary.
2654 // We compile each arch to IR and use a link action to generate code
2655 // object containing ISA. Then we use a special "link" action to create
2656 // a fat binary containing all the code objects for different GPU's.
2657 // The fat binary is then an input to the host action.
2658 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2659 // Create a link action to link device IR with device library
2660 // and generate ISA.
2661 ActionList AL;
2662 AL.push_back(CudaDeviceActions[I]);
2663 CudaDeviceActions[I] =
2664 C.MakeAction<LinkJobAction>(AL, types::TY_Image);
2665
2666 // OffloadingActionBuilder propagates device arch until an offload
2667 // action. Since the next action for creating fatbin does
2668 // not have device arch, whereas the above link action and its input
2669 // have device arch, an offload action is needed to stop the null
2670 // device arch of the next action being propagated to the above link
2671 // action.
2672 OffloadAction::DeviceDependences DDep;
2673 DDep.add(*CudaDeviceActions[I], *ToolChains.front(),
2674 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2675 CudaDeviceActions[I] = C.MakeAction<OffloadAction>(
2676 DDep, CudaDeviceActions[I]->getType());
2677 }
2678 // Create HIP fat binary with a special "link" action.
2679 CudaFatBinary =
2680 C.MakeAction<LinkJobAction>(CudaDeviceActions,
2681 types::TY_HIP_FATBIN);
2682
Yaxun Liu2bcc9512018-11-14 04:47:31 +00002683 if (!CompileDeviceOnly) {
2684 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2685 AssociatedOffloadKind);
2686 // Clear the fat binary, it is already a dependence to an host
2687 // action.
2688 CudaFatBinary = nullptr;
2689 }
Yaxun Liu97670892018-10-02 17:48:54 +00002690
2691 // Remove the CUDA actions as they are already connected to an host
2692 // action or fat binary.
2693 CudaDeviceActions.clear();
2694
Yaxun Liu2bcc9512018-11-14 04:47:31 +00002695 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Yaxun Liu97670892018-10-02 17:48:54 +00002696 } else if (CurPhase == phases::Link) {
2697 // Save CudaDeviceActions to DeviceLinkerInputs for each GPU subarch.
2698 // This happens to each device action originated from each input file.
2699 // Later on, device actions in DeviceLinkerInputs are used to create
2700 // device link actions in appendLinkDependences and the created device
2701 // link actions are passed to the offload action as device dependence.
Yaxun Liu3af038b2018-05-30 00:49:10 +00002702 DeviceLinkerInputs.resize(CudaDeviceActions.size());
2703 auto LI = DeviceLinkerInputs.begin();
2704 for (auto *A : CudaDeviceActions) {
2705 LI->push_back(A);
2706 ++LI;
Samuel Antao64e965e2016-09-30 15:34:19 +00002707 }
2708
Yaxun Liu3af038b2018-05-30 00:49:10 +00002709 // We will pass the device action as a host dependence, so we don't
2710 // need to do anything else with them.
2711 CudaDeviceActions.clear();
Samuel Antao64e965e2016-09-30 15:34:19 +00002712 return ABRT_Success;
2713 }
2714
Yaxun Liu3af038b2018-05-30 00:49:10 +00002715 // By default, we produce an action for each device arch.
2716 for (Action *&A : CudaDeviceActions)
2717 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A,
2718 AssociatedOffloadKind);
2719
2720 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002721 }
2722
Yaxun Liu3af038b2018-05-30 00:49:10 +00002723 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2724 // Append a new link action for each device.
2725 unsigned I = 0;
2726 for (auto &LI : DeviceLinkerInputs) {
2727 auto *DeviceLinkAction =
2728 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2729 DA.add(*DeviceLinkAction, *ToolChains[0],
2730 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2731 ++I;
Samuel Antao64e965e2016-09-30 15:34:19 +00002732 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002733 }
2734 };
2735
Samuel Antao28c4f182016-10-27 17:08:03 +00002736 /// OpenMP action builder. The host bitcode is passed to the device frontend
2737 /// and all the device linked images are passed to the host link phase.
2738 class OpenMPActionBuilder final : public DeviceActionBuilder {
2739 /// The OpenMP actions for the current input.
2740 ActionList OpenMPDeviceActions;
2741
2742 /// The linker inputs obtained for each toolchain.
2743 SmallVector<ActionList, 8> DeviceLinkerInputs;
2744
2745 public:
2746 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2747 const Driver::InputList &Inputs)
2748 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2749
2750 ActionBuilderReturnCode
2751 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2752 phases::ID CurPhase, phases::ID FinalPhase,
2753 PhasesTy &Phases) override {
Alexey Bataeva5178f52018-09-28 16:17:59 +00002754 if (OpenMPDeviceActions.empty())
2755 return ABRT_Inactive;
Samuel Antao28c4f182016-10-27 17:08:03 +00002756
2757 // We should always have an action for each input.
2758 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2759 "Number of OpenMP actions and toolchains do not match.");
2760
2761 // The host only depends on device action in the linking phase, when all
2762 // the device images have to be embedded in the host image.
2763 if (CurPhase == phases::Link) {
2764 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2765 "Toolchains and linker inputs sizes do not match.");
2766 auto LI = DeviceLinkerInputs.begin();
2767 for (auto *A : OpenMPDeviceActions) {
2768 LI->push_back(A);
2769 ++LI;
2770 }
2771
2772 // We passed the device action as a host dependence, so we don't need to
2773 // do anything else with them.
2774 OpenMPDeviceActions.clear();
2775 return ABRT_Success;
2776 }
2777
2778 // By default, we produce an action for each device arch.
2779 for (Action *&A : OpenMPDeviceActions)
2780 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2781
2782 return ABRT_Success;
2783 }
2784
2785 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2786
2787 // If this is an input action replicate it for each OpenMP toolchain.
2788 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2789 OpenMPDeviceActions.clear();
2790 for (unsigned I = 0; I < ToolChains.size(); ++I)
2791 OpenMPDeviceActions.push_back(
2792 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2793 return ABRT_Success;
2794 }
2795
Samuel Antaofab4f372016-10-27 18:00:51 +00002796 // If this is an unbundling action use it as is for each OpenMP toolchain.
2797 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2798 OpenMPDeviceActions.clear();
Alexey Bataeva5178f52018-09-28 16:17:59 +00002799 auto *IA = cast<InputAction>(UA->getInputs().back());
2800 std::string FileName = IA->getInputArg().getAsString(Args);
2801 // Check if the type of the file is the same as the action. Do not
2802 // unbundle it if it is not. Do not unbundle .so files, for example,
2803 // which are not object files.
2804 if (IA->getType() == types::TY_Object &&
2805 (!llvm::sys::path::has_extension(FileName) ||
2806 types::lookupTypeForExtension(
2807 llvm::sys::path::extension(FileName).drop_front()) !=
2808 types::TY_Object))
2809 return ABRT_Inactive;
Samuel Antaofab4f372016-10-27 18:00:51 +00002810 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2811 OpenMPDeviceActions.push_back(UA);
2812 UA->registerDependentActionInfo(
2813 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2814 }
2815 return ABRT_Success;
2816 }
2817
Samuel Antao28c4f182016-10-27 17:08:03 +00002818 // When generating code for OpenMP we use the host compile phase result as
2819 // a dependence to the device compile phase so that it can learn what
2820 // declarations should be emitted. However, this is not the only use for
2821 // the host action, so we prevent it from being collapsed.
2822 if (isa<CompileJobAction>(HostAction)) {
2823 HostAction->setCannotBeCollapsedWithNextDependentAction();
2824 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2825 "Toolchains and device action sizes do not match.");
2826 OffloadAction::HostDependence HDep(
2827 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2828 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2829 auto TC = ToolChains.begin();
2830 for (Action *&A : OpenMPDeviceActions) {
2831 assert(isa<CompileJobAction>(A));
2832 OffloadAction::DeviceDependences DDep;
2833 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2834 A = C.MakeAction<OffloadAction>(HDep, DDep);
2835 ++TC;
2836 }
2837 }
2838 return ABRT_Success;
2839 }
2840
Samuel Antao69d6f312016-10-27 17:50:43 +00002841 void appendTopLevelActions(ActionList &AL) override {
2842 if (OpenMPDeviceActions.empty())
2843 return;
2844
2845 // We should always have an action for each input.
2846 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2847 "Number of OpenMP actions and toolchains do not match.");
2848
2849 // Append all device actions followed by the proper offload action.
2850 auto TI = ToolChains.begin();
2851 for (auto *A : OpenMPDeviceActions) {
2852 OffloadAction::DeviceDependences Dep;
2853 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2854 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2855 ++TI;
2856 }
2857 // We no longer need the action stored in this builder.
2858 OpenMPDeviceActions.clear();
2859 }
2860
Samuel Antao28c4f182016-10-27 17:08:03 +00002861 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2862 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2863 "Toolchains and linker inputs sizes do not match.");
2864
2865 // Append a new link action for each device.
2866 auto TC = ToolChains.begin();
2867 for (auto &LI : DeviceLinkerInputs) {
2868 auto *DeviceLinkAction =
2869 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2870 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2871 Action::OFK_OpenMP);
2872 ++TC;
2873 }
2874 }
2875
2876 bool initialize() override {
2877 // Get the OpenMP toolchains. If we don't get any, the action builder will
2878 // know there is nothing to do related to OpenMP offloading.
2879 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2880 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2881 ++TI)
2882 ToolChains.push_back(TI->second);
2883
2884 DeviceLinkerInputs.resize(ToolChains.size());
2885 return false;
2886 }
Samuel Antao69d6f312016-10-27 17:50:43 +00002887
2888 bool canUseBundlerUnbundler() const override {
2889 // OpenMP should use bundled files whenever possible.
2890 return true;
2891 }
Samuel Antao28c4f182016-10-27 17:08:03 +00002892 };
2893
2894 ///
2895 /// TODO: Add the implementation for other specialized builders here.
2896 ///
Samuel Antao64e965e2016-09-30 15:34:19 +00002897
2898 /// Specialized builders being used by this offloading action builder.
2899 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2900
Samuel Antao69d6f312016-10-27 17:50:43 +00002901 /// Flag set to true if all valid builders allow file bundling/unbundling.
2902 bool CanUseBundler;
2903
Samuel Antao64e965e2016-09-30 15:34:19 +00002904public:
2905 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2906 const Driver::InputList &Inputs)
Samuel Antao10e905c2016-10-27 01:08:58 +00002907 : C(C) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002908 // Create a specialized builder for each device toolchain.
2909
2910 IsValid = true;
2911
2912 // Create a specialized builder for CUDA.
2913 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2914
Yaxun Liu3af038b2018-05-30 00:49:10 +00002915 // Create a specialized builder for HIP.
2916 SpecializedBuilders.push_back(new HIPActionBuilder(C, Args, Inputs));
2917
Samuel Antao28c4f182016-10-27 17:08:03 +00002918 // Create a specialized builder for OpenMP.
2919 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2920
Samuel Antao64e965e2016-09-30 15:34:19 +00002921 //
2922 // TODO: Build other specialized builders here.
2923 //
2924
Samuel Antao69d6f312016-10-27 17:50:43 +00002925 // Initialize all the builders, keeping track of errors. If all valid
2926 // builders agree that we can use bundling, set the flag to true.
2927 unsigned ValidBuilders = 0u;
2928 unsigned ValidBuildersSupportingBundling = 0u;
2929 for (auto *SB : SpecializedBuilders) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002930 IsValid = IsValid && !SB->initialize();
Samuel Antao69d6f312016-10-27 17:50:43 +00002931
2932 // Update the counters if the builder is valid.
2933 if (SB->isValid()) {
2934 ++ValidBuilders;
2935 if (SB->canUseBundlerUnbundler())
2936 ++ValidBuildersSupportingBundling;
2937 }
2938 }
2939 CanUseBundler =
2940 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
Artem Belevichf981e30b2016-08-02 22:37:47 +00002941 }
Justin Lebardc3c5042016-04-19 02:27:07 +00002942
Samuel Antao64e965e2016-09-30 15:34:19 +00002943 ~OffloadingActionBuilder() {
2944 for (auto *SB : SpecializedBuilders)
2945 delete SB;
Samuel Antaod06239d2016-07-15 23:13:27 +00002946 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002947
Samuel Antao64e965e2016-09-30 15:34:19 +00002948 /// Generate an action that adds device dependences (if any) to a host action.
2949 /// If no device dependence actions exist, just return the host action \a
2950 /// HostAction. If an error is found or if no builder requires the host action
2951 /// to be generated, return nullptr.
2952 Action *
2953 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2954 phases::ID CurPhase, phases::ID FinalPhase,
2955 DeviceActionBuilder::PhasesTy &Phases) {
2956 if (!IsValid)
2957 return nullptr;
Justin Lebar7bf77982016-01-11 23:27:13 +00002958
Samuel Antao64e965e2016-09-30 15:34:19 +00002959 if (SpecializedBuilders.empty())
2960 return HostAction;
2961
2962 assert(HostAction && "Invalid host action!");
2963
2964 OffloadAction::DeviceDependences DDeps;
2965 // Check if all the programming models agree we should not emit the host
2966 // action. Also, keep track of the offloading kinds employed.
2967 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2968 unsigned InactiveBuilders = 0u;
2969 unsigned IgnoringBuilders = 0u;
2970 for (auto *SB : SpecializedBuilders) {
2971 if (!SB->isValid()) {
2972 ++InactiveBuilders;
2973 continue;
2974 }
2975
Samuel Antao28c4f182016-10-27 17:08:03 +00002976 auto RetCode =
2977 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
Samuel Antao64e965e2016-09-30 15:34:19 +00002978
2979 // If the builder explicitly says the host action should be ignored,
2980 // we need to increment the variable that tracks the builders that request
2981 // the host object to be ignored.
2982 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2983 ++IgnoringBuilders;
2984
2985 // Unless the builder was inactive for this action, we have to record the
2986 // offload kind because the host will have to use it.
2987 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2988 OffloadKind |= SB->getAssociatedOffloadKind();
2989 }
2990
2991 // If all builders agree that the host object should be ignored, just return
2992 // nullptr.
2993 if (IgnoringBuilders &&
2994 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2995 return nullptr;
2996
2997 if (DDeps.getActions().empty())
2998 return HostAction;
2999
3000 // We have dependences we need to bundle together. We use an offload action
3001 // for that.
3002 OffloadAction::HostDependence HDep(
3003 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
3004 /*BoundArch=*/nullptr, DDeps);
3005 return C.MakeAction<OffloadAction>(HDep, DDeps);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003006 }
3007
Samuel Antao64e965e2016-09-30 15:34:19 +00003008 /// Generate an action that adds a host dependence to a device action. The
3009 /// results will be kept in this action builder. Return true if an error was
3010 /// found.
Samuel Antaofab4f372016-10-27 18:00:51 +00003011 bool addHostDependenceToDeviceActions(Action *&HostAction,
Samuel Antao64e965e2016-09-30 15:34:19 +00003012 const Arg *InputArg) {
3013 if (!IsValid)
3014 return true;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003015
Samuel Antaofab4f372016-10-27 18:00:51 +00003016 // If we are supporting bundling/unbundling and the current action is an
3017 // input action of non-source file, we replace the host action by the
3018 // unbundling action. The bundler tool has the logic to detect if an input
3019 // is a bundle or not and if the input is not a bundle it assumes it is a
3020 // host file. Therefore it is safe to create an unbundling action even if
3021 // the input is not a bundle.
3022 if (CanUseBundler && isa<InputAction>(HostAction) &&
3023 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
3024 !types::isSrcFile(HostAction->getType())) {
3025 auto UnbundlingHostAction =
3026 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
3027 UnbundlingHostAction->registerDependentActionInfo(
3028 C.getSingleOffloadToolChain<Action::OFK_Host>(),
Yaxun Liuf37b50a2018-07-24 01:03:44 +00003029 /*BoundArch=*/StringRef(), Action::OFK_Host);
Samuel Antaofab4f372016-10-27 18:00:51 +00003030 HostAction = UnbundlingHostAction;
3031 }
3032
Samuel Antao64e965e2016-09-30 15:34:19 +00003033 assert(HostAction && "Invalid host action!");
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003034
Samuel Antao64e965e2016-09-30 15:34:19 +00003035 // Register the offload kinds that are used.
3036 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
3037 for (auto *SB : SpecializedBuilders) {
3038 if (!SB->isValid())
3039 continue;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003040
Samuel Antao64e965e2016-09-30 15:34:19 +00003041 auto RetCode = SB->addDeviceDepences(HostAction);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003042
Samuel Antao64e965e2016-09-30 15:34:19 +00003043 // Host dependences for device actions are not compatible with that same
3044 // action being ignored.
3045 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
3046 "Host dependence not expected to be ignored.!");
Samuel Antaod06239d2016-07-15 23:13:27 +00003047
Samuel Antao64e965e2016-09-30 15:34:19 +00003048 // Unless the builder was inactive for this action, we have to record the
3049 // offload kind because the host will have to use it.
3050 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
3051 OffloadKind |= SB->getAssociatedOffloadKind();
3052 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003053
Alexey Bataeva5178f52018-09-28 16:17:59 +00003054 // Do not use unbundler if the Host does not depend on device action.
3055 if (OffloadKind == Action::OFK_None && CanUseBundler)
3056 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction))
3057 HostAction = UA->getInputs().back();
3058
Samuel Antao64e965e2016-09-30 15:34:19 +00003059 return false;
3060 }
3061
Samuel Antao69d6f312016-10-27 17:50:43 +00003062 /// Add the offloading top level actions to the provided action list. This
3063 /// function can replace the host action by a bundling action if the
3064 /// programming models allow it.
Samuel Antao64e965e2016-09-30 15:34:19 +00003065 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
3066 const Arg *InputArg) {
Samuel Antao69d6f312016-10-27 17:50:43 +00003067 // Get the device actions to be appended.
3068 ActionList OffloadAL;
Samuel Antao64e965e2016-09-30 15:34:19 +00003069 for (auto *SB : SpecializedBuilders) {
3070 if (!SB->isValid())
3071 continue;
Samuel Antao69d6f312016-10-27 17:50:43 +00003072 SB->appendTopLevelActions(OffloadAL);
Samuel Antao64e965e2016-09-30 15:34:19 +00003073 }
3074
Samuel Antao69d6f312016-10-27 17:50:43 +00003075 // If we can use the bundler, replace the host action by the bundling one in
Yaxun Liu2bcc9512018-11-14 04:47:31 +00003076 // the resulting list. Otherwise, just append the device actions. For
3077 // device only compilation, HostAction is a null pointer, therefore only do
3078 // this when HostAction is not a null pointer.
3079 if (CanUseBundler && HostAction && !OffloadAL.empty()) {
Samuel Antao69d6f312016-10-27 17:50:43 +00003080 // Add the host action to the list in order to create the bundling action.
3081 OffloadAL.push_back(HostAction);
3082
3083 // We expect that the host action was just appended to the action list
3084 // before this method was called.
3085 assert(HostAction == AL.back() && "Host action not in the list??");
3086 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
3087 AL.back() = HostAction;
3088 } else
3089 AL.append(OffloadAL.begin(), OffloadAL.end());
3090
Samuel Antao64e965e2016-09-30 15:34:19 +00003091 // Propagate to the current host action (if any) the offload information
3092 // associated with the current input.
3093 if (HostAction)
3094 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
3095 /*BoundArch=*/nullptr);
Samuel Antao64e965e2016-09-30 15:34:19 +00003096 return false;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003097 }
Artem Belevich5bde4e02015-07-20 20:02:54 +00003098
Samuel Antao64e965e2016-09-30 15:34:19 +00003099 /// Processes the host linker action. This currently consists of replacing it
3100 /// with an offload action if there are device link objects and propagate to
3101 /// the host action all the offload kinds used in the current compilation. The
3102 /// resulting action is returned.
3103 Action *processHostLinkAction(Action *HostAction) {
3104 // Add all the dependences from the device linking actions.
3105 OffloadAction::DeviceDependences DDeps;
3106 for (auto *SB : SpecializedBuilders) {
3107 if (!SB->isValid())
3108 continue;
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003109
Samuel Antao64e965e2016-09-30 15:34:19 +00003110 SB->appendLinkDependences(DDeps);
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003111 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003112
Samuel Antao64e965e2016-09-30 15:34:19 +00003113 // Calculate all the offload kinds used in the current compilation.
3114 unsigned ActiveOffloadKinds = 0u;
3115 for (auto &I : InputArgToOffloadKindMap)
3116 ActiveOffloadKinds |= I.second;
3117
3118 // If we don't have device dependencies, we don't have to create an offload
3119 // action.
3120 if (DDeps.getActions().empty()) {
3121 // Propagate all the active kinds to host action. Given that it is a link
3122 // action it is assumed to depend on all actions generated so far.
3123 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
3124 /*BoundArch=*/nullptr);
3125 return HostAction;
3126 }
3127
3128 // Create the offload action with all dependences. When an offload action
3129 // is created the kinds are propagated to the host action, so we don't have
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003130 // to do that explicitly here.
Samuel Antao64e965e2016-09-30 15:34:19 +00003131 OffloadAction::HostDependence HDep(
3132 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
3133 /*BoundArch*/ nullptr, ActiveOffloadKinds);
3134 return C.MakeAction<OffloadAction>(HDep, DDeps);
3135 }
3136};
3137} // anonymous namespace.
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003138
Justin Lebar0f3474c2016-02-11 02:00:50 +00003139void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
3140 const InputList &Inputs, ActionList &Actions) const {
Chad Rosierecdede82011-08-12 22:08:57 +00003141 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00003142
Daniel Dunbar34c41872009-03-13 00:17:48 +00003143 if (!SuppressMissingInputWarning && Inputs.empty()) {
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003144 Diag(clang::diag::err_drv_no_input_files);
3145 return;
3146 }
3147
Chad Rosier7742b5d2011-07-27 23:36:45 +00003148 Arg *FinalPhaseArg;
3149 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003150
Bob Haarmanaaf51912017-02-27 19:40:19 +00003151 if (FinalPhase == phases::Link) {
3152 if (Args.hasArg(options::OPT_emit_llvm))
3153 Diag(clang::diag::err_drv_emit_llvm_link);
3154 if (IsCLMode() && LTOMode != LTOK_None &&
3155 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
3156 Diag(clang::diag::err_drv_lto_without_lld);
Rafael Espindolae8025642013-08-25 14:27:09 +00003157 }
3158
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003159 // Reject -Z* at the top level, these options should never have been exposed
3160 // by gcc.
Daniel Dunbardd765242009-03-26 16:12:09 +00003161 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
Daniel Dunbar0e759942009-03-20 06:14:23 +00003162 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003163
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003164 // Diagnose misuse of /Fo.
3165 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003166 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003167 if (Inputs.size() > 1 && !V.empty() &&
3168 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003169 // Check whether /Fo tries to name an output file for multiple inputs.
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003170 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003171 << A->getSpelling() << V;
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003172 Args.eraseArg(options::OPT__SLASH_Fo);
3173 }
3174 }
3175
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003176 // Diagnose misuse of /Fa.
3177 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
3178 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003179 if (Inputs.size() > 1 && !V.empty() &&
3180 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003181 // Check whether /Fa tries to name an asm file for multiple inputs.
3182 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003183 << A->getSpelling() << V;
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003184 Args.eraseArg(options::OPT__SLASH_Fa);
3185 }
3186 }
3187
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00003188 // Diagnose misuse of /o.
3189 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
3190 if (A->getValue()[0] == '\0') {
3191 // It has to have a value.
3192 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
3193 Args.eraseArg(options::OPT__SLASH_o);
3194 }
3195 }
3196
Mike Rice58df1af2018-09-11 17:10:44 +00003197 // Ignore /Yc/Yu if both /Yc and /Yu passed but with different filenames.
Nico Weber2ca4be92016-03-01 23:16:44 +00003198 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
3199 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
Nico Weber2ca4be92016-03-01 23:16:44 +00003200 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
3201 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
3202 Args.eraseArg(options::OPT__SLASH_Yc);
3203 Args.eraseArg(options::OPT__SLASH_Yu);
3204 YcArg = YuArg = nullptr;
3205 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003206 if (YcArg && Inputs.size() > 1) {
3207 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
3208 Args.eraseArg(options::OPT__SLASH_Yc);
3209 YcArg = nullptr;
3210 }
Erich Keaneeaca3882018-08-17 13:43:39 +00003211 if (FinalPhase == phases::Preprocess || Args.hasArg(options::OPT__SLASH_Y_)) {
3212 // If only preprocessing or /Y- is used, all pch handling is disabled.
3213 // Rather than check for it everywhere, just remove clang-cl pch-related
3214 // flags here.
Nico Weber2ca4be92016-03-01 23:16:44 +00003215 Args.eraseArg(options::OPT__SLASH_Fp);
3216 Args.eraseArg(options::OPT__SLASH_Yc);
3217 Args.eraseArg(options::OPT__SLASH_Yu);
3218 YcArg = YuArg = nullptr;
3219 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003220
Samuel Antao64e965e2016-09-30 15:34:19 +00003221 // Builder to be used to build offloading actions.
3222 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
Samuel Antaod06239d2016-07-15 23:13:27 +00003223
Daniel Dunbar65229332009-03-13 11:38:42 +00003224 // Construct the actions to perform.
Richard Smithcd35eff2018-09-15 01:21:16 +00003225 HeaderModulePrecompileJobAction *HeaderModuleAction = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003226 ActionList LinkerInputs;
Alp Toker965f8822013-11-27 05:22:15 +00003227
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003228 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
Artem Belevich5bde4e02015-07-20 20:02:54 +00003229 for (auto &I : Inputs) {
3230 types::ID InputType = I.first;
3231 const Arg *InputArg = I.second;
Daniel Dunbar65229332009-03-13 11:38:42 +00003232
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003233 PL.clear();
3234 types::getCompilationPhases(InputType, PL);
Daniel Dunbar65229332009-03-13 11:38:42 +00003235
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003236 // If the first step comes after the final phase we are doing as part of
3237 // this compilation, warn the user about it.
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003238 phases::ID InitialPhase = PL[0];
Daniel Dunbar65229332009-03-13 11:38:42 +00003239 if (InitialPhase > FinalPhase) {
Martin Storsjo665c7a42018-05-04 06:05:58 +00003240 if (InputArg->isClaimed())
3241 continue;
3242
Daniel Dunbaradc5c7c2009-03-19 07:57:08 +00003243 // Claim here to avoid the more general unused warning.
3244 InputArg->claim();
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003245
Daniel Dunbar2db3e732011-04-20 15:44:48 +00003246 // Suppress all unused style warnings with -Qunused-arguments
3247 if (Args.hasArg(options::OPT_Qunused_arguments))
3248 continue;
3249
Richard Smith403f76e2012-08-06 04:09:06 +00003250 // Special case when final phase determined by binary name, rather than
3251 // by a command-line argument with a corresponding Arg.
Hans Wennborg70850d82013-07-18 20:29:38 +00003252 if (CCCIsCPP())
Richard Smith403f76e2012-08-06 04:09:06 +00003253 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003254 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003255 // Special case '-E' warning on a previously preprocessed file to make
3256 // more sense.
Richard Smith403f76e2012-08-06 04:09:06 +00003257 else if (InitialPhase == phases::Compile &&
3258 FinalPhase == phases::Preprocess &&
3259 getPreprocessedType(InputType) == types::TY_INVALID)
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003260 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003261 << InputArg->getAsString(Args) << !!FinalPhaseArg
3262 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003263 else
3264 Diag(clang::diag::warn_drv_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003265 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
3266 << !!FinalPhaseArg
3267 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar65229332009-03-13 11:38:42 +00003268 continue;
3269 }
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003270
Nico Weberad2d8f32016-04-21 19:59:10 +00003271 if (YcArg) {
3272 // Add a separate precompile phase for the compile phase.
3273 if (FinalPhase >= phases::Compile) {
Richard Smith8cd452d2016-08-30 18:55:16 +00003274 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003275 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
Richard Smith8cd452d2016-08-30 18:55:16 +00003276 types::getCompilationPhases(HeaderType, PCHPL);
Nico Weberad2d8f32016-04-21 19:59:10 +00003277 // Build the pipeline for the pch file.
Richard Smith8cd452d2016-08-30 18:55:16 +00003278 Action *ClangClPch =
Erich Keane76675de2018-07-05 17:22:13 +00003279 C.MakeAction<InputAction>(*InputArg, HeaderType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003280 for (phases::ID Phase : PCHPL)
3281 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
3282 assert(ClangClPch);
3283 Actions.push_back(ClangClPch);
3284 // The driver currently exits after the first failed command. This
3285 // relies on that behavior, to make sure if the pch generation fails,
3286 // the main compilation won't run.
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00003287 // FIXME: If the main compilation fails, the PCH generation should
3288 // probably not be considered successful either.
Nico Weberad2d8f32016-04-21 19:59:10 +00003289 }
3290 }
3291
Daniel Dunbar65229332009-03-13 11:38:42 +00003292 // Build the pipeline for this file.
Justin Lebar41094612016-01-11 23:07:27 +00003293 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
Samuel Antao64e965e2016-09-30 15:34:19 +00003294
3295 // Use the current host action in any of the offloading actions, if
3296 // required.
3297 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3298 break;
3299
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003300 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
3301 i != e; ++i) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003302 phases::ID Phase = *i;
Daniel Dunbar65229332009-03-13 11:38:42 +00003303
3304 // We are done if this step is past what the user requested.
3305 if (Phase > FinalPhase)
3306 break;
3307
Samuel Antao64e965e2016-09-30 15:34:19 +00003308 // Add any offload action the host action depends on.
3309 Current = OffloadBuilder.addDeviceDependencesToHostAction(
3310 Current, InputArg, Phase, FinalPhase, PL);
3311 if (!Current)
3312 break;
3313
Daniel Dunbar65229332009-03-13 11:38:42 +00003314 // Queue linker inputs.
3315 if (Phase == phases::Link) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003316 assert((i + 1) == e && "linking must be final compilation step.");
Justin Lebar41094612016-01-11 23:07:27 +00003317 LinkerInputs.push_back(Current);
3318 Current = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003319 break;
3320 }
3321
Richard Smithcd35eff2018-09-15 01:21:16 +00003322 // Each precompiled header file after a module file action is a module
3323 // header of that same module file, rather than being compiled to a
3324 // separate PCH.
3325 if (Phase == phases::Precompile && HeaderModuleAction &&
3326 getPrecompiledType(InputType) == types::TY_PCH) {
3327 HeaderModuleAction->addModuleHeaderInput(Current);
3328 Current = nullptr;
3329 break;
3330 }
3331
3332 // FIXME: Should we include any prior module file outputs as inputs of
3333 // later actions in the same command line?
3334
Samuel Antao64e965e2016-09-30 15:34:19 +00003335 // Otherwise construct the appropriate action.
Richard Smithcd35eff2018-09-15 01:21:16 +00003336 Action *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003337
3338 // We didn't create a new action, so we will just move to the next phase.
3339 if (NewCurrent == Current)
Daniel Dunbar13864952009-03-24 20:17:30 +00003340 continue;
3341
Richard Smithcd35eff2018-09-15 01:21:16 +00003342 if (auto *HMA = dyn_cast<HeaderModulePrecompileJobAction>(NewCurrent))
3343 HeaderModuleAction = HMA;
3344
Samuel Antao64e965e2016-09-30 15:34:19 +00003345 Current = NewCurrent;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003346
Samuel Antao64e965e2016-09-30 15:34:19 +00003347 // Use the current host action in any of the offloading actions, if
3348 // required.
3349 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3350 break;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003351
Daniel Dunbar65229332009-03-13 11:38:42 +00003352 if (Current->getType() == types::TY_Nothing)
3353 break;
3354 }
3355
Samuel Antao64e965e2016-09-30 15:34:19 +00003356 // If we ended with something, add to the output list.
3357 if (Current)
Justin Lebar41094612016-01-11 23:07:27 +00003358 Actions.push_back(Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003359
3360 // Add any top level actions generated for offloading.
3361 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003362 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003363
Samuel Antao64e965e2016-09-30 15:34:19 +00003364 // Add a link action if necessary.
Samuel Antaod06239d2016-07-15 23:13:27 +00003365 if (!LinkerInputs.empty()) {
Samuel Antao64e965e2016-09-30 15:34:19 +00003366 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
3367 LA = OffloadBuilder.processHostLinkAction(LA);
3368 Actions.push_back(LA);
Samuel Antaod06239d2016-07-15 23:13:27 +00003369 }
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003370
3371 // If we are linking, claim any options which are obviously only used for
3372 // compilation.
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003373 if (FinalPhase == phases::Link && PL.size() == 1) {
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003374 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003375 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
3376 }
3377
3378 // Claim ignored clang-cl options.
3379 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
Artem Belevichbaae0932015-07-28 21:01:30 +00003380
Justin Lebardc3c5042016-04-19 02:27:07 +00003381 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
3382 // to non-CUDA compilations and should not trigger warnings there.
Artem Belevichbaae0932015-07-28 21:01:30 +00003383 Args.ClaimAllArgs(options::OPT_cuda_host_only);
Justin Lebardc3c5042016-04-19 02:27:07 +00003384 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
Daniel Dunbar65229332009-03-13 11:38:42 +00003385}
3386
Artem Belevichecb178b2018-03-21 22:22:59 +00003387Action *Driver::ConstructPhaseAction(
3388 Compilation &C, const ArgList &Args, phases::ID Phase, Action *Input,
3389 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003390 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
Samuel Antao64e965e2016-09-30 15:34:19 +00003391
3392 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
3393 // encode this in the steps because the intermediate type depends on
3394 // arguments. Just special case here.
3395 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
3396 return Input;
3397
Daniel Dunbar65229332009-03-13 11:38:42 +00003398 // Build the appropriate action.
3399 switch (Phase) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003400 case phases::Link:
3401 llvm_unreachable("link action invalid here.");
Daniel Dunbar65229332009-03-13 11:38:42 +00003402 case phases::Preprocess: {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003403 types::ID OutputTy;
3404 // -{M, MM} alter the output type.
Daniel Dunbar86aed7d2010-12-08 21:33:40 +00003405 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003406 OutputTy = types::TY_Dependencies;
3407 } else {
David Blaikie5d577a22012-06-29 22:03:56 +00003408 OutputTy = Input->getType();
3409 if (!Args.hasFlag(options::OPT_frewrite_includes,
Justin Bognerce8245b2014-06-24 08:01:01 +00003410 options::OPT_fno_rewrite_includes, false) &&
Richard Smith86a3ef52017-06-09 21:24:02 +00003411 !Args.hasFlag(options::OPT_frewrite_imports,
3412 options::OPT_fno_rewrite_imports, false) &&
Justin Bognerce8245b2014-06-24 08:01:01 +00003413 !CCGenDiagnostics)
David Blaikie5d577a22012-06-29 22:03:56 +00003414 OutputTy = types::getPreprocessedType(OutputTy);
Daniel Dunbard67a3222009-03-30 06:36:42 +00003415 assert(OutputTy != types::TY_INVALID &&
3416 "Cannot preprocess this input type!");
3417 }
Justin Lebar41094612016-01-11 23:07:27 +00003418 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
Daniel Dunbar65229332009-03-13 11:38:42 +00003419 }
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003420 case phases::Precompile: {
Richard Smithdd4ad3d2016-08-30 19:06:26 +00003421 types::ID OutputTy = getPrecompiledType(Input->getType());
3422 assert(OutputTy != types::TY_INVALID &&
3423 "Cannot precompile this input type!");
Richard Smithcd35eff2018-09-15 01:21:16 +00003424
3425 // If we're given a module name, precompile header file inputs as a
3426 // module, not as a precompiled header.
3427 const char *ModName = nullptr;
3428 if (OutputTy == types::TY_PCH) {
3429 if (Arg *A = Args.getLastArg(options::OPT_fmodule_name_EQ))
3430 ModName = A->getValue();
3431 if (ModName)
3432 OutputTy = types::TY_ModuleFile;
3433 }
3434
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003435 if (Args.hasArg(options::OPT_fsyntax_only)) {
3436 // Syntax checks should not emit a PCH file
3437 OutputTy = types::TY_Nothing;
3438 }
Richard Smithcd35eff2018-09-15 01:21:16 +00003439
3440 if (ModName)
3441 return C.MakeAction<HeaderModulePrecompileJobAction>(Input, OutputTy,
3442 ModName);
Justin Lebar41094612016-01-11 23:07:27 +00003443 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003444 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003445 case phases::Compile: {
David Blaikie486f4402014-08-29 07:25:23 +00003446 if (Args.hasArg(options::OPT_fsyntax_only))
Justin Lebar41094612016-01-11 23:07:27 +00003447 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
David Blaikie486f4402014-08-29 07:25:23 +00003448 if (Args.hasArg(options::OPT_rewrite_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003449 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003450 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003451 return C.MakeAction<CompileJobAction>(Input,
3452 types::TY_RewrittenLegacyObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003453 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
Justin Lebar41094612016-01-11 23:07:27 +00003454 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
David Blaikie486f4402014-08-29 07:25:23 +00003455 if (Args.hasArg(options::OPT__migrate))
Justin Lebar41094612016-01-11 23:07:27 +00003456 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
David Blaikie486f4402014-08-29 07:25:23 +00003457 if (Args.hasArg(options::OPT_emit_ast))
Justin Lebar41094612016-01-11 23:07:27 +00003458 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
David Blaikie486f4402014-08-29 07:25:23 +00003459 if (Args.hasArg(options::OPT_module_file_info))
Justin Lebar41094612016-01-11 23:07:27 +00003460 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
David Blaikie486f4402014-08-29 07:25:23 +00003461 if (Args.hasArg(options::OPT_verify_pch))
Justin Lebar41094612016-01-11 23:07:27 +00003462 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
3463 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
Bob Wilson23a55f12014-12-21 07:00:00 +00003464 }
3465 case phases::Backend: {
Artem Belevichecb178b2018-03-21 22:22:59 +00003466 if (isUsingLTO() && TargetDeviceOffloadKind == Action::OFK_None) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003467 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003468 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003469 return C.MakeAction<BackendJobAction>(Input, Output);
David Blaikie486f4402014-08-29 07:25:23 +00003470 }
3471 if (Args.hasArg(options::OPT_emit_llvm)) {
Shuxin Yang4b3c7ff2013-08-23 21:34:57 +00003472 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003473 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003474 return C.MakeAction<BackendJobAction>(Input, Output);
Daniel Dunbar65229332009-03-13 11:38:42 +00003475 }
Justin Lebar41094612016-01-11 23:07:27 +00003476 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
Daniel Dunbar65229332009-03-13 11:38:42 +00003477 }
3478 case phases::Assemble:
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003479 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
Daniel Dunbar65229332009-03-13 11:38:42 +00003480 }
3481
David Blaikie83d382b2011-09-23 05:06:16 +00003482 llvm_unreachable("invalid phase in ConstructPhaseAction");
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003483}
3484
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00003485void Driver::BuildJobs(Compilation &C) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003486 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003487
3488 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3489
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003490 // It is an error to provide a -o option if we are making multiple output
3491 // files.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003492 if (FinalOutput) {
3493 unsigned NumOutputs = 0;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003494 for (const Action *A : C.getActions())
3495 if (A->getType() != types::TY_Nothing)
Daniel Dunbare75d8342009-03-16 06:56:51 +00003496 ++NumOutputs;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003497
Daniel Dunbare75d8342009-03-16 06:56:51 +00003498 if (NumOutputs > 1) {
3499 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
Craig Topper92fc2df2014-05-17 16:56:41 +00003500 FinalOutput = nullptr;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003501 }
3502 }
3503
Chad Rosier35767232013-04-30 22:01:21 +00003504 // Collect the list of architectures.
3505 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003506 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
3507 for (const Arg *A : C.getArgs())
Chad Rosier35767232013-04-30 22:01:21 +00003508 if (A->getOption().matches(options::OPT_arch))
3509 ArchNames.insert(A->getValue());
Chad Rosier35767232013-04-30 22:01:21 +00003510
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003511 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
3512 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003513 for (Action *A : C.getActions()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003514 // If we are linking an image for multiple archs then the linker wants
3515 // -arch_multiple and -final_output <final image name>. Unfortunately, this
3516 // doesn't fit in cleanly because we have to pass this information down.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003517 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003518 // FIXME: This is a hack; find a cleaner way to integrate this into the
3519 // process.
Craig Topper92fc2df2014-05-17 16:56:41 +00003520 const char *LinkingOutput = nullptr;
Daniel Dunbardd765242009-03-26 16:12:09 +00003521 if (isa<LipoJobAction>(A)) {
Daniel Dunbare75d8342009-03-16 06:56:51 +00003522 if (FinalOutput)
Richard Smithbd55daf2012-11-01 04:30:05 +00003523 LinkingOutput = FinalOutput->getValue();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003524 else
Hans Wennborga7707222015-01-09 17:38:53 +00003525 LinkingOutput = getDefaultImageName();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003526 }
3527
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003528 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003529 /*BoundArch*/ StringRef(),
Daniel Dunbare75d8342009-03-16 06:56:51 +00003530 /*AtTopLevel*/ true,
Chad Rosier35767232013-04-30 22:01:21 +00003531 /*MultipleArchs*/ ArchNames.size() > 1,
Samuel Antaod06239d2016-07-15 23:13:27 +00003532 /*LinkingOutput*/ LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003533 /*TargetDeviceOffloadKind*/ Action::OFK_None);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003534 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003535
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003536 // If the user passed -Qunused-arguments or there were errors, don't warn
3537 // about any unused arguments.
Argyrios Kyrtzidis31448a42010-11-18 21:47:07 +00003538 if (Diags.hasErrorOccurred() ||
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003539 C.getArgs().hasArg(options::OPT_Qunused_arguments))
Daniel Dunbard175d972009-03-18 18:03:46 +00003540 return;
3541
Daniel Dunbar58399ae2009-03-29 22:24:54 +00003542 // Claim -### here.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003543 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003544
Nico Weber47bf5052016-04-25 21:15:49 +00003545 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003546 (void)C.getArgs().hasArg(options::OPT_driver_mode);
Nico Weber47bf5052016-04-25 21:15:49 +00003547 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
Hans Wennborg70850d82013-07-18 20:29:38 +00003548
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003549 for (Arg *A : C.getArgs()) {
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003550 // FIXME: It would be nice to be able to send the argument to the
David Blaikie9c902b52011-09-25 23:23:43 +00003551 // DiagnosticsEngine, so that extra values, position, and so on could be
3552 // printed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003553 if (!A->isClaimed()) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +00003554 if (A->getOption().hasFlag(options::NoArgumentUnused))
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003555 continue;
3556
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003557 // Suppress the warning automatically if this is just a flag, and it is an
3558 // instance of an argument we already claimed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003559 const Option &Opt = A->getOption();
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00003560 if (Opt.getKind() == Option::FlagClass) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003561 bool DuplicateClaimed = false;
3562
Sean Silva14facf32015-06-09 01:57:17 +00003563 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
3564 if (AA->isClaimed()) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003565 DuplicateClaimed = true;
3566 break;
3567 }
3568 }
3569
3570 if (DuplicateClaimed)
3571 continue;
3572 }
3573
Ehsan Akhgarid8518332016-01-25 21:14:52 +00003574 // In clang-cl, don't mention unknown arguments here since they have
3575 // already been warned about.
3576 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
3577 Diag(clang::diag::warn_drv_unused_argument)
3578 << A->getAsString(C.getArgs());
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003579 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003580 }
Daniel Dunbar95e6b192009-03-13 22:12:33 +00003581}
Daniel Dunbarc4343942010-02-03 03:07:56 +00003582
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003583namespace {
3584/// Utility class to control the collapse of dependent actions and select the
3585/// tools accordingly.
3586class ToolSelector final {
3587 /// The tool chain this selector refers to.
3588 const ToolChain &TC;
Daniel Dunbarf9ff3502010-05-14 02:03:00 +00003589
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003590 /// The compilation this selector refers to.
3591 const Compilation &C;
Samuel Antaod06239d2016-07-15 23:13:27 +00003592
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003593 /// The base action this selector refers to.
3594 const JobAction *BaseAction;
Samuel Antaod06239d2016-07-15 23:13:27 +00003595
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003596 /// Set to true if the current toolchain refers to host actions.
3597 bool IsHostSelector;
Samuel Antaod06239d2016-07-15 23:13:27 +00003598
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003599 /// Set to true if save-temps and embed-bitcode functionalities are active.
3600 bool SaveTemps;
3601 bool EmbedBitcode;
3602
3603 /// Get previous dependent action or null if that does not exist. If
3604 /// \a CanBeCollapsed is false, that action must be legal to collapse or
3605 /// null will be returned.
3606 const JobAction *getPrevDependentAction(const ActionList &Inputs,
3607 ActionList &SavedOffloadAction,
3608 bool CanBeCollapsed = true) {
3609 // An option can be collapsed only if it has a single input.
3610 if (Inputs.size() != 1)
Craig Topper92fc2df2014-05-17 16:56:41 +00003611 return nullptr;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003612
3613 Action *CurAction = *Inputs.begin();
3614 if (CanBeCollapsed &&
3615 !CurAction->isCollapsingWithNextDependentActionLegal())
3616 return nullptr;
3617
3618 // If the input action is an offload action. Look through it and save any
3619 // offload action that can be dropped in the event of a collapse.
3620 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
3621 // If the dependent action is a device action, we will attempt to collapse
3622 // only with other device actions. Otherwise, we would do the same but
3623 // with host actions only.
3624 if (!IsHostSelector) {
3625 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
3626 CurAction =
3627 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
3628 if (CanBeCollapsed &&
3629 !CurAction->isCollapsingWithNextDependentActionLegal())
3630 return nullptr;
3631 SavedOffloadAction.push_back(OA);
3632 return dyn_cast<JobAction>(CurAction);
3633 }
3634 } else if (OA->hasHostDependence()) {
3635 CurAction = OA->getHostDependence();
3636 if (CanBeCollapsed &&
3637 !CurAction->isCollapsingWithNextDependentActionLegal())
3638 return nullptr;
3639 SavedOffloadAction.push_back(OA);
3640 return dyn_cast<JobAction>(CurAction);
3641 }
3642 return nullptr;
3643 }
3644
3645 return dyn_cast<JobAction>(CurAction);
3646 }
3647
3648 /// Return true if an assemble action can be collapsed.
3649 bool canCollapseAssembleAction() const {
3650 return TC.useIntegratedAs() && !SaveTemps &&
3651 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
3652 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
3653 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
3654 }
3655
3656 /// Return true if a preprocessor action can be collapsed.
3657 bool canCollapsePreprocessorAction() const {
3658 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
3659 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
3660 !C.getArgs().hasArg(options::OPT_rewrite_objc);
3661 }
3662
3663 /// Struct that relates an action with the offload actions that would be
3664 /// collapsed with it.
3665 struct JobActionInfo final {
3666 /// The action this info refers to.
3667 const JobAction *JA = nullptr;
3668 /// The offload actions we need to take care off if this action is
3669 /// collapsed.
3670 ActionList SavedOffloadAction;
3671 };
3672
3673 /// Append collapsed offload actions from the give nnumber of elements in the
3674 /// action info array.
3675 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
3676 ArrayRef<JobActionInfo> &ActionInfo,
3677 unsigned ElementNum) {
3678 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
3679 for (unsigned I = 0; I < ElementNum; ++I)
3680 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
3681 ActionInfo[I].SavedOffloadAction.end());
3682 }
3683
3684 /// Functions that attempt to perform the combining. They detect if that is
3685 /// legal, and if so they update the inputs \a Inputs and the offload action
3686 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
3687 /// the combined action is returned. If the combining is not legal or if the
3688 /// tool does not exist, null is returned.
3689 /// Currently three kinds of collapsing are supported:
3690 /// - Assemble + Backend + Compile;
3691 /// - Assemble + Backend ;
3692 /// - Backend + Compile.
3693 const Tool *
3694 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003695 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003696 ActionList &CollapsedOffloadAction) {
3697 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
3698 return nullptr;
3699 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3700 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3701 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
3702 if (!AJ || !BJ || !CJ)
3703 return nullptr;
3704
3705 // Get compiler tool.
3706 const Tool *T = TC.SelectTool(*CJ);
3707 if (!T)
3708 return nullptr;
3709
Steven Wu574b0f22016-03-01 01:07:58 +00003710 // When using -fembed-bitcode, it is required to have the same tool (clang)
3711 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
3712 if (EmbedBitcode) {
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003713 const Tool *BT = TC.SelectTool(*BJ);
3714 if (BT == T)
3715 return nullptr;
Steven Wu574b0f22016-03-01 01:07:58 +00003716 }
Bob Wilson23a55f12014-12-21 07:00:00 +00003717
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003718 if (!T->hasIntegratedAssembler())
Bob Wilson23a55f12014-12-21 07:00:00 +00003719 return nullptr;
Samuel Antaod06239d2016-07-15 23:13:27 +00003720
Richard Smithcd35eff2018-09-15 01:21:16 +00003721 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003722 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3723 /*NumElements=*/3);
3724 return T;
3725 }
3726 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003727 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003728 ActionList &CollapsedOffloadAction) {
3729 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
3730 return nullptr;
3731 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3732 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3733 if (!AJ || !BJ)
3734 return nullptr;
3735
3736 // Retrieve the compile job, backend action must always be preceded by one.
3737 ActionList CompileJobOffloadActions;
3738 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
3739 /*CanBeCollapsed=*/false);
3740 if (!AJ || !BJ || !CJ)
3741 return nullptr;
3742
3743 assert(isa<CompileJobAction>(CJ) &&
3744 "Expecting compile job preceding backend job.");
3745
3746 // Get compiler tool.
3747 const Tool *T = TC.SelectTool(*CJ);
3748 if (!T)
3749 return nullptr;
3750
3751 if (!T->hasIntegratedAssembler())
3752 return nullptr;
3753
Richard Smithcd35eff2018-09-15 01:21:16 +00003754 Inputs = BJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003755 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3756 /*NumElements=*/2);
3757 return T;
3758 }
3759 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003760 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003761 ActionList &CollapsedOffloadAction) {
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003762 if (ActionInfo.size() < 2)
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003763 return nullptr;
3764 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3765 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3766 if (!BJ || !CJ)
3767 return nullptr;
3768
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003769 // Check if the initial input (to the compile job or its predessor if one
3770 // exists) is LLVM bitcode. In that case, no preprocessor step is required
3771 // and we can still collapse the compile and backend jobs when we have
3772 // -save-temps. I.e. there is no need for a separate compile job just to
3773 // emit unoptimized bitcode.
3774 bool InputIsBitcode = true;
3775 for (size_t i = 1; i < ActionInfo.size(); i++)
3776 if (ActionInfo[i].JA->getType() != types::TY_LLVM_BC &&
3777 ActionInfo[i].JA->getType() != types::TY_LTO_BC) {
3778 InputIsBitcode = false;
3779 break;
3780 }
3781 if (!InputIsBitcode && !canCollapsePreprocessorAction())
3782 return nullptr;
3783
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003784 // Get compiler tool.
3785 const Tool *T = TC.SelectTool(*CJ);
3786 if (!T)
3787 return nullptr;
3788
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003789 if (T->canEmitIR() && ((SaveTemps && !InputIsBitcode) || EmbedBitcode))
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003790 return nullptr;
3791
Richard Smithcd35eff2018-09-15 01:21:16 +00003792 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003793 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3794 /*NumElements=*/2);
3795 return T;
3796 }
3797
3798 /// Updates the inputs if the obtained tool supports combining with
3799 /// preprocessor action, and the current input is indeed a preprocessor
3800 /// action. If combining results in the collapse of offloading actions, those
3801 /// are appended to \a CollapsedOffloadAction.
Richard Smithcd35eff2018-09-15 01:21:16 +00003802 void combineWithPreprocessor(const Tool *T, ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003803 ActionList &CollapsedOffloadAction) {
3804 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3805 return;
3806
3807 // Attempt to get a preprocessor action dependence.
3808 ActionList PreprocessJobOffloadActions;
Richard Smithcd35eff2018-09-15 01:21:16 +00003809 ActionList NewInputs;
3810 for (Action *A : Inputs) {
3811 auto *PJ = getPrevDependentAction({A}, PreprocessJobOffloadActions);
3812 if (!PJ || !isa<PreprocessJobAction>(PJ)) {
3813 NewInputs.push_back(A);
3814 continue;
3815 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003816
Richard Smithcd35eff2018-09-15 01:21:16 +00003817 // This is legal to combine. Append any offload action we found and add the
3818 // current input to preprocessor inputs.
3819 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3820 PreprocessJobOffloadActions.end());
3821 NewInputs.append(PJ->input_begin(), PJ->input_end());
3822 }
3823 Inputs = NewInputs;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003824 }
3825
3826public:
3827 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3828 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3829 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3830 EmbedBitcode(EmbedBitcode) {
3831 assert(BaseAction && "Invalid base action.");
3832 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3833 }
3834
3835 /// Check if a chain of actions can be combined and return the tool that can
3836 /// handle the combination of actions. The pointer to the current inputs \a
3837 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3838 /// connected to collapsed actions are updated accordingly. The latter enables
3839 /// the caller of the selector to process them afterwards instead of just
3840 /// dropping them. If no suitable tool is found, null will be returned.
Richard Smithcd35eff2018-09-15 01:21:16 +00003841 const Tool *getTool(ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003842 ActionList &CollapsedOffloadAction) {
3843 //
3844 // Get the largest chain of actions that we could combine.
3845 //
3846
3847 SmallVector<JobActionInfo, 5> ActionChain(1);
3848 ActionChain.back().JA = BaseAction;
3849 while (ActionChain.back().JA) {
3850 const Action *CurAction = ActionChain.back().JA;
3851
3852 // Grow the chain by one element.
3853 ActionChain.resize(ActionChain.size() + 1);
3854 JobActionInfo &AI = ActionChain.back();
3855
3856 // Attempt to fill it with the
3857 AI.JA =
3858 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
Daniel Dunbarc4343942010-02-03 03:07:56 +00003859 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003860
3861 // Pop the last action info as it could not be filled.
3862 ActionChain.pop_back();
3863
3864 //
3865 // Attempt to combine actions. If all combining attempts failed, just return
3866 // the tool of the provided action. At the end we attempt to combine the
3867 // action with any preprocessor action it may depend on.
3868 //
3869
3870 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3871 CollapsedOffloadAction);
3872 if (!T)
3873 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3874 if (!T)
3875 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3876 if (!T) {
Richard Smithcd35eff2018-09-15 01:21:16 +00003877 Inputs = BaseAction->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003878 T = TC.SelectTool(*BaseAction);
3879 }
3880
3881 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3882 return T;
Daniel Dunbarc4343942010-02-03 03:07:56 +00003883 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003884};
Daniel Dunbarc4343942010-02-03 03:07:56 +00003885}
3886
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003887/// Return a string that uniquely identifies the result of a job. The bound arch
3888/// is not necessarily represented in the toolchain's triple -- for example,
3889/// armv7 and armv7s both map to the same triple -- so we need both in our map.
3890/// Also, we need to add the offloading device kind, as the same tool chain can
3891/// be used for host and device for some programming models, e.g. OpenMP.
3892static std::string GetTriplePlusArchString(const ToolChain *TC,
3893 StringRef BoundArch,
3894 Action::OffloadKind OffloadKind) {
Justin Lebar55c83322016-01-16 03:30:08 +00003895 std::string TriplePlusArch = TC->getTriple().normalize();
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003896 if (!BoundArch.empty()) {
Justin Lebar55c83322016-01-16 03:30:08 +00003897 TriplePlusArch += "-";
3898 TriplePlusArch += BoundArch;
3899 }
Samuel Antao59efaed2016-10-27 17:31:22 +00003900 TriplePlusArch += "-";
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003901 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3902 return TriplePlusArch;
3903}
3904
3905InputInfo Driver::BuildJobsForAction(
3906 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3907 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3908 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3909 Action::OffloadKind TargetDeviceOffloadKind) const {
3910 std::pair<const Action *, std::string> ActionTC = {
3911 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003912 auto CachedResult = CachedResults.find(ActionTC);
3913 if (CachedResult != CachedResults.end()) {
3914 return CachedResult->second;
3915 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003916 InputInfo Result = BuildJobsForActionNoCache(
3917 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003918 CachedResults, TargetDeviceOffloadKind);
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003919 CachedResults[ActionTC] = Result;
3920 return Result;
3921}
3922
3923InputInfo Driver::BuildJobsForActionNoCache(
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003924 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003925 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
Samuel Antaod06239d2016-07-15 23:13:27 +00003926 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003927 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003928 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbarc4acf9d2009-03-18 23:18:19 +00003929
Samuel Antaod06239d2016-07-15 23:13:27 +00003930 InputInfoList OffloadDependencesInputInfo;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003931 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
Samuel Antaod06239d2016-07-15 23:13:27 +00003932 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
Alex Lorenz4003a982017-08-08 11:22:21 +00003933 // The 'Darwin' toolchain is initialized only when its arguments are
3934 // computed. Get the default arguments for OFK_None to ensure that
3935 // initialization is performed before processing the offload action.
3936 // FIXME: Remove when darwin's toolchain is initialized during construction.
3937 C.getArgsForToolChain(TC, BoundArch, Action::OFK_None);
3938
Samuel Antaod06239d2016-07-15 23:13:27 +00003939 // The offload action is expected to be used in four different situations.
3940 //
3941 // a) Set a toolchain/architecture/kind for a host action:
3942 // Host Action 1 -> OffloadAction -> Host Action 2
3943 //
3944 // b) Set a toolchain/architecture/kind for a device action;
3945 // Device Action 1 -> OffloadAction -> Device Action 2
3946 //
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003947 // c) Specify a device dependence to a host action;
Samuel Antaod06239d2016-07-15 23:13:27 +00003948 // Device Action 1 _
3949 // \
3950 // Host Action 1 ---> OffloadAction -> Host Action 2
3951 //
3952 // d) Specify a host dependence to a device action.
3953 // Host Action 1 _
3954 // \
3955 // Device Action 1 ---> OffloadAction -> Device Action 2
3956 //
3957 // For a) and b), we just return the job generated for the dependence. For
3958 // c) and d) we override the current action with the host/device dependence
3959 // if the current toolchain is host/device and set the offload dependences
3960 // info with the jobs obtained from the device/host dependence(s).
3961
3962 // If there is a single device option, just generate the job for it.
3963 if (OA->hasSingleDeviceDependence()) {
3964 InputInfo DevA;
3965 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3966 const char *DepBoundArch) {
3967 DevA =
3968 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3969 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003970 CachedResults, DepA->getOffloadingDeviceKind());
Samuel Antaod06239d2016-07-15 23:13:27 +00003971 });
3972 return DevA;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003973 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003974
3975 // If 'Action 2' is host, we generate jobs for the device dependences and
3976 // override the current action with the host dependence. Otherwise, we
3977 // generate the host dependences and override the action with the device
3978 // dependence. The dependences can't therefore be a top-level action.
3979 OA->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003980 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003981 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3982 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3983 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3984 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003985 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003986 });
3987
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003988 A = BuildingForOffloadDevice
Samuel Antaod06239d2016-07-15 23:13:27 +00003989 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3990 : OA->getHostDependence();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003991 }
3992
Daniel Dunbare75d8342009-03-16 06:56:51 +00003993 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003994 // FIXME: It would be nice to not claim this here; maybe the old scheme of
3995 // just using Args was better?
Daniel Dunbar5cdf3e02009-03-19 07:29:38 +00003996 const Arg &Input = IA->getInputArg();
3997 Input.claim();
Daniel Dunbar35cbfeb2010-06-09 22:31:08 +00003998 if (Input.getOption().matches(options::OPT_INPUT)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00003999 const char *Name = Input.getValue();
Justin Lebard98cea82016-01-11 23:15:21 +00004000 return InputInfo(A, Name, /* BaseInput = */ Name);
Douglas Katzman678d0cb2015-06-16 18:01:24 +00004001 }
Justin Lebard98cea82016-01-11 23:15:21 +00004002 return InputInfo(A, &Input, /* BaseInput = */ "");
Daniel Dunbare75d8342009-03-16 06:56:51 +00004003 }
4004
4005 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
Chad Rosiera78a6eb2012-04-27 16:50:38 +00004006 const ToolChain *TC;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004007 StringRef ArchName = BAA->getArchName();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00004008
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004009 if (!ArchName.empty())
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00004010 TC = &getToolChain(C.getArgs(),
Petr Hosekdd38d932018-05-29 22:35:39 +00004011 computeTargetTriple(*this, TargetTriple,
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00004012 C.getArgs(), ArchName));
Chad Rosiera78a6eb2012-04-27 16:50:38 +00004013 else
4014 TC = &C.getDefaultToolChain();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00004015
Nico Weber5a459f82016-02-23 19:30:43 +00004016 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00004017 MultipleArchs, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004018 TargetDeviceOffloadKind);
Daniel Dunbare75d8342009-03-16 06:56:51 +00004019 }
4020
Artem Belevich0ff05cd2015-07-13 23:27:56 +00004021
Richard Smithcd35eff2018-09-15 01:21:16 +00004022 ActionList Inputs = A->getInputs();
Daniel Dunbarc4343942010-02-03 03:07:56 +00004023
4024 const JobAction *JA = cast<JobAction>(A);
Samuel Antaod06239d2016-07-15 23:13:27 +00004025 ActionList CollapsedOffloadActions;
4026
Mehdi Amini6683e222017-01-24 18:12:25 +00004027 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
4028 embedBitcodeInObject() && !isUsingLTO());
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00004029 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
4030
Rafael Espindola79764462013-03-24 15:06:53 +00004031 if (!T)
Justin Lebar9eaa4892016-01-11 23:09:32 +00004032 return InputInfo();
Daniel Dunbare75d8342009-03-16 06:56:51 +00004033
Samuel Antaod06239d2016-07-15 23:13:27 +00004034 // If we've collapsed action list that contained OffloadAction we
4035 // need to build jobs for host/device-side inputs it may have held.
4036 for (const auto *OA : CollapsedOffloadActions)
4037 cast<OffloadAction>(OA)->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004038 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00004039 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
4040 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
Artem Belevichbee2f412016-08-22 18:50:34 +00004041 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
Samuel Antaod06239d2016-07-15 23:13:27 +00004042 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004043 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00004044 });
Artem Belevichf8144ab2015-08-27 18:10:41 +00004045
Daniel Dunbare75d8342009-03-16 06:56:51 +00004046 // Only use pipes when there is exactly one input.
Daniel Dunbar1a093d22009-03-18 06:00:36 +00004047 InputInfoList InputInfos;
Richard Smithcd35eff2018-09-15 01:21:16 +00004048 for (const Action *Input : Inputs) {
Eric Christopher14668dd2013-02-18 00:38:25 +00004049 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
4050 // shouldn't get temporary output names.
Daniel Dunbar6beaf512010-06-04 18:28:41 +00004051 // FIXME: Clean this up.
Justin Lebar9eaa4892016-01-11 23:09:32 +00004052 bool SubJobAtTopLevel =
4053 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
Samuel Antaod06239d2016-07-15 23:13:27 +00004054 InputInfos.push_back(BuildJobsForAction(
4055 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004056 CachedResults, A->getOffloadingDeviceKind()));
Daniel Dunbare75d8342009-03-16 06:56:51 +00004057 }
4058
Daniel Dunbare75d8342009-03-16 06:56:51 +00004059 // Always use the first input as the base input.
4060 const char *BaseInput = InputInfos[0].getBaseInput();
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004061
Daniel Dunbar6beaf512010-06-04 18:28:41 +00004062 // ... except dsymutil actions, which use their actual input as the base
4063 // input.
4064 if (JA->getType() == types::TY_dSYM)
4065 BaseInput = InputInfos[0].getFilename();
4066
Richard Smithcd35eff2018-09-15 01:21:16 +00004067 // ... and in header module compilations, which use the module name.
4068 if (auto *ModuleJA = dyn_cast<HeaderModulePrecompileJobAction>(JA))
4069 BaseInput = ModuleJA->getModuleName();
4070
Samuel Antaod06239d2016-07-15 23:13:27 +00004071 // Append outputs of offload device jobs to the input list
4072 if (!OffloadDependencesInputInfo.empty())
4073 InputInfos.append(OffloadDependencesInputInfo.begin(),
4074 OffloadDependencesInputInfo.end());
Artem Belevich0ff05cd2015-07-13 23:27:56 +00004075
Vedant Kumar18286cf2016-07-27 23:02:20 +00004076 // Set the effective triple of the toolchain for the duration of this job.
4077 llvm::Triple EffectiveTriple;
4078 const ToolChain &ToolTC = T->getToolChain();
Samuel Antao31fef982016-10-27 17:39:44 +00004079 const ArgList &Args =
4080 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
Vedant Kumar18286cf2016-07-27 23:02:20 +00004081 if (InputInfos.size() != 1) {
4082 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
4083 } else {
4084 // Pass along the input type if it can be unambiguously determined.
4085 EffectiveTriple = llvm::Triple(
4086 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
4087 }
4088 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
4089
Daniel Dunbard00272f2010-08-02 02:38:15 +00004090 // Determine the place to write output to, if any.
Justin Lebar9eaa4892016-01-11 23:09:32 +00004091 InputInfo Result;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004092 InputInfoList UnbundlingResults;
4093 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
4094 // If we have an unbundling job, we need to create results for all the
4095 // outputs. We also update the results cache so that other actions using
4096 // this unbundling action can get the right results.
4097 for (auto &UI : UA->getDependentActionsInfo()) {
4098 assert(UI.DependentOffloadKind != Action::OFK_None &&
4099 "Unbundling with no offloading??");
4100
4101 // Unbundling actions are never at the top level. When we generate the
4102 // offloading prefix, we also do that for the host file because the
4103 // unbundling action does not change the type of the output which can
4104 // cause a overwrite.
4105 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4106 UI.DependentOffloadKind,
4107 UI.DependentToolChain->getTriple().normalize(),
4108 /*CreatePrefixForHost=*/true);
4109 auto CurI = InputInfo(
Yaxun Liu609f7522018-05-11 19:02:18 +00004110 UA,
4111 GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
4112 /*AtTopLevel=*/false,
4113 MultipleArchs ||
4114 UI.DependentOffloadKind == Action::OFK_HIP,
4115 OffloadingPrefix),
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004116 BaseInput);
4117 // Save the unbundling result.
4118 UnbundlingResults.push_back(CurI);
4119
4120 // Get the unique string identifier for this dependence and cache the
4121 // result.
Yaxun Liu470b8332018-06-06 19:44:10 +00004122 StringRef Arch;
4123 if (TargetDeviceOffloadKind == Action::OFK_HIP) {
4124 if (UI.DependentOffloadKind == Action::OFK_Host)
Yaxun Liuf37b50a2018-07-24 01:03:44 +00004125 Arch = StringRef();
Yaxun Liu470b8332018-06-06 19:44:10 +00004126 else
4127 Arch = UI.DependentBoundArch;
4128 } else
4129 Arch = BoundArch;
4130
4131 CachedResults[{A, GetTriplePlusArchString(UI.DependentToolChain, Arch,
4132 UI.DependentOffloadKind)}] =
4133 CurI;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004134 }
4135
4136 // Now that we have all the results generated, select the one that should be
4137 // returned for the current depending action.
4138 std::pair<const Action *, std::string> ActionTC = {
4139 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
4140 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
4141 "Result does not exist??");
4142 Result = CachedResults[ActionTC];
4143 } else if (JA->getType() == types::TY_Nothing)
Justin Lebard98cea82016-01-11 23:15:21 +00004144 Result = InputInfo(A, BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004145 else {
4146 // We only have to generate a prefix for the host if this is not a top-level
4147 // action.
4148 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4149 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
4150 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
4151 !AtTopLevel);
Justin Lebard98cea82016-01-11 23:15:21 +00004152 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
Samuel Antaod06239d2016-07-15 23:13:27 +00004153 AtTopLevel, MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004154 OffloadingPrefix),
Justin Lebard98cea82016-01-11 23:15:21 +00004155 BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004156 }
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004157
Chad Rosierbe10f982011-08-02 17:58:04 +00004158 if (CCCPrintBindings && !CCGenDiagnostics) {
Rafael Espindola79764462013-03-24 15:06:53 +00004159 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
4160 << " - \"" << T->getName() << "\", inputs: [";
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004161 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
4162 llvm::errs() << InputInfos[i].getAsString();
4163 if (i + 1 != e)
4164 llvm::errs() << ", ";
4165 }
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004166 if (UnbundlingResults.empty())
4167 llvm::errs() << "], output: " << Result.getAsString() << "\n";
4168 else {
4169 llvm::errs() << "], outputs: [";
4170 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
4171 llvm::errs() << UnbundlingResults[i].getAsString();
4172 if (i + 1 != e)
4173 llvm::errs() << ", ";
4174 }
4175 llvm::errs() << "] \n";
4176 }
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004177 } else {
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004178 if (UnbundlingResults.empty())
4179 T->ConstructJob(
4180 C, *JA, Result, InputInfos,
4181 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4182 LinkingOutput);
4183 else
Samuel Antao7108bf32016-11-03 15:41:50 +00004184 T->ConstructJobMultipleOutputs(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004185 C, *JA, UnbundlingResults, InputInfos,
4186 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4187 LinkingOutput);
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004188 }
Justin Lebar9eaa4892016-01-11 23:09:32 +00004189 return Result;
Daniel Dunbare75d8342009-03-16 06:56:51 +00004190}
4191
Hans Wennborga7707222015-01-09 17:38:53 +00004192const char *Driver::getDefaultImageName() const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004193 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Hans Wennborga7707222015-01-09 17:38:53 +00004194 return Target.isOSWindows() ? "a.exe" : "a.out";
4195}
4196
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004197/// Create output filename based on ArgValue, which could either be a
Hans Wennborg2c21f742013-10-17 16:16:23 +00004198/// full filename, filename without extension, or a directory. If ArgValue
4199/// does not provide a filename, then use BaseName, and use the extension
4200/// suitable for FileType.
Hans Wennborg207fcf02013-08-12 21:56:42 +00004201static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004202 StringRef BaseName,
4203 types::ID FileType) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004204 SmallString<128> Filename = ArgValue;
Justin Bogner5aaf2e72014-06-26 20:59:36 +00004205
Hans Wennborgf1a74252013-09-10 20:18:04 +00004206 if (ArgValue.empty()) {
4207 // If the argument is empty, output to BaseName in the current dir.
4208 Filename = BaseName;
4209 } else if (llvm::sys::path::is_separator(Filename.back())) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004210 // If the argument is a directory, output to BaseName in that dir.
4211 llvm::sys::path::append(Filename, BaseName);
4212 }
4213
4214 if (!llvm::sys::path::has_extension(ArgValue)) {
4215 // If the argument didn't provide an extension, then set it.
4216 const char *Extension = types::getTypeTempSuffix(FileType, true);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004217
4218 if (FileType == types::TY_Image &&
4219 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
4220 // The output file is a dll.
4221 Extension = "dll";
4222 }
4223
Hans Wennborg207fcf02013-08-12 21:56:42 +00004224 llvm::sys::path::replace_extension(Filename, Extension);
4225 }
4226
4227 return Args.MakeArgString(Filename.c_str());
4228}
4229
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004230const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004231 const char *BaseInput,
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004232 StringRef BoundArch, bool AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00004233 bool MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004234 StringRef OffloadingPrefix) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00004235 llvm::PrettyStackTraceString CrashInfo("Computing output path");
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004236 // Output to a user requested destination?
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004237 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004238 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
Chad Rosier633dcdc2013-01-24 19:14:47 +00004239 return C.addResultFile(FinalOutput->getValue(), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004240 }
4241
Hans Wennborge0053472013-12-20 18:40:46 +00004242 // For /P, preprocess to file named after BaseInput.
4243 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
4244 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
4245 StringRef BaseName = llvm::sys::path::filename(BaseInput);
Hans Wennborg04c764f2014-06-17 00:19:12 +00004246 StringRef NameArg;
Greg Bedwell065f70a2015-06-09 10:24:06 +00004247 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
Hans Wennborg04c764f2014-06-17 00:19:12 +00004248 NameArg = A->getValue();
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004249 return C.addResultFile(
4250 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
4251 &JA);
Hans Wennborge0053472013-12-20 18:40:46 +00004252 }
4253
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004254 // Default to writing to stdout?
David Blaikiebc023c92018-06-14 23:09:06 +00004255 if (AtTopLevel && !CCGenDiagnostics && isa<PreprocessJobAction>(JA))
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004256 return "-";
4257
Hans Wennborg2c21f742013-10-17 16:16:23 +00004258 // Is this the assembly listing for /FA?
4259 if (JA.getType() == types::TY_PP_Asm &&
4260 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
4261 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
4262 // Use /Fa and the input filename to determine the asm file name.
4263 StringRef BaseName = llvm::sys::path::filename(BaseInput);
4264 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004265 return C.addResultFile(
4266 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
4267 &JA);
Hans Wennborg2c21f742013-10-17 16:16:23 +00004268 }
4269
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004270 // Output to a temporary file?
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004271 if ((!AtTopLevel && !isSaveTempsEnabled() &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004272 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
Chad Rosierbe10f982011-08-02 17:58:04 +00004273 CCGenDiagnostics) {
Chad Rosier97c37372011-08-26 22:27:02 +00004274 StringRef Name = llvm::sys::path::filename(BaseInput);
4275 std::pair<StringRef, StringRef> Split = Name.split('.');
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004276 SmallString<128> TmpName;
4277 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
4278 Arg *A = C.getArgs().getLastArg(options::OPT_fcrash_diagnostics_dir);
4279 if (CCGenDiagnostics && A) {
4280 SmallString<128> CrashDirectory(A->getValue());
Petr Hosek1e393062019-05-04 00:55:14 +00004281 if (!getVFS().exists(CrashDirectory))
4282 llvm::sys::fs::create_directories(CrashDirectory);
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004283 llvm::sys::path::append(CrashDirectory, Split.first);
4284 const char *Middle = Suffix ? "-%%%%%%." : "-%%%%%%";
Simon Atanasyan27c0f202019-04-02 18:03:15 +00004285 std::error_code EC = llvm::sys::fs::createUniqueFile(
4286 CrashDirectory + Middle + Suffix, TmpName);
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004287 if (EC) {
4288 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4289 return "";
4290 }
4291 } else {
4292 TmpName = GetTemporaryPath(Split.first, Suffix);
4293 }
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004294 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004295 }
4296
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004297 SmallString<128> BasePath(BaseInput);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004298 StringRef BaseName;
Daniel Dunbar67fea712011-03-25 18:16:51 +00004299
4300 // Dsymutil actions should use the full path.
Eric Christopher551ef452011-08-23 17:56:55 +00004301 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
Daniel Dunbar67fea712011-03-25 18:16:51 +00004302 BaseName = BasePath;
4303 else
4304 BaseName = llvm::sys::path::filename(BasePath);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004305
4306 // Determine what the derived output name should be.
4307 const char *NamedOutput;
Hans Wennborg2b89a262013-08-06 22:11:28 +00004308
Hans Wennborg625fba82016-10-04 21:01:04 +00004309 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004310 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
4311 // The /Fo or /o flag decides the object filename.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004312 StringRef Val =
4313 C.getArgs()
4314 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
4315 ->getValue();
4316 NamedOutput =
4317 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
Hans Wennborg207fcf02013-08-12 21:56:42 +00004318 } else if (JA.getType() == types::TY_Image &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004319 C.getArgs().hasArg(options::OPT__SLASH_Fe,
4320 options::OPT__SLASH_o)) {
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004321 // The /Fe or /o flag names the linked file.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004322 StringRef Val =
4323 C.getArgs()
4324 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
4325 ->getValue();
4326 NamedOutput =
4327 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004328 } else if (JA.getType() == types::TY_Image) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004329 if (IsCLMode()) {
4330 // clang-cl uses BaseName for the executable name.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004331 NamedOutput =
4332 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
Samuel Antao59efaed2016-10-27 17:31:22 +00004333 } else {
Hans Wennborga7707222015-01-09 17:38:53 +00004334 SmallString<128> Output(getDefaultImageName());
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004335 Output += OffloadingPrefix;
Samuel Antao59efaed2016-10-27 17:31:22 +00004336 if (MultipleArchs && !BoundArch.empty()) {
4337 Output += "-";
4338 Output.append(BoundArch);
4339 }
Chad Rosier35767232013-04-30 22:01:21 +00004340 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
Nico Weber2ca4be92016-03-01 23:16:44 +00004341 }
4342 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004343 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004344 } else {
Hans Wennborg0a096a02013-09-05 17:05:56 +00004345 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004346 assert(Suffix && "All types used for output should have a suffix.");
4347
4348 std::string::size_type End = std::string::npos;
4349 if (!types::appendSuffixForType(JA.getType()))
4350 End = BaseName.rfind('.');
Chad Rosier35767232013-04-30 22:01:21 +00004351 SmallString<128> Suffixed(BaseName.substr(0, End));
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004352 Suffixed += OffloadingPrefix;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004353 if (MultipleArchs && !BoundArch.empty()) {
Chad Rosier35767232013-04-30 22:01:21 +00004354 Suffixed += "-";
4355 Suffixed.append(BoundArch);
4356 }
Bob Wilson23a55f12014-12-21 07:00:00 +00004357 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
4358 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
4359 // optimized bitcode output.
4360 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
4361 JA.getType() == types::TY_LLVM_BC)
4362 Suffixed += ".tmp";
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004363 Suffixed += '.';
4364 Suffixed += Suffix;
4365 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
4366 }
4367
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004368 // Prepend object file path if -save-temps=obj
4369 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
4370 JA.getType() != types::TY_PCH) {
4371 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
4372 SmallString<128> TempPath(FinalOutput->getValue());
4373 llvm::sys::path::remove_filename(TempPath);
4374 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
4375 llvm::sys::path::append(TempPath, OutputFileName);
4376 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
4377 }
4378
Chad Rosier62135492012-07-09 17:31:28 +00004379 // If we're saving temps and the temp file conflicts with the input file,
Chad Rosier5b58af02012-04-20 20:05:08 +00004380 // then avoid overwriting input file.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004381 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
Chad Rosier5b58af02012-04-20 20:05:08 +00004382 bool SameFile = false;
4383 SmallString<256> Result;
4384 llvm::sys::fs::current_path(Result);
4385 llvm::sys::path::append(Result, BaseName);
4386 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
4387 // Must share the same path to conflict.
4388 if (SameFile) {
4389 StringRef Name = llvm::sys::path::filename(BaseInput);
4390 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004391 std::string TmpName = GetTemporaryPath(
4392 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004393 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Chad Rosier5b58af02012-04-20 20:05:08 +00004394 }
Chad Rosierf8412cd2011-07-15 21:54:29 +00004395 }
4396
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004397 // As an annoying special case, PCH generation doesn't strip the pathname.
Nico Weber8ab92192016-03-02 23:29:29 +00004398 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
Michael J. Spencere1696752010-12-18 00:19:12 +00004399 llvm::sys::path::remove_filename(BasePath);
4400 if (BasePath.empty())
Daniel Dunbare6c83192009-03-18 09:58:30 +00004401 BasePath = NamedOutput;
4402 else
Michael J. Spencere1696752010-12-18 00:19:12 +00004403 llvm::sys::path::append(BasePath, NamedOutput);
Chad Rosier633dcdc2013-01-24 19:14:47 +00004404 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004405 } else {
Chad Rosier633dcdc2013-01-24 19:14:47 +00004406 return C.addResultFile(NamedOutput, &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004407 }
4408}
4409
Mehdi Amini12011172016-10-06 05:11:48 +00004410std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
Raphael Isemannb23ccec2018-12-10 12:37:46 +00004411 // Search for Name in a list of paths.
Petr Hosek8f2499f2018-09-12 03:26:10 +00004412 auto SearchPaths = [&](const llvm::SmallVectorImpl<std::string> &P)
4413 -> llvm::Optional<std::string> {
4414 // Respect a limited subset of the '-Bprefix' functionality in GCC by
4415 // attempting to use this prefix when looking for file paths.
4416 for (const auto &Dir : P) {
4417 if (Dir.empty())
4418 continue;
4419 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
4420 llvm::sys::path::append(P, Name);
4421 if (llvm::sys::fs::exists(Twine(P)))
Simon Pilgrim4588fc82018-09-13 10:10:18 +00004422 return P.str().str();
Petr Hosek8f2499f2018-09-12 03:26:10 +00004423 }
4424 return None;
4425 };
4426
4427 if (auto P = SearchPaths(PrefixDirs))
4428 return *P;
Chandler Carruth84559242010-03-22 01:52:07 +00004429
Petr Hosek916a4672017-08-10 04:16:38 +00004430 SmallString<128> R(ResourceDir);
4431 llvm::sys::path::append(R, Name);
4432 if (llvm::sys::fs::exists(Twine(R)))
4433 return R.str();
4434
4435 SmallString<128> P(TC.getCompilerRTPath());
Rafael Espindola609a6642013-06-24 18:33:43 +00004436 llvm::sys::path::append(P, Name);
4437 if (llvm::sys::fs::exists(Twine(P)))
Peter Collingbournefa9771f2011-09-06 02:08:31 +00004438 return P.str();
4439
Petr Hosek92d706e2019-05-29 00:01:05 +00004440 SmallString<128> D(Dir);
4441 llvm::sys::path::append(D, "..", Name);
4442 if (llvm::sys::fs::exists(Twine(D)))
4443 return D.str();
4444
Petr Hosek8f2499f2018-09-12 03:26:10 +00004445 if (auto P = SearchPaths(TC.getLibraryPaths()))
4446 return *P;
4447
4448 if (auto P = SearchPaths(TC.getFilePaths()))
4449 return *P;
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004450
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004451 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004452}
4453
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004454void Driver::generatePrefixedToolNames(
Mehdi Amini12011172016-10-06 05:11:48 +00004455 StringRef Tool, const ToolChain &TC,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004456 SmallVectorImpl<std::string> &Names) const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004457 // FIXME: Needs a better variable than TargetTriple
4458 Names.emplace_back((TargetTriple + "-" + Tool).str());
Benjamin Kramer3204b152015-05-29 19:42:19 +00004459 Names.emplace_back(Tool);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004460
4461 // Allow the discovery of tools prefixed with LLVM's default target triple.
Petr Hosekdd38d932018-05-29 22:35:39 +00004462 std::string DefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
4463 if (DefaultTargetTriple != TargetTriple)
4464 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004465}
4466
Benjamin Kramer7111b912014-11-04 20:26:01 +00004467static bool ScanDirForExecutable(SmallString<128> &Dir,
4468 ArrayRef<std::string> Names) {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004469 for (const auto &Name : Names) {
4470 llvm::sys::path::append(Dir, Name);
4471 if (llvm::sys::fs::can_execute(Twine(Dir)))
4472 return true;
4473 llvm::sys::path::remove_filename(Dir);
4474 }
4475 return false;
4476}
4477
Mehdi Amini12011172016-10-06 05:11:48 +00004478std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004479 SmallVector<std::string, 2> TargetSpecificExecutables;
4480 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
4481
Chandler Carruth84559242010-03-22 01:52:07 +00004482 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00004483 // attempting to use this prefix when looking for program paths.
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004484 for (const auto &PrefixDir : PrefixDirs) {
4485 if (llvm::sys::fs::is_directory(PrefixDir)) {
4486 SmallString<128> P(PrefixDir);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004487 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004488 return P.str();
Simon Atanasyana47ba292012-10-31 14:39:28 +00004489 } else {
Mehdi Amini12011172016-10-06 05:11:48 +00004490 SmallString<128> P((PrefixDir + Name).str());
Rafael Espindola609a6642013-06-24 18:33:43 +00004491 if (llvm::sys::fs::can_execute(Twine(P)))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004492 return P.str();
Simon Atanasyan86bdab72012-10-31 12:01:53 +00004493 }
Chandler Carruth84559242010-03-22 01:52:07 +00004494 }
4495
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004496 const ToolChain::path_list &List = TC.getProgramPaths();
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004497 for (const auto &Path : List) {
4498 SmallString<128> P(Path);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004499 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004500 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004501 }
4502
Daniel Dunbar76ce7412009-03-23 16:15:50 +00004503 // If all else failed, search the path.
Michael J. Spencerb011d482014-11-07 21:30:32 +00004504 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
4505 if (llvm::ErrorOr<std::string> P =
4506 llvm::sys::findProgramByName(TargetSpecificExecutable))
Michael J. Spencer04162ea2014-11-04 01:30:55 +00004507 return *P;
Daniel Dunbar6f668772009-03-18 21:34:08 +00004508
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004509 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004510}
4511
Mehdi Amini12011172016-10-06 05:11:48 +00004512std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
Rafael Espindola37d229d2013-06-25 04:26:55 +00004513 SmallString<128> Path;
Rafael Espindolac0809172014-06-12 14:02:15 +00004514 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
Rafael Espindola37d229d2013-06-25 04:26:55 +00004515 if (EC) {
4516 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004517 return "";
4518 }
4519
Rafael Espindola37d229d2013-06-25 04:26:55 +00004520 return Path.str();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004521}
4522
Steven Wuc3399db62019-01-11 21:16:04 +00004523std::string Driver::GetTemporaryDirectory(StringRef Prefix) const {
4524 SmallString<128> Path;
4525 std::error_code EC = llvm::sys::fs::createUniqueDirectory(Prefix, Path);
4526 if (EC) {
4527 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4528 return "";
4529 }
4530
4531 return Path.str();
4532}
4533
Nico Weber2ca4be92016-03-01 23:16:44 +00004534std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
4535 SmallString<128> Output;
4536 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
4537 // FIXME: If anybody needs it, implement this obscure rule:
4538 // "If you specify a directory without a file name, the default file name
4539 // is VCx0.pch., where x is the major version of Visual C++ in use."
4540 Output = FpArg->getValue();
4541
4542 // "If you do not specify an extension as part of the path name, an
4543 // extension of .pch is assumed. "
4544 if (!llvm::sys::path::has_extension(Output))
4545 Output += ".pch";
4546 } else {
Mike Rice58df1af2018-09-11 17:10:44 +00004547 if (Arg *YcArg = C.getArgs().getLastArg(options::OPT__SLASH_Yc))
4548 Output = YcArg->getValue();
4549 if (Output.empty())
4550 Output = BaseName;
Nico Weber2ca4be92016-03-01 23:16:44 +00004551 llvm::sys::path::replace_extension(Output, ".pch");
4552 }
4553 return Output.str();
4554}
4555
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004556const ToolChain &Driver::getToolChain(const ArgList &Args,
Artem Belevich959e0542015-07-10 19:47:55 +00004557 const llvm::Triple &Target) const {
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004558
David Blaikie6ad71012017-01-13 18:53:43 +00004559 auto &TC = ToolChains[Target.str()];
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004560 if (!TC) {
4561 switch (Target.getOS()) {
Reid Kleckner330fb172016-05-11 16:19:05 +00004562 case llvm::Triple::Haiku:
David Blaikie6ad71012017-01-13 18:53:43 +00004563 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
Reid Kleckner330fb172016-05-11 16:19:05 +00004564 break;
Ed Schouten4dabea22017-06-25 08:29:09 +00004565 case llvm::Triple::Ananas:
4566 TC = llvm::make_unique<toolchains::Ananas>(*this, Target, Args);
4567 break;
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004568 case llvm::Triple::CloudABI:
David Blaikie6ad71012017-01-13 18:53:43 +00004569 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004570 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004571 case llvm::Triple::Darwin:
4572 case llvm::Triple::MacOSX:
4573 case llvm::Triple::IOS:
Tim Northover6f3ff222015-10-30 16:30:27 +00004574 case llvm::Triple::TvOS:
4575 case llvm::Triple::WatchOS:
David Blaikie6ad71012017-01-13 18:53:43 +00004576 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004577 break;
4578 case llvm::Triple::DragonFly:
David Blaikie6ad71012017-01-13 18:53:43 +00004579 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004580 break;
4581 case llvm::Triple::OpenBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004582 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004583 break;
4584 case llvm::Triple::NetBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004585 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004586 break;
4587 case llvm::Triple::FreeBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004588 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004589 break;
4590 case llvm::Triple::Minix:
David Blaikie6ad71012017-01-13 18:53:43 +00004591 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004592 break;
4593 case llvm::Triple::Linux:
Andrey Turetskiy4798eb62016-06-16 10:36:09 +00004594 case llvm::Triple::ELFIAMCU:
Chandler Carruthcf705b22012-01-25 21:03:58 +00004595 if (Target.getArch() == llvm::Triple::hexagon)
David Blaikie6ad71012017-01-13 18:53:43 +00004596 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4597 Args);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004598 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
4599 !Target.hasEnvironment())
David Blaikie6ad71012017-01-13 18:53:43 +00004600 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
4601 Args);
Qiu Chaofan19828e32019-04-23 05:50:24 +00004602 else if (Target.getArch() == llvm::Triple::ppc ||
4603 Target.getArch() == llvm::Triple::ppc64 ||
4604 Target.getArch() == llvm::Triple::ppc64le)
4605 TC = llvm::make_unique<toolchains::PPCLinuxToolChain>(*this, Target,
4606 Args);
Chandler Carruthcf705b22012-01-25 21:03:58 +00004607 else
David Blaikie6ad71012017-01-13 18:53:43 +00004608 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004609 break;
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004610 case llvm::Triple::NaCl:
David Blaikie6ad71012017-01-13 18:53:43 +00004611 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004612 break;
Petr Hosek62e1d232016-10-06 06:08:09 +00004613 case llvm::Triple::Fuchsia:
David Blaikie6ad71012017-01-13 18:53:43 +00004614 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
Petr Hosek62e1d232016-10-06 06:08:09 +00004615 break;
David Chisnallf571cde2012-02-15 13:39:01 +00004616 case llvm::Triple::Solaris:
David Blaikie6ad71012017-01-13 18:53:43 +00004617 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
David Chisnallf571cde2012-02-15 13:39:01 +00004618 break;
Tom Stellard8fa33092015-07-18 01:49:05 +00004619 case llvm::Triple::AMDHSA:
David Blaikie6ad71012017-01-13 18:53:43 +00004620 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
Tom Stellard8fa33092015-07-18 01:49:05 +00004621 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004622 case llvm::Triple::Win32:
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004623 switch (Target.getEnvironment()) {
4624 default:
4625 if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004626 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004627 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004628 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004629 else
David Blaikie6ad71012017-01-13 18:53:43 +00004630 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004631 break;
4632 case llvm::Triple::GNU:
David Blaikie6ad71012017-01-13 18:53:43 +00004633 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004634 break;
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004635 case llvm::Triple::Itanium:
David Blaikie6ad71012017-01-13 18:53:43 +00004636 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
4637 Args);
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004638 break;
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004639 case llvm::Triple::MSVC:
4640 case llvm::Triple::UnknownEnvironment:
Dave Leef96bedf2017-11-06 21:18:05 +00004641 if (Args.getLastArgValue(options::OPT_fuse_ld_EQ)
4642 .startswith_lower("bfd"))
4643 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(
4644 *this, Target, Args);
4645 else
4646 TC =
4647 llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004648 break;
4649 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004650 break;
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004651 case llvm::Triple::PS4:
David Blaikie6ad71012017-01-13 18:53:43 +00004652 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004653 break;
David L Kreitzerd397ea42016-10-14 20:44:33 +00004654 case llvm::Triple::Contiki:
David Blaikie6ad71012017-01-13 18:53:43 +00004655 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
David L Kreitzerd397ea42016-10-14 20:44:33 +00004656 break;
Kristina Brooks77a4adc2018-11-29 03:49:14 +00004657 case llvm::Triple::Hurd:
4658 TC = llvm::make_unique<toolchains::Hurd>(*this, Target, Args);
4659 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004660 default:
Douglas Katzman9f5e70e2015-05-26 18:01:33 +00004661 // Of these targets, Hexagon is the only one that might have
4662 // an OS of Linux, in which case it got handled above already.
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004663 switch (Target.getArch()) {
4664 case llvm::Triple::tce:
David Blaikie6ad71012017-01-13 18:53:43 +00004665 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004666 break;
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004667 case llvm::Triple::tcele:
David Blaikie6ad71012017-01-13 18:53:43 +00004668 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004669 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004670 case llvm::Triple::hexagon:
David Blaikie6ad71012017-01-13 18:53:43 +00004671 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4672 Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004673 break;
Jacques Pienaard964cc22016-03-28 21:02:54 +00004674 case llvm::Triple::lanai:
David Blaikie6ad71012017-01-13 18:53:43 +00004675 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
Jacques Pienaard964cc22016-03-28 21:02:54 +00004676 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004677 case llvm::Triple::xcore:
David Blaikie6ad71012017-01-13 18:53:43 +00004678 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004679 break;
Dan Gohmanc2853072015-09-03 22:51:53 +00004680 case llvm::Triple::wasm32:
4681 case llvm::Triple::wasm64:
David Blaikie6ad71012017-01-13 18:53:43 +00004682 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
Dan Gohmanc2853072015-09-03 22:51:53 +00004683 break;
Dylan McKay924fa3a2017-01-05 05:20:27 +00004684 case llvm::Triple::avr:
David Blaikie6ad71012017-01-13 18:53:43 +00004685 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
Dylan McKay924fa3a2017-01-05 05:20:27 +00004686 break;
Anton Korobeynikov93165d62019-01-15 19:44:05 +00004687 case llvm::Triple::msp430:
4688 TC =
4689 llvm::make_unique<toolchains::MSP430ToolChain>(*this, Target, Args);
4690 break;
David Bolvanskyf4be2532018-07-31 14:21:46 +00004691 case llvm::Triple::riscv32:
4692 case llvm::Triple::riscv64:
4693 TC = llvm::make_unique<toolchains::RISCVToolChain>(*this, Target, Args);
4694 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004695 default:
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004696 if (Target.getVendor() == llvm::Triple::Myriad)
David Blaikie6ad71012017-01-13 18:53:43 +00004697 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
4698 Args);
Jonathan Roelofs901c7762017-05-25 15:42:13 +00004699 else if (toolchains::BareMetal::handlesTarget(Target))
4700 TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004701 else if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004702 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004703 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004704 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004705 else
David Blaikie6ad71012017-01-13 18:53:43 +00004706 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004707 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004708 }
4709 }
Justin Lebar66c4fd72016-11-18 00:41:22 +00004710
4711 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
4712 // compiles always need two toolchains, the CUDA toolchain and the host
4713 // toolchain. So the only valid way to create a CUDA toolchain is via
4714 // CreateOffloadingDeviceToolChains.
4715
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004716 return *TC;
Daniel Dunbar4dff6a42009-03-10 23:41:59 +00004717}
Daniel Dunbar8fa879d2009-03-24 18:57:02 +00004718
Rafael Espindola2f69d402013-03-18 15:33:26 +00004719bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
Douglas Katzman00249092015-06-12 15:45:21 +00004720 // Say "no" if there is not exactly one input of a type clang understands.
Nico Weber5a459f82016-02-23 19:30:43 +00004721 if (JA.size() != 1 ||
4722 !types::isAcceptedByClang((*JA.input_begin())->getType()))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004723 return false;
4724
Douglas Katzman00249092015-06-12 15:45:21 +00004725 // And say "no" if this is not a kind of action clang understands.
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004726 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
Bob Wilson23a55f12014-12-21 07:00:00 +00004727 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004728 return false;
4729
4730 return true;
4731}
4732
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004733/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
4734/// grouped values as integers. Numbers which are not provided are set to 0.
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004735///
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004736/// \return True if the entire string was parsed (9.2), or all groups were
4737/// parsed (10.3.5extrastuff).
Mehdi Amini12011172016-10-06 05:11:48 +00004738bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
4739 unsigned &Micro, bool &HadExtra) {
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004740 HadExtra = false;
4741
4742 Major = Minor = Micro = 0;
Mehdi Amini12011172016-10-06 05:11:48 +00004743 if (Str.empty())
Bob Wilson433cb312015-04-07 01:03:35 +00004744 return false;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004745
Mehdi Amini12011172016-10-06 05:11:48 +00004746 if (Str.consumeInteger(10, Major))
4747 return false;
4748 if (Str.empty())
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004749 return true;
Mehdi Amini12011172016-10-06 05:11:48 +00004750 if (Str[0] != '.')
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004751 return false;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004752
Mehdi Amini12011172016-10-06 05:11:48 +00004753 Str = Str.drop_front(1);
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004754
Mehdi Amini12011172016-10-06 05:11:48 +00004755 if (Str.consumeInteger(10, Minor))
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004756 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004757 if (Str.empty())
4758 return true;
4759 if (Str[0] != '.')
4760 return false;
4761 Str = Str.drop_front(1);
4762
4763 if (Str.consumeInteger(10, Micro))
4764 return false;
4765 if (!Str.empty())
4766 HadExtra = true;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004767 return true;
4768}
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004769
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004770/// Parse digits from a string \p Str and fulfill \p Digits with
4771/// the parsed numbers. This method assumes that the max number of
4772/// digits to look for is equal to Digits.size().
4773///
4774/// \return True if the entire string was parsed and there are
4775/// no extra characters remaining at the end.
Mehdi Amini12011172016-10-06 05:11:48 +00004776bool Driver::GetReleaseVersion(StringRef Str,
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004777 MutableArrayRef<unsigned> Digits) {
Mehdi Amini12011172016-10-06 05:11:48 +00004778 if (Str.empty())
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004779 return false;
4780
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004781 unsigned CurDigit = 0;
4782 while (CurDigit < Digits.size()) {
Mehdi Amini12011172016-10-06 05:11:48 +00004783 unsigned Digit;
4784 if (Str.consumeInteger(10, Digit))
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004785 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004786 Digits[CurDigit] = Digit;
4787 if (Str.empty())
4788 return true;
4789 if (Str[0] != '.')
4790 return false;
4791 Str = Str.drop_front(1);
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004792 CurDigit++;
4793 }
4794
4795 // More digits than requested, bail out...
4796 return false;
4797}
4798
Simon Atanasyan27c0f202019-04-02 18:03:15 +00004799std::pair<unsigned, unsigned>
4800Driver::getIncludeExcludeOptionFlagMasks(bool IsClCompatMode) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004801 unsigned IncludedFlagsBitmask = 0;
Rafael Espindolacc707bc2013-09-25 15:54:41 +00004802 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004803
Hans Wennborg797004d2018-11-08 11:27:04 +00004804 if (IsClCompatMode) {
Hans Wennborg19076102013-07-31 20:51:53 +00004805 // Include CL and Core options.
4806 IncludedFlagsBitmask |= options::CLOption;
4807 IncludedFlagsBitmask |= options::CoreOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004808 } else {
4809 ExcludedFlagsBitmask |= options::CLOption;
4810 }
4811
4812 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
4813}
Benjamin Kramerab88f622014-03-25 18:02:07 +00004814
Douglas Katzmanf08fadf2015-06-04 14:40:44 +00004815bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
Benjamin Kramerab88f622014-03-25 18:02:07 +00004816 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
4817}