blob: 925ded71e187b28c04c4ddce772bfe24052fc0b1 [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)) ||
Puyan Lotfi68f29da2019-06-20 16:59:48 +0000288 (PhaseArg = DAL.getLastArg(options::OPT_emit_iterface_stubs)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000289 (PhaseArg = DAL.getLastArg(options::OPT__analyze,
Chad Rosier1aeb15a2012-03-06 23:14:35 +0000290 options::OPT__analyze_auto)) ||
Bob Wilson23a55f12014-12-21 07:00:00 +0000291 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000292 FinalPhase = phases::Compile;
293
Bob Wilson23a55f12014-12-21 07:00:00 +0000294 // -S only runs up to the backend.
295 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
296 FinalPhase = phases::Backend;
297
Artem Belevich4242f412015-07-28 21:01:21 +0000298 // -c compilation only runs up to the assembler.
299 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000300 FinalPhase = phases::Assemble;
301
302 // Otherwise do everything.
303 } else
304 FinalPhase = phases::Link;
305
306 if (FinalPhaseArg)
307 *FinalPhaseArg = PhaseArg;
308
309 return FinalPhase;
310}
311
David Blaikie0aaa7622017-01-13 17:34:15 +0000312static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
Martin Storsjo665c7a42018-05-04 06:05:58 +0000313 StringRef Value, bool Claim = true) {
David Blaikie0aaa7622017-01-13 17:34:15 +0000314 Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
Hans Wennborged1d0722013-08-13 21:32:29 +0000315 Args.getBaseArgs().MakeIndex(Value), Value.data());
Hans Wennborg55362852014-05-02 22:55:30 +0000316 Args.AddSynthesizedArg(A);
Martin Storsjo665c7a42018-05-04 06:05:58 +0000317 if (Claim)
318 A->claim();
Hans Wennborged1d0722013-08-13 21:32:29 +0000319 return A;
320}
321
Daniel Dunbar775d4062010-06-11 22:00:26 +0000322DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
323 DerivedArgList *DAL = new DerivedArgList(Args);
324
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000325 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
Dan Albertf5ffa1a2018-12-18 23:29:35 +0000326 bool HasNostdlibxx = Args.hasArg(options::OPT_nostdlibxx);
Nirav Daveb0bb6142015-11-24 16:07:21 +0000327 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000328 for (Arg *A : Args) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000329 // Unfortunately, we have to parse some forwarding options (-Xassembler,
330 // -Xlinker, -Xpreprocessor) because we either integrate their functionality
331 // (assembler and preprocessor), or bypass a previous driver ('collect2').
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000332
333 // Rewrite linker options, to replace --no-demangle with a custom internal
334 // option.
335 if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
336 A->getOption().matches(options::OPT_Xlinker)) &&
337 A->containsValue("--no-demangle")) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000338 // Add the rewritten no-demangle argument.
339 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
340
341 // Add the remaining values as Xlinker arguments.
Benjamin Kramer72e64312015-09-24 14:48:49 +0000342 for (StringRef Val : A->getValues())
Douglas Katzmana34b7bf2015-06-30 19:32:57 +0000343 if (Val != "--no-demangle")
344 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000345
346 continue;
347 }
348
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000349 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
350 // some build systems. We don't try to be complete here because we don't
351 // care to encourage this usage model.
352 if (A->getOption().matches(options::OPT_Wp_COMMA) &&
Richard Smithbd55daf2012-11-01 04:30:05 +0000353 (A->getValue(0) == StringRef("-MD") ||
354 A->getValue(0) == StringRef("-MMD"))) {
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000355 // Rewrite to -MD/-MMD along with -MF.
Richard Smithbd55daf2012-11-01 04:30:05 +0000356 if (A->getValue(0) == StringRef("-MD"))
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000357 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
358 else
359 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
Michael J. Spencer70d85be2012-11-07 23:37:14 +0000360 if (A->getNumValues() == 2)
361 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
362 A->getValue(1));
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000363 continue;
364 }
365
Shantonu Senafeb03b2010-09-17 18:39:08 +0000366 // Rewrite reserved library names.
367 if (A->getOption().matches(options::OPT_l)) {
Richard Smithbd55daf2012-11-01 04:30:05 +0000368 StringRef Value = A->getValue();
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000369
Shantonu Senafeb03b2010-09-17 18:39:08 +0000370 // Rewrite unless -nostdlib is present.
Dan Albertf5ffa1a2018-12-18 23:29:35 +0000371 if (!HasNostdlib && !HasNodefaultlib && !HasNostdlibxx &&
372 Value == "stdc++") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000373 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000374 continue;
375 }
Shantonu Senafeb03b2010-09-17 18:39:08 +0000376
377 // Rewrite unconditionally.
378 if (Value == "cc_kext") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000379 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
Shantonu Senafeb03b2010-09-17 18:39:08 +0000380 continue;
381 }
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000382 }
383
Hans Wennborged1d0722013-08-13 21:32:29 +0000384 // Pick up inputs via the -- option.
385 if (A->getOption().matches(options::OPT__DASH_DASH)) {
386 A->claim();
Benjamin Kramer72e64312015-09-24 14:48:49 +0000387 for (StringRef Val : A->getValues())
Martin Storsjo665c7a42018-05-04 06:05:58 +0000388 DAL->append(MakeInputArg(*DAL, *Opts, Val, false));
Hans Wennborged1d0722013-08-13 21:32:29 +0000389 continue;
390 }
391
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000392 DAL->append(A);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000393 }
Daniel Dunbar775d4062010-06-11 22:00:26 +0000394
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000395 // Enforce -static if -miamcu is present.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000396 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
397 DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000398
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000399// Add a default value of -mlinker-version=, if one was given and the user
400// didn't specify one.
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000401#if defined(HOST_LINK_VERSION)
Tim Northover018578c2015-06-12 19:21:35 +0000402 if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
403 strlen(HOST_LINK_VERSION) > 0) {
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000404 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
405 HOST_LINK_VERSION);
Daniel Dunbarb613ffc2010-08-17 22:32:45 +0000406 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000407 }
408#endif
409
Daniel Dunbar775d4062010-06-11 22:00:26 +0000410 return DAL;
411}
412
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000413/// Compute target triple from args.
Artem Belevich959e0542015-07-10 19:47:55 +0000414///
415/// This routine provides the logic to compute a target triple from various
416/// args passed to the driver and the default triple string.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000417static llvm::Triple computeTargetTriple(const Driver &D,
Petr Hosekdd38d932018-05-29 22:35:39 +0000418 StringRef TargetTriple,
Artem Belevich959e0542015-07-10 19:47:55 +0000419 const ArgList &Args,
420 StringRef DarwinArchName = "") {
421 // FIXME: Already done in Compilation *Driver::BuildCompilation
422 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +0000423 TargetTriple = A->getValue();
Artem Belevich959e0542015-07-10 19:47:55 +0000424
Petr Hosekdd38d932018-05-29 22:35:39 +0000425 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Artem Belevich959e0542015-07-10 19:47:55 +0000426
Kristina Brooks77a4adc2018-11-29 03:49:14 +0000427 // GNU/Hurd's triples should have been -hurd-gnu*, but were historically made
428 // -gnu* only, and we can not change this, so we have to detect that case as
429 // being the Hurd OS.
430 if (TargetTriple.find("-unknown-gnu") != StringRef::npos ||
431 TargetTriple.find("-pc-gnu") != StringRef::npos)
432 Target.setOSName("hurd");
433
Artem Belevich959e0542015-07-10 19:47:55 +0000434 // Handle Apple-specific options available here.
435 if (Target.isOSBinFormatMachO()) {
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000436 // If an explicit Darwin arch name is given, that trumps all.
Artem Belevich959e0542015-07-10 19:47:55 +0000437 if (!DarwinArchName.empty()) {
438 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
439 return Target;
440 }
441
442 // Handle the Darwin '-arch' flag.
443 if (Arg *A = Args.getLastArg(options::OPT_arch)) {
444 StringRef ArchName = A->getValue();
445 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
446 }
447 }
448
449 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
450 // '-mbig-endian'/'-EB'.
451 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
452 options::OPT_mbig_endian)) {
453 if (A->getOption().matches(options::OPT_mlittle_endian)) {
454 llvm::Triple LE = Target.getLittleEndianArchVariant();
455 if (LE.getArch() != llvm::Triple::UnknownArch)
456 Target = std::move(LE);
457 } else {
458 llvm::Triple BE = Target.getBigEndianArchVariant();
459 if (BE.getArch() != llvm::Triple::UnknownArch)
460 Target = std::move(BE);
461 }
462 }
463
464 // Skip further flag support on OSes which don't support '-m32' or '-m64'.
Douglas Katzman15a63ed2015-08-12 18:36:12 +0000465 if (Target.getArch() == llvm::Triple::tce ||
466 Target.getOS() == llvm::Triple::Minix)
Artem Belevich959e0542015-07-10 19:47:55 +0000467 return Target;
468
469 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000470 Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
471 options::OPT_m32, options::OPT_m16);
472 if (A) {
Artem Belevich959e0542015-07-10 19:47:55 +0000473 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
474
475 if (A->getOption().matches(options::OPT_m64)) {
476 AT = Target.get64BitArchVariant().getArch();
477 if (Target.getEnvironment() == llvm::Triple::GNUX32)
478 Target.setEnvironment(llvm::Triple::GNU);
479 } else if (A->getOption().matches(options::OPT_mx32) &&
480 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
481 AT = llvm::Triple::x86_64;
482 Target.setEnvironment(llvm::Triple::GNUX32);
483 } else if (A->getOption().matches(options::OPT_m32)) {
484 AT = Target.get32BitArchVariant().getArch();
485 if (Target.getEnvironment() == llvm::Triple::GNUX32)
486 Target.setEnvironment(llvm::Triple::GNU);
487 } else if (A->getOption().matches(options::OPT_m16) &&
488 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
489 AT = llvm::Triple::x86;
490 Target.setEnvironment(llvm::Triple::CODE16);
491 }
492
493 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
494 Target.setArch(AT);
495 }
496
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000497 // Handle -miamcu flag.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000498 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
499 if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
500 D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
501 << Target.str();
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000502
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000503 if (A && !A->getOption().matches(options::OPT_m32))
504 D.Diag(diag::err_drv_argument_not_allowed_with)
505 << "-miamcu" << A->getBaseArg().getAsString(Args);
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000506
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000507 Target.setArch(llvm::Triple::x86);
508 Target.setArchName("i586");
509 Target.setEnvironment(llvm::Triple::UnknownEnvironment);
510 Target.setEnvironmentName("");
511 Target.setOS(llvm::Triple::ELFIAMCU);
512 Target.setVendor(llvm::Triple::UnknownVendor);
513 Target.setVendorName("intel");
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000514 }
515
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000516 // If target is MIPS adjust the target triple
517 // accordingly to provided ABI name.
518 A = Args.getLastArg(options::OPT_mabi_EQ);
Simon Atanasyane60eae42018-10-16 10:19:06 +0000519 if (A && Target.isMIPS()) {
520 StringRef ABIName = A->getValue();
521 if (ABIName == "32") {
522 Target = Target.get32BitArchVariant();
523 if (Target.getEnvironment() == llvm::Triple::GNUABI64 ||
524 Target.getEnvironment() == llvm::Triple::GNUABIN32)
525 Target.setEnvironment(llvm::Triple::GNU);
526 } else if (ABIName == "n32") {
527 Target = Target.get64BitArchVariant();
528 if (Target.getEnvironment() == llvm::Triple::GNU ||
529 Target.getEnvironment() == llvm::Triple::GNUABI64)
530 Target.setEnvironment(llvm::Triple::GNUABIN32);
531 } else if (ABIName == "64") {
532 Target = Target.get64BitArchVariant();
533 if (Target.getEnvironment() == llvm::Triple::GNU ||
534 Target.getEnvironment() == llvm::Triple::GNUABIN32)
535 Target.setEnvironment(llvm::Triple::GNUABI64);
536 }
537 }
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000538
Artem Belevich959e0542015-07-10 19:47:55 +0000539 return Target;
540}
541
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000542// Parse the LTO options and record the type of LTO compilation
Teresa Johnson945bc502015-10-15 20:35:53 +0000543// based on which -f(no-)?lto(=.*)? option occurs last.
544void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
545 LTOMode = LTOK_None;
546 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
547 options::OPT_fno_lto, false))
548 return;
549
550 StringRef LTOName("full");
551
552 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
Teresa Johnson6ef80dc2015-11-02 18:03:12 +0000553 if (A)
554 LTOName = A->getValue();
Teresa Johnson945bc502015-10-15 20:35:53 +0000555
556 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
557 .Case("full", LTOK_Full)
558 .Case("thin", LTOK_Thin)
559 .Default(LTOK_Unknown);
560
561 if (LTOMode == LTOK_Unknown) {
562 assert(A);
563 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
564 << A->getValue();
565 }
566}
567
Samuel Antao39f9da22016-10-27 16:38:05 +0000568/// Compute the desired OpenMP runtime from the flags provided.
569Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
570 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
571
572 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
573 if (A)
574 RuntimeName = A->getValue();
575
576 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
577 .Case("libomp", OMPRT_OMP)
578 .Case("libgomp", OMPRT_GOMP)
579 .Case("libiomp5", OMPRT_IOMP5)
580 .Default(OMPRT_Unknown);
581
582 if (RT == OMPRT_Unknown) {
583 if (A)
584 Diag(diag::err_drv_unsupported_option_argument)
585 << A->getOption().getName() << A->getValue();
586 else
587 // FIXME: We could use a nicer diagnostic here.
588 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
589 }
590
591 return RT;
592}
593
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000594void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
595 InputList &Inputs) {
596
597 //
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000598 // CUDA/HIP
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000599 //
Yaxun Liuf6144222018-05-30 00:53:50 +0000600 // We need to generate a CUDA/HIP toolchain if any of the inputs has a CUDA
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000601 // or HIP type. However, mixed CUDA/HIP compilation is not supported.
602 bool IsCuda =
603 llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000604 return types::isCuda(I.first);
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000605 });
606 bool IsHIP =
607 llvm::any_of(Inputs,
608 [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
609 return types::isHIP(I.first);
610 }) ||
611 C.getInputArgs().hasArg(options::OPT_hip_link);
612 if (IsCuda && IsHIP) {
613 Diag(clang::diag::err_drv_mix_cuda_hip);
614 return;
615 }
Yaxun Liuf6144222018-05-30 00:53:50 +0000616 if (IsCuda) {
Justin Lebar66c4fd72016-11-18 00:41:22 +0000617 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
618 const llvm::Triple &HostTriple = HostTC->getTriple();
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000619 StringRef DeviceTripleStr;
Yaxun Liuf6144222018-05-30 00:53:50 +0000620 auto OFK = Action::OFK_Cuda;
621 DeviceTripleStr =
622 HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda" : "nvptx-nvidia-cuda";
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000623 llvm::Triple CudaTriple(DeviceTripleStr);
Yaxun Liuf6144222018-05-30 00:53:50 +0000624 // Use the CUDA and host triples as the key into the ToolChains map,
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000625 // because the device toolchain we create depends on both.
David Blaikie6ad71012017-01-13 18:53:43 +0000626 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
Justin Lebar66c4fd72016-11-18 00:41:22 +0000627 if (!CudaTC) {
David Blaikie6ad71012017-01-13 18:53:43 +0000628 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000629 *this, CudaTriple, *HostTC, C.getInputArgs(), OFK);
Justin Lebar66c4fd72016-11-18 00:41:22 +0000630 }
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000631 C.addOffloadDeviceToolChain(CudaTC.get(), OFK);
Yaxun Liuf6144222018-05-30 00:53:50 +0000632 } else if (IsHIP) {
633 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
634 const llvm::Triple &HostTriple = HostTC->getTriple();
635 StringRef DeviceTripleStr;
636 auto OFK = Action::OFK_HIP;
637 DeviceTripleStr = "amdgcn-amd-amdhsa";
638 llvm::Triple HIPTriple(DeviceTripleStr);
639 // Use the HIP and host triples as the key into the ToolChains map,
640 // because the device toolchain we create depends on both.
641 auto &HIPTC = ToolChains[HIPTriple.str() + "/" + HostTriple.str()];
642 if (!HIPTC) {
643 HIPTC = llvm::make_unique<toolchains::HIPToolChain>(
644 *this, HIPTriple, *HostTC, C.getInputArgs());
645 }
646 C.addOffloadDeviceToolChain(HIPTC.get(), OFK);
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000647 }
648
649 //
Samuel Antao39f9da22016-10-27 16:38:05 +0000650 // OpenMP
651 //
652 // We need to generate an OpenMP toolchain if the user specified targets with
653 // the -fopenmp-targets option.
654 if (Arg *OpenMPTargets =
655 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
656 if (OpenMPTargets->getNumValues()) {
657 // We expect that -fopenmp-targets is always used in conjunction with the
658 // option -fopenmp specifying a valid runtime with offloading support,
659 // i.e. libomp or libiomp.
660 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
661 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
662 options::OPT_fno_openmp, false);
663 if (HasValidOpenMPRuntime) {
664 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
665 HasValidOpenMPRuntime =
666 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
667 }
668
669 if (HasValidOpenMPRuntime) {
670 llvm::StringMap<const char *> FoundNormalizedTriples;
671 for (const char *Val : OpenMPTargets->getValues()) {
672 llvm::Triple TT(Val);
673 std::string NormalizedName = TT.normalize();
674
675 // Make sure we don't have a duplicate triple.
676 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
677 if (Duplicate != FoundNormalizedTriples.end()) {
678 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
679 << Val << Duplicate->second;
680 continue;
681 }
682
683 // Store the current triple so that we can check for duplicates in the
684 // following iterations.
685 FoundNormalizedTriples[NormalizedName] = Val;
686
687 // If the specified target is invalid, emit a diagnostic.
688 if (TT.getArch() == llvm::Triple::UnknownArch)
689 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
690 else {
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000691 const ToolChain *TC;
692 // CUDA toolchains have to be selected differently. They pair host
693 // and device in their implementation.
694 if (TT.isNVPTX()) {
695 const ToolChain *HostTC =
696 C.getSingleOffloadToolChain<Action::OFK_Host>();
697 assert(HostTC && "Host toolchain should be always defined.");
698 auto &CudaTC =
Gheorghe-Teodor Bercea52898432017-08-09 01:02:19 +0000699 ToolChains[TT.str() + "/" + HostTC->getTriple().normalize()];
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000700 if (!CudaTC)
701 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Gheorghe-Teodor Bercea2c926932017-08-08 14:33:05 +0000702 *this, TT, *HostTC, C.getInputArgs(), Action::OFK_OpenMP);
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000703 TC = CudaTC.get();
704 } else
705 TC = &getToolChain(C.getInputArgs(), TT);
706 C.addOffloadDeviceToolChain(TC, Action::OFK_OpenMP);
Samuel Antao39f9da22016-10-27 16:38:05 +0000707 }
708 }
709 } else
710 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
711 } else
712 Diag(clang::diag::warn_drv_empty_joined_argument)
713 << OpenMPTargets->getAsString(C.getInputArgs());
714 }
715
716 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000717 // TODO: Add support for other offloading programming models here.
718 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000719}
720
Serge Pavlov208ac652018-01-01 13:27:01 +0000721/// Looks the given directories for the specified file.
722///
723/// \param[out] FilePath File path, if the file was found.
724/// \param[in] Dirs Directories used for the search.
725/// \param[in] FileName Name of the file to search for.
726/// \return True if file was found.
727///
728/// Looks for file specified by FileName sequentially in directories specified
729/// by Dirs.
730///
731static bool searchForFile(SmallVectorImpl<char> &FilePath,
732 ArrayRef<std::string> Dirs,
733 StringRef FileName) {
734 SmallString<128> WPath;
735 for (const StringRef &Dir : Dirs) {
736 if (Dir.empty())
737 continue;
738 WPath.clear();
739 llvm::sys::path::append(WPath, Dir, FileName);
740 llvm::sys::path::native(WPath);
741 if (llvm::sys::fs::is_regular_file(WPath)) {
742 FilePath = std::move(WPath);
743 return true;
744 }
745 }
746 return false;
747}
748
749bool Driver::readConfigFile(StringRef FileName) {
750 // Try reading the given file.
751 SmallVector<const char *, 32> NewCfgArgs;
752 if (!llvm::cl::readConfigFile(FileName, Saver, NewCfgArgs)) {
753 Diag(diag::err_drv_cannot_read_config_file) << FileName;
754 return true;
755 }
756
757 // Read options from config file.
758 llvm::SmallString<128> CfgFileName(FileName);
759 llvm::sys::path::native(CfgFileName);
760 ConfigFile = CfgFileName.str();
761 bool ContainErrors;
762 CfgOptions = llvm::make_unique<InputArgList>(
Hans Wennborg797004d2018-11-08 11:27:04 +0000763 ParseArgStrings(NewCfgArgs, IsCLMode(), ContainErrors));
Serge Pavlov208ac652018-01-01 13:27:01 +0000764 if (ContainErrors) {
765 CfgOptions.reset();
766 return true;
767 }
768
769 if (CfgOptions->hasArg(options::OPT_config)) {
770 CfgOptions.reset();
771 Diag(diag::err_drv_nested_config_file);
772 return true;
773 }
774
775 // Claim all arguments that come from a configuration file so that the driver
776 // does not warn on any that is unused.
777 for (Arg *A : *CfgOptions)
778 A->claim();
779 return false;
780}
781
782bool Driver::loadConfigFile() {
783 std::string CfgFileName;
784 bool FileSpecifiedExplicitly = false;
785
786 // Process options that change search path for config files.
787 if (CLOptions) {
788 if (CLOptions->hasArg(options::OPT_config_system_dir_EQ)) {
789 SmallString<128> CfgDir;
790 CfgDir.append(
791 CLOptions->getLastArgValue(options::OPT_config_system_dir_EQ));
792 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000793 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000794 SystemConfigDir.clear();
795 else
796 SystemConfigDir = std::string(CfgDir.begin(), CfgDir.end());
797 }
798 }
799 if (CLOptions->hasArg(options::OPT_config_user_dir_EQ)) {
800 SmallString<128> CfgDir;
801 CfgDir.append(
802 CLOptions->getLastArgValue(options::OPT_config_user_dir_EQ));
803 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000804 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000805 UserConfigDir.clear();
806 else
807 UserConfigDir = std::string(CfgDir.begin(), CfgDir.end());
808 }
809 }
810 }
811
812 // First try to find config file specified in command line.
813 if (CLOptions) {
814 std::vector<std::string> ConfigFiles =
815 CLOptions->getAllArgValues(options::OPT_config);
816 if (ConfigFiles.size() > 1) {
817 Diag(diag::err_drv_duplicate_config);
818 return true;
819 }
820
821 if (!ConfigFiles.empty()) {
822 CfgFileName = ConfigFiles.front();
823 assert(!CfgFileName.empty());
824
825 // If argument contains directory separator, treat it as a path to
826 // configuration file.
827 if (llvm::sys::path::has_parent_path(CfgFileName)) {
828 SmallString<128> CfgFilePath;
829 if (llvm::sys::path::is_relative(CfgFileName))
830 llvm::sys::fs::current_path(CfgFilePath);
831 llvm::sys::path::append(CfgFilePath, CfgFileName);
832 if (!llvm::sys::fs::is_regular_file(CfgFilePath)) {
833 Diag(diag::err_drv_config_file_not_exist) << CfgFilePath;
834 return true;
835 }
836 return readConfigFile(CfgFilePath);
837 }
838
839 FileSpecifiedExplicitly = true;
840 }
841 }
842
843 // If config file is not specified explicitly, try to deduce configuration
844 // from executable name. For instance, an executable 'armv7l-clang' will
845 // search for config file 'armv7l-clang.cfg'.
846 if (CfgFileName.empty() && !ClangNameParts.TargetPrefix.empty())
847 CfgFileName = ClangNameParts.TargetPrefix + '-' + ClangNameParts.ModeSuffix;
848
849 if (CfgFileName.empty())
850 return false;
851
852 // Determine architecture part of the file name, if it is present.
853 StringRef CfgFileArch = CfgFileName;
854 size_t ArchPrefixLen = CfgFileArch.find('-');
855 if (ArchPrefixLen == StringRef::npos)
856 ArchPrefixLen = CfgFileArch.size();
857 llvm::Triple CfgTriple;
858 CfgFileArch = CfgFileArch.take_front(ArchPrefixLen);
859 CfgTriple = llvm::Triple(llvm::Triple::normalize(CfgFileArch));
860 if (CfgTriple.getArch() == llvm::Triple::ArchType::UnknownArch)
861 ArchPrefixLen = 0;
862
863 if (!StringRef(CfgFileName).endswith(".cfg"))
864 CfgFileName += ".cfg";
865
866 // If config file starts with architecture name and command line options
867 // redefine architecture (with options like -m32 -LE etc), try finding new
868 // config file with that architecture.
869 SmallString<128> FixedConfigFile;
870 size_t FixedArchPrefixLen = 0;
871 if (ArchPrefixLen) {
872 // Get architecture name from config file name like 'i386.cfg' or
873 // 'armv7l-clang.cfg'.
874 // Check if command line options changes effective triple.
875 llvm::Triple EffectiveTriple = computeTargetTriple(*this,
876 CfgTriple.getTriple(), *CLOptions);
877 if (CfgTriple.getArch() != EffectiveTriple.getArch()) {
878 FixedConfigFile = EffectiveTriple.getArchName();
879 FixedArchPrefixLen = FixedConfigFile.size();
880 // Append the rest of original file name so that file name transforms
881 // like: i386-clang.cfg -> x86_64-clang.cfg.
882 if (ArchPrefixLen < CfgFileName.size())
883 FixedConfigFile += CfgFileName.substr(ArchPrefixLen);
884 }
885 }
886
887 // Prepare list of directories where config file is searched for.
888 SmallVector<std::string, 3> CfgFileSearchDirs;
889 CfgFileSearchDirs.push_back(UserConfigDir);
890 CfgFileSearchDirs.push_back(SystemConfigDir);
891 CfgFileSearchDirs.push_back(Dir);
892
893 // Try to find config file. First try file with corrected architecture.
894 llvm::SmallString<128> CfgFilePath;
895 if (!FixedConfigFile.empty()) {
896 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
897 return readConfigFile(CfgFilePath);
898 // If 'x86_64-clang.cfg' was not found, try 'x86_64.cfg'.
899 FixedConfigFile.resize(FixedArchPrefixLen);
900 FixedConfigFile.append(".cfg");
901 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
902 return readConfigFile(CfgFilePath);
903 }
904
905 // Then try original file name.
906 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
907 return readConfigFile(CfgFilePath);
908
909 // Finally try removing driver mode part: 'x86_64-clang.cfg' -> 'x86_64.cfg'.
910 if (!ClangNameParts.ModeSuffix.empty() &&
911 !ClangNameParts.TargetPrefix.empty()) {
912 CfgFileName.assign(ClangNameParts.TargetPrefix);
913 CfgFileName.append(".cfg");
914 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
915 return readConfigFile(CfgFilePath);
916 }
917
918 // Report error but only if config file was specified explicitly, by option
919 // --config. If it was deduced from executable name, it is not an error.
920 if (FileSpecifiedExplicitly) {
921 Diag(diag::err_drv_config_file_not_found) << CfgFileName;
922 for (const std::string &SearchDir : CfgFileSearchDirs)
923 if (!SearchDir.empty())
924 Diag(diag::note_drv_config_file_searched_in) << SearchDir;
925 return true;
926 }
927
928 return false;
929}
930
Chris Lattner54b16772011-07-23 17:14:25 +0000931Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000932 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
933
Eric Christopherf901e852011-08-17 22:59:59 +0000934 // FIXME: Handle environment options which affect driver behavior, somewhere
Bill Wendlingadbeb9f2012-03-12 21:24:57 +0000935 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
Chad Rosier82301162011-09-14 00:47:55 +0000936
David Majnemer85c25b42016-07-24 17:44:03 +0000937 if (Optional<std::string> CompilerPathValue =
938 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
939 StringRef CompilerPath = *CompilerPathValue;
Chad Rosier82301162011-09-14 00:47:55 +0000940 while (!CompilerPath.empty()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000941 std::pair<StringRef, StringRef> Split =
942 CompilerPath.split(llvm::sys::EnvPathSeparator);
Chad Rosier82301162011-09-14 00:47:55 +0000943 PrefixDirs.push_back(Split.first);
944 CompilerPath = Split.second;
945 }
946 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000947
Hans Wennborg70850d82013-07-18 20:29:38 +0000948 // We look for the driver mode option early, because the mode can affect
949 // how other options are parsed.
Zachary Turneraff19c32016-08-12 17:47:52 +0000950 ParseDriverMode(ClangExecutable, ArgList.slice(1));
Hans Wennborg70850d82013-07-18 20:29:38 +0000951
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000952 // FIXME: What are we going to do with -V and -b?
953
Serge Pavlov208ac652018-01-01 13:27:01 +0000954 // Arguments specified in command line.
955 bool ContainsError;
956 CLOptions = llvm::make_unique<InputArgList>(
Hans Wennborg797004d2018-11-08 11:27:04 +0000957 ParseArgStrings(ArgList.slice(1), IsCLMode(), ContainsError));
Serge Pavlov208ac652018-01-01 13:27:01 +0000958
959 // Try parsing configuration file.
960 if (!ContainsError)
961 ContainsError = loadConfigFile();
962 bool HasConfigFile = !ContainsError && (CfgOptions.get() != nullptr);
963
964 // All arguments, from both config file and command line.
965 InputArgList Args = std::move(HasConfigFile ? std::move(*CfgOptions)
966 : std::move(*CLOptions));
Hans Wennborg797004d2018-11-08 11:27:04 +0000967
968 auto appendOneArg = [&Args](const Arg *Opt, const Arg *BaseArg) {
Serge Pavlovf015a562018-04-26 06:28:47 +0000969 unsigned Index = Args.MakeIndex(Opt->getSpelling());
Serge Pavlov208ac652018-01-01 13:27:01 +0000970 Arg *Copy = new llvm::opt::Arg(Opt->getOption(), Opt->getSpelling(),
Serge Pavlovf015a562018-04-26 06:28:47 +0000971 Index, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000972 Copy->getValues() = Opt->getValues();
973 if (Opt->isClaimed())
974 Copy->claim();
975 Args.append(Copy);
Hans Wennborg797004d2018-11-08 11:27:04 +0000976 };
977
978 if (HasConfigFile)
979 for (auto *Opt : *CLOptions) {
980 if (Opt->getOption().matches(options::OPT_config))
981 continue;
982 const Arg *BaseArg = &Opt->getBaseArg();
983 if (BaseArg == Opt)
984 BaseArg = nullptr;
985 appendOneArg(Opt, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000986 }
987
Hans Wennborg797004d2018-11-08 11:27:04 +0000988 // In CL mode, look for any pass-through arguments
989 if (IsCLMode() && !ContainsError) {
990 SmallVector<const char *, 16> CLModePassThroughArgList;
991 for (const auto *A : Args.filtered(options::OPT__SLASH_clang)) {
992 A->claim();
993 CLModePassThroughArgList.push_back(A->getValue());
994 }
995
996 if (!CLModePassThroughArgList.empty()) {
997 // Parse any pass through args using default clang processing rather
998 // than clang-cl processing.
999 auto CLModePassThroughOptions = llvm::make_unique<InputArgList>(
1000 ParseArgStrings(CLModePassThroughArgList, false, ContainsError));
1001
1002 if (!ContainsError)
1003 for (auto *Opt : *CLModePassThroughOptions) {
1004 appendOneArg(Opt, nullptr);
1005 }
1006 }
1007 }
1008
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001009 // Check for working directory option before accessing any files
1010 if (Arg *WD = Args.getLastArg(options::OPT_working_directory))
Mikael Holmend8d3e172019-06-03 10:50:41 +00001011 if (VFS->setCurrentWorkingDirectory(WD->getValue()))
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001012 Diag(diag::err_drv_unable_to_set_working_directory) << WD->getValue();
1013
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001014 // FIXME: This stuff needs to go into the Compilation, not the driver.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001015 bool CCCPrintPhases;
Daniel Dunbard02cb1d2009-03-05 06:38:47 +00001016
Filipe Cabecinhas136f35e2015-07-18 06:35:24 +00001017 // Silence driver warnings if requested
1018 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
1019
Rafael Espindola59ae7992009-12-07 18:28:29 +00001020 // -no-canonical-prefixes is used very early in main.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001021 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
Rafael Espindola59ae7992009-12-07 18:28:29 +00001022
Daniel Dunbar926f81f2010-08-02 02:38:03 +00001023 // Ignore -pipe.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001024 Args.ClaimAllArgs(options::OPT_pipe);
Daniel Dunbar926f81f2010-08-02 02:38:03 +00001025
Daniel Dunbaracd69572009-12-04 21:55:23 +00001026 // Extract -ccc args.
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001027 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001028 // FIXME: We need to figure out where this behavior should live. Most of it
1029 // should be outside in the client; the parts that aren't should have proper
1030 // options, either by introducing new ones or by overloading gcc ones like -V
1031 // or -b.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001032 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
David Blaikie69a1d8c2015-06-22 22:07:27 +00001033 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
1034 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
Richard Smithbd55daf2012-11-01 04:30:05 +00001035 CCCGenericGCCName = A->getValue();
Bruno Cardoso Lopes52dfe712017-04-12 21:46:20 +00001036 GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
1037 options::OPT_fno_crash_diagnostics,
1038 !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
Petr Hosekdd38d932018-05-29 22:35:39 +00001039 // FIXME: TargetTriple is used by the target-prefixed calls to as/ld
Joerg Sonnenberger17d75512012-02-22 19:15:16 +00001040 // and getToolChain is const.
Hans Wennborg2e274592013-08-13 23:38:57 +00001041 if (IsCLMode()) {
Hans Wennborg73609a02014-03-28 01:19:04 +00001042 // clang-cl targets MSVC-style Win32.
Petr Hosekdd38d932018-05-29 22:35:39 +00001043 llvm::Triple T(TargetTriple);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +00001044 T.setOS(llvm::Triple::Win32);
Hans Wennborg0f0e8d62015-09-18 17:11:50 +00001045 T.setVendor(llvm::Triple::PC);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +00001046 T.setEnvironment(llvm::Triple::MSVC);
Oleg Ranevskyy80523182017-08-31 20:31:30 +00001047 T.setObjectFormat(llvm::Triple::COFF);
Petr Hosekdd38d932018-05-29 22:35:39 +00001048 TargetTriple = T.str();
Hans Wennborg2e274592013-08-13 23:38:57 +00001049 }
David Blaikie69a1d8c2015-06-22 22:07:27 +00001050 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +00001051 TargetTriple = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001052 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
Richard Smithbd55daf2012-11-01 04:30:05 +00001053 Dir = InstalledDir = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001054 for (const Arg *A : Args.filtered(options::OPT_B)) {
Benjamin Kramer1a648d12011-02-08 20:31:42 +00001055 A->claim();
Richard Smithbd55daf2012-11-01 04:30:05 +00001056 PrefixDirs.push_back(A->getValue(0));
Benjamin Kramer1a648d12011-02-08 20:31:42 +00001057 }
David Blaikie69a1d8c2015-06-22 22:07:27 +00001058 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
Richard Smithbd55daf2012-11-01 04:30:05 +00001059 SysRoot = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001060 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
Peter Collingbourne9d9e1fc2013-05-27 21:40:20 +00001061 DyldPrefix = A->getValue();
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001062
David Blaikie69a1d8c2015-06-22 22:07:27 +00001063 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
Bob Wilsona20a1da2013-03-23 05:17:59 +00001064 ResourceDir = A->getValue();
Jim Grosbach061dabf2013-03-12 20:17:58 +00001065
David Blaikie69a1d8c2015-06-22 22:07:27 +00001066 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001067 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
1068 .Case("cwd", SaveTempsCwd)
1069 .Case("obj", SaveTempsObj)
1070 .Default(SaveTempsCwd);
1071 }
1072
Steven Wu1257cd82016-05-18 17:04:52 +00001073 setLTOMode(Args);
1074
Steven Wu844ab6a2016-11-16 06:06:44 +00001075 // Process -fembed-bitcode= flags.
1076 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
1077 StringRef Name = A->getValue();
1078 unsigned Model = llvm::StringSwitch<unsigned>(Name)
1079 .Case("off", EmbedNone)
1080 .Case("all", EmbedBitcode)
1081 .Case("bitcode", EmbedBitcode)
1082 .Case("marker", EmbedMarker)
1083 .Default(~0U);
1084 if (Model == ~0U) {
1085 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
1086 << Name;
1087 } else
1088 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
Steven Wu574b0f22016-03-01 01:07:58 +00001089 }
1090
David Blaikie69a1d8c2015-06-22 22:07:27 +00001091 std::unique_ptr<llvm::opt::InputArgList> UArgs =
1092 llvm::make_unique<InputArgList>(std::move(Args));
1093
Daniel Dunbar775d4062010-06-11 22:00:26 +00001094 // Perform the default argument translations.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001095 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
Daniel Dunbar775d4062010-06-11 22:00:26 +00001096
Chandler Carruthcb916192012-01-25 08:49:21 +00001097 // Owned by the host.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00001098 const ToolChain &TC = getToolChain(
Petr Hosekdd38d932018-05-29 22:35:39 +00001099 *UArgs, computeTargetTriple(*this, TargetTriple, *UArgs));
Chandler Carruthcb916192012-01-25 08:49:21 +00001100
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00001101 // The compilation takes ownership of Args.
Benjamin Kramer43c0f482017-06-30 13:21:27 +00001102 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs,
1103 ContainsError);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001104
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001105 if (!HandleImmediateArgs(*C))
1106 return C;
1107
Chad Rosierecdede82011-08-12 22:08:57 +00001108 // Construct the list of inputs.
1109 InputList Inputs;
Hans Wennborged1d0722013-08-13 21:32:29 +00001110 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
Chad Rosierecdede82011-08-12 22:08:57 +00001111
Samuel Antaoc1ffba52016-06-13 18:10:57 +00001112 // Populate the tool chains for the offloading devices, if any.
1113 CreateOffloadingDeviceToolChains(*C, Inputs);
Justin Lebar0e450a52016-03-30 23:30:25 +00001114
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001115 // Construct the list of abstract actions to perform for this compilation. On
Tim Northover157d9112014-01-16 08:48:16 +00001116 // MachO targets this uses the driver-driver and universal actions.
1117 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001118 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001119 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001120 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001121
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001122 if (CCCPrintPhases) {
Daniel Dunbareb843be2009-03-18 03:13:20 +00001123 PrintActions(*C);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001124 return C;
1125 }
1126
1127 BuildJobs(*C);
Daniel Dunbaradc91e62009-03-15 01:38:15 +00001128
1129 return C;
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001130}
1131
Justin Bognered9cbe02015-07-09 06:58:31 +00001132static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
1133 llvm::opt::ArgStringList ASL;
1134 for (const auto *A : Args)
1135 A->render(Args, ASL);
1136
1137 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
1138 if (I != ASL.begin())
1139 OS << ' ';
1140 Command::printArg(OS, *I, true);
1141 }
1142 OS << '\n';
1143}
1144
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001145bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
1146 SmallString<128> &CrashDiagDir) {
1147 using namespace llvm::sys;
1148 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
1149 "Only knows about .crash files on Darwin");
1150
1151 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
1152 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
1153 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
1154 path::home_directory(CrashDiagDir);
1155 if (CrashDiagDir.startswith("/var/root"))
1156 CrashDiagDir = "/";
1157 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
1158 int PID =
1159#if LLVM_ON_UNIX
1160 getpid();
1161#else
1162 0;
1163#endif
1164 std::error_code EC;
1165 fs::file_status FileStatus;
1166 TimePoint<> LastAccessTime;
1167 SmallString<128> CrashFilePath;
1168 // Lookup the .crash files and get the one generated by a subprocess spawned
1169 // by this driver invocation.
1170 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
1171 File != FileEnd && !EC; File.increment(EC)) {
1172 StringRef FileName = path::filename(File->path());
1173 if (!FileName.startswith(Name))
1174 continue;
1175 if (fs::status(File->path(), FileStatus))
1176 continue;
1177 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
1178 llvm::MemoryBuffer::getFile(File->path());
1179 if (!CrashFile)
1180 continue;
1181 // The first line should start with "Process:", otherwise this isn't a real
1182 // .crash file.
1183 StringRef Data = CrashFile.get()->getBuffer();
1184 if (!Data.startswith("Process:"))
1185 continue;
1186 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
1187 size_t ParentProcPos = Data.find("Parent Process:");
1188 if (ParentProcPos == StringRef::npos)
1189 continue;
1190 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
1191 if (LineEnd == StringRef::npos)
1192 continue;
1193 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
1194 int OpenBracket = -1, CloseBracket = -1;
1195 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
1196 if (ParentProcess[i] == '[')
1197 OpenBracket = i;
1198 if (ParentProcess[i] == ']')
1199 CloseBracket = i;
1200 }
1201 // Extract the parent process PID from the .crash file and check whether
1202 // it matches this driver invocation pid.
1203 int CrashPID;
1204 if (OpenBracket < 0 || CloseBracket < 0 ||
1205 ParentProcess.slice(OpenBracket + 1, CloseBracket)
1206 .getAsInteger(10, CrashPID) || CrashPID != PID) {
1207 continue;
1208 }
1209
1210 // Found a .crash file matching the driver pid. To avoid getting an older
1211 // and misleading crash file, continue looking for the most recent.
1212 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
1213 // multiple crashes poiting to the same parent process. Since the driver
1214 // does not collect pid information for the dispatched invocation there's
1215 // currently no way to distinguish among them.
1216 const auto FileAccessTime = FileStatus.getLastModificationTime();
1217 if (FileAccessTime > LastAccessTime) {
1218 CrashFilePath.assign(File->path());
1219 LastAccessTime = FileAccessTime;
1220 }
1221 }
1222
1223 // If found, copy it over to the location of other reproducer files.
1224 if (!CrashFilePath.empty()) {
1225 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
1226 if (EC)
1227 return false;
1228 return true;
1229 }
1230
1231 return false;
1232}
1233
Eric Christopherf901e852011-08-17 22:59:59 +00001234// When clang crashes, produce diagnostic information including the fully
1235// preprocessed source file(s). Request that the developer attach the
Chad Rosierbe10f982011-08-02 17:58:04 +00001236// diagnostic information to a bug report.
Alex Lorenz045c5142018-04-07 00:03:27 +00001237void Driver::generateCompilationDiagnostics(
1238 Compilation &C, const Command &FailingCommand,
1239 StringRef AdditionalInformation, CompilationDiagnosticReport *Report) {
Chad Rosier877c0a22012-02-22 00:30:39 +00001240 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
Chad Rosier62135492012-07-09 17:31:28 +00001241 return;
Chad Rosierbee5a1d2012-03-07 00:30:40 +00001242
Chad Rosierdbf46a12013-02-01 18:30:26 +00001243 // Don't try to generate diagnostics for link or dsymutil jobs.
Justin Bognere1a33d12014-10-20 21:02:05 +00001244 if (FailingCommand.getCreator().isLinkJob() ||
1245 FailingCommand.getCreator().isDsymutilJob())
Chad Rosier877c0a22012-02-22 00:30:39 +00001246 return;
1247
Chad Rosier8179f112012-06-19 17:51:34 +00001248 // Print the version of the compiler.
1249 PrintVersion(C, llvm::errs());
1250
Chad Rosierbe10f982011-08-02 17:58:04 +00001251 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001252 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
1253 "crash backtrace, preprocessed source, and associated run script.";
Chad Rosierbe10f982011-08-02 17:58:04 +00001254
1255 // Suppress driver output and emit preprocessor output to temp file.
Hans Wennborg70850d82013-07-18 20:29:38 +00001256 Mode = CPPMode;
Chad Rosierbe10f982011-08-02 17:58:04 +00001257 CCGenDiagnostics = true;
1258
Chad Rosiercdb008d2011-11-02 21:29:05 +00001259 // Save the original job command(s).
Justin Bogner25645152014-10-21 17:24:44 +00001260 Command Cmd = FailingCommand;
Chad Rosiercdb008d2011-11-02 21:29:05 +00001261
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001262 // Keep track of whether we produce any errors while trying to produce
1263 // preprocessed sources.
1264 DiagnosticErrorTrap Trap(Diags);
1265
1266 // Suppress tool output.
Chad Rosierbe10f982011-08-02 17:58:04 +00001267 C.initCompilationForDiagnostics();
Chad Rosierecdede82011-08-12 22:08:57 +00001268
1269 // Construct the list of inputs.
1270 InputList Inputs;
1271 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001272
Chad Rosier4f81fc22011-08-12 23:30:05 +00001273 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001274 bool IgnoreInput = false;
1275
1276 // Ignore input from stdin or any inputs that cannot be preprocessed.
Paul Robinsonf44157d2014-04-28 22:24:44 +00001277 // Check type first as not all linker inputs have a value.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001278 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
Paul Robinsonf44157d2014-04-28 22:24:44 +00001279 IgnoreInput = true;
1280 } else if (!strcmp(it->second->getValue(), "-")) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001281 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001282 << "Error generating preprocessed source(s) - "
1283 "ignoring input from stdin.";
Chad Rosierd57133d2011-08-18 00:22:25 +00001284 IgnoreInput = true;
Chad Rosierd57133d2011-08-18 00:22:25 +00001285 }
1286
1287 if (IgnoreInput) {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001288 it = Inputs.erase(it);
1289 ie = Inputs.end();
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001290 } else {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001291 ++it;
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001292 }
Chad Rosier4f81fc22011-08-12 23:30:05 +00001293 }
Chad Rosierd57133d2011-08-18 00:22:25 +00001294
Chad Rosierc5103c32013-01-29 23:57:10 +00001295 if (Inputs.empty()) {
1296 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001297 << "Error generating preprocessed source(s) - "
1298 "no preprocessable inputs.";
Chad Rosierc5103c32013-01-29 23:57:10 +00001299 return;
1300 }
1301
Chad Rosiere75ef402011-09-06 23:52:36 +00001302 // Don't attempt to generate preprocessed files if multiple -arch options are
Chad Rosier636d2832012-02-13 18:16:28 +00001303 // used, unless they're all duplicates.
1304 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001305 for (const Arg *A : C.getArgs()) {
Chad Rosiere75ef402011-09-06 23:52:36 +00001306 if (A->getOption().matches(options::OPT_arch)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001307 StringRef ArchName = A->getValue();
Chad Rosier636d2832012-02-13 18:16:28 +00001308 ArchNames.insert(ArchName);
Chad Rosiere75ef402011-09-06 23:52:36 +00001309 }
1310 }
Chad Rosier636d2832012-02-13 18:16:28 +00001311 if (ArchNames.size() > 1) {
1312 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001313 << "Error generating preprocessed source(s) - cannot generate "
1314 "preprocessed source with multiple -arch options.";
Chad Rosier636d2832012-02-13 18:16:28 +00001315 return;
1316 }
Chad Rosiere75ef402011-09-06 23:52:36 +00001317
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001318 // Construct the list of abstract actions to perform for this compilation. On
1319 // Darwin OSes this uses the driver-driver and builds universal actions.
Chandler Carruthcb916192012-01-25 08:49:21 +00001320 const ToolChain &TC = C.getDefaultToolChain();
Tim Northover157d9112014-01-16 08:48:16 +00001321 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001322 BuildUniversalActions(C, TC, Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001323 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001324 BuildActions(C, C.getArgs(), Inputs, C.getActions());
Chad Rosierbe10f982011-08-02 17:58:04 +00001325
1326 BuildJobs(C);
1327
1328 // If there were errors building the compilation, quit now.
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001329 if (Trap.hasErrorOccurred()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001330 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001331 << "Error generating preprocessed source(s).";
Chad Rosierbe10f982011-08-02 17:58:04 +00001332 return;
1333 }
1334
1335 // Generate preprocessed output.
Chad Rosierdd60e092013-01-29 20:15:05 +00001336 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
Justin Bogner0cd92482015-07-02 22:52:08 +00001337 C.ExecuteJobs(C.getJobs(), FailingCommands);
Chad Rosierbe10f982011-08-02 17:58:04 +00001338
Justin Bognerbc89b182014-10-20 21:20:27 +00001339 // If any of the preprocessing commands failed, clean up and exit.
1340 if (!FailingCommands.empty()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001341 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001342 << "Error generating preprocessed source(s).";
Justin Bognerbc89b182014-10-20 21:20:27 +00001343 return;
Chad Rosierbe10f982011-08-02 17:58:04 +00001344 }
Justin Bognerbc89b182014-10-20 21:20:27 +00001345
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001346 const ArgStringList &TempFiles = C.getTempFiles();
1347 if (TempFiles.empty()) {
1348 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001349 << "Error generating preprocessed source(s).";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001350 return;
1351 }
1352
Justin Bognerbc89b182014-10-20 21:20:27 +00001353 Diag(clang::diag::note_drv_command_failed_diag_msg)
1354 << "\n********************\n\n"
1355 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
1356 "Preprocessed source(s) and associated run script(s) are located at:";
Justin Bognerbc89b182014-10-20 21:20:27 +00001357
Justin Bogner659ecc32014-10-20 22:47:23 +00001358 SmallString<128> VFS;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001359 SmallString<128> ReproCrashFilename;
Justin Bogner659ecc32014-10-20 22:47:23 +00001360 for (const char *TempFile : TempFiles) {
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001361 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
Alex Lorenz045c5142018-04-07 00:03:27 +00001362 if (Report)
1363 Report->TemporaryFiles.push_back(TempFile);
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001364 if (ReproCrashFilename.empty()) {
1365 ReproCrashFilename = TempFile;
1366 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
1367 }
Justin Bogner659ecc32014-10-20 22:47:23 +00001368 if (StringRef(TempFile).endswith(".cache")) {
1369 // In some cases (modules) we'll dump extra data to help with reproducing
1370 // the crash into a directory next to the output.
1371 VFS = llvm::sys::path::filename(TempFile);
1372 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
1373 }
1374 }
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001375
1376 // Assume associated files are based off of the first temporary file.
Justin Bogner25645152014-10-21 17:24:44 +00001377 CrashReportInfo CrashInfo(TempFiles[0], VFS);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001378
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001379 llvm::SmallString<128> Script(CrashInfo.Filename);
1380 llvm::sys::path::replace_extension(Script, "sh");
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001381 std::error_code EC;
Zachary Turner1f67a3c2018-06-07 19:58:58 +00001382 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::CD_CreateNew);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001383 if (EC) {
1384 Diag(clang::diag::note_drv_command_failed_diag_msg)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001385 << "Error generating run script: " << Script << " " << EC.message();
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001386 } else {
Justin Bogner42220ed2015-03-12 00:14:35 +00001387 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
Justin Bognered9cbe02015-07-09 06:58:31 +00001388 << "# Driver args: ";
1389 printArgList(ScriptOS, C.getInputArgs());
1390 ScriptOS << "# Original command: ";
Justin Bogner42220ed2015-03-12 00:14:35 +00001391 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
Justin Bogner33bdbc62014-10-21 18:03:08 +00001392 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
Alex Lorenz045c5142018-04-07 00:03:27 +00001393 if (!AdditionalInformation.empty())
1394 ScriptOS << "\n# Additional information: " << AdditionalInformation
1395 << "\n";
1396 if (Report)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001397 Report->TemporaryFiles.push_back(Script.str());
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001398 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
Justin Bognerbc89b182014-10-20 21:20:27 +00001399 }
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001400
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001401 // On darwin, provide information about the .crash diagnostic report.
1402 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
1403 SmallString<128> CrashDiagDir;
1404 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
1405 Diag(clang::diag::note_drv_command_failed_diag_msg)
1406 << ReproCrashFilename.str();
1407 } else { // Suggest a directory for the user to look for .crash files.
1408 llvm::sys::path::append(CrashDiagDir, Name);
1409 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
1410 Diag(clang::diag::note_drv_command_failed_diag_msg)
1411 << "Crash backtrace is located in";
1412 Diag(clang::diag::note_drv_command_failed_diag_msg)
1413 << CrashDiagDir.str();
1414 Diag(clang::diag::note_drv_command_failed_diag_msg)
1415 << "(choose the .crash file that corresponds to your crash)";
1416 }
1417 }
1418
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001419 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1420 options::OPT_frewrite_map_file_EQ))
1421 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1422
Justin Bognerbc89b182014-10-20 21:20:27 +00001423 Diag(clang::diag::note_drv_command_failed_diag_msg)
1424 << "\n\n********************";
Chad Rosierbe10f982011-08-02 17:58:04 +00001425}
1426
Justin Bogner0cd92482015-07-02 22:52:08 +00001427void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
Simon Atanasyan27c0f202019-04-02 18:03:15 +00001428 // Since commandLineFitsWithinSystemLimits() may underestimate system's
1429 // capacity if the tool does not support response files, there is a chance/
1430 // that things will just work without a response file, so we silently just
1431 // skip it.
Justin Bogner0cd92482015-07-02 22:52:08 +00001432 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
Simon Atanasyan27c0f202019-04-02 18:03:15 +00001433 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(),
1434 Cmd.getArguments()))
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001435 return;
1436
1437 std::string TmpName = GetTemporaryPath("response", "txt");
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00001438 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001439}
1440
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001441int Driver::ExecuteCompilation(
1442 Compilation &C,
1443 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001444 // Just print if -### was present.
1445 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Hans Wennborgb212b342013-09-12 18:23:34 +00001446 C.getJobs().Print(llvm::errs(), "\n", true);
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001447 return 0;
1448 }
1449
1450 // If there were errors building the compilation, quit now.
Chad Rosierbe10f982011-08-02 17:58:04 +00001451 if (Diags.hasErrorOccurred())
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001452 return 1;
1453
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001454 // Set up response file names for each command, if necessary
Justin Bogner0cd92482015-07-02 22:52:08 +00001455 for (auto &Job : C.getJobs())
1456 setUpResponseFiles(C, Job);
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001457
Justin Bogner0cd92482015-07-02 22:52:08 +00001458 C.ExecuteJobs(C.getJobs(), FailingCommands);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001459
Daniel Dunbar07494792010-05-22 00:37:20 +00001460 // If the command succeeded, we are done.
Chad Rosierdd60e092013-01-29 20:15:05 +00001461 if (FailingCommands.empty())
1462 return 0;
Daniel Dunbar07494792010-05-22 00:37:20 +00001463
Chad Rosierdd60e092013-01-29 20:15:05 +00001464 // Otherwise, remove result files and print extra information about abnormal
1465 // failures.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001466 int Res = 0;
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001467 for (const auto &CmdPair : FailingCommands) {
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001468 int CommandRes = CmdPair.first;
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001469 const Command *FailingCommand = CmdPair.second;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001470
Chad Rosierdd60e092013-01-29 20:15:05 +00001471 // Remove result files if we're not saving temps.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001472 if (!isSaveTempsEnabled()) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001473 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1474 C.CleanupFileMap(C.getResultFiles(), JA, true);
1475
1476 // Failure result files are valid unless we crashed.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001477 if (CommandRes < 0)
Chad Rosierdd60e092013-01-29 20:15:05 +00001478 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1479 }
1480
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001481#if LLVM_ON_UNIX
1482 // llvm/lib/Support/Unix/Signals.inc will exit with a special return code
1483 // for SIGPIPE. Do not print diagnostics for this case.
1484 if (CommandRes == EX_IOERR) {
1485 Res = CommandRes;
1486 continue;
1487 }
1488#endif
1489
Chad Rosierdd60e092013-01-29 20:15:05 +00001490 // Print extra information about abnormal failures, if possible.
1491 //
1492 // This is ad-hoc, but we don't want to be excessively noisy. If the result
Justin Bogner5aaf2e72014-06-26 20:59:36 +00001493 // status was 1, assume the command failed normally. In particular, if it
Chad Rosierdd60e092013-01-29 20:15:05 +00001494 // was the compiler then assume it gave a reasonable error code. Failures
1495 // in other tools are less common, and they generally have worse
1496 // diagnostics, so always print the diagnostic there.
1497 const Tool &FailingTool = FailingCommand->getCreator();
1498
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001499 if (!FailingCommand->getCreator().hasGoodDiagnostics() || CommandRes != 1) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001500 // FIXME: See FIXME above regarding result code interpretation.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001501 if (CommandRes < 0)
Chad Rosierdd60e092013-01-29 20:15:05 +00001502 Diag(clang::diag::err_drv_command_signalled)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001503 << FailingTool.getShortName();
Chad Rosierdd60e092013-01-29 20:15:05 +00001504 else
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001505 Diag(clang::diag::err_drv_command_failed)
1506 << FailingTool.getShortName() << CommandRes;
Chad Rosierdd60e092013-01-29 20:15:05 +00001507 }
Peter Collingbourne119cfaa2011-11-21 00:01:05 +00001508 }
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001509 return Res;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001510}
1511
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001512void Driver::PrintHelp(bool ShowHidden) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001513 unsigned IncludedFlagsBitmask;
1514 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001515 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Hans Wennborg797004d2018-11-08 11:27:04 +00001516 getIncludeExcludeOptionFlagMasks(IsCLMode());
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001517
1518 ExcludedFlagsBitmask |= options::NoDriverOption;
1519 if (!ShowHidden)
1520 ExcludedFlagsBitmask |= HelpHidden;
1521
Fangrui Songd0028232018-10-10 00:15:33 +00001522 std::string Usage = llvm::formatv("{0} [options] file...", Name).str();
1523 getOpts().PrintHelp(llvm::outs(), Usage.c_str(), DriverTitle.c_str(),
George Rimar5dbfa4e2017-07-26 09:10:17 +00001524 IncludedFlagsBitmask, ExcludedFlagsBitmask,
1525 /*ShowAllAliases=*/false);
Daniel Dunbar7c925282009-03-31 21:38:17 +00001526}
1527
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001528void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001529 // FIXME: The following handlers should use a callback mechanism, we don't
1530 // know what the client would like to do.
Ted Kremenek4c0df3d2010-01-23 02:11:34 +00001531 OS << getClangFullVersion() << '\n';
Daniel Dunbarb10248802009-03-26 16:09:13 +00001532 const ToolChain &TC = C.getDefaultToolChain();
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001533 OS << "Target: " << TC.getTripleString() << '\n';
Daniel Dunbar10978e42009-06-16 23:32:58 +00001534
1535 // Print the threading model.
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001536 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1537 // Don't print if the ToolChain would have barfed on it already
1538 if (TC.isThreadModelSupported(A->getValue()))
1539 OS << "Thread model: " << A->getValue();
1540 } else
Thomas Livelyf3b4f992019-02-28 18:39:08 +00001541 OS << "Thread model: " << TC.getThreadModel();
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001542 OS << '\n';
Chandler Carruth9ade6a92015-08-05 17:07:33 +00001543
1544 // Print out the install directory.
1545 OS << "InstalledDir: " << InstalledDir << '\n';
Serge Pavlov208ac652018-01-01 13:27:01 +00001546
1547 // If configuration file was used, print its path.
1548 if (!ConfigFile.empty())
1549 OS << "Configuration file: " << ConfigFile << '\n';
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001550}
1551
Chris Lattner86ed5b02010-05-05 05:53:24 +00001552/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1553/// option.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001554static void PrintDiagnosticCategories(raw_ostream &OS) {
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001555 // Skip the empty category.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001556 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1557 ++i)
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001558 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
Chris Lattner86ed5b02010-05-05 05:53:24 +00001559}
1560
Yuka Takahashi41789e42018-03-05 08:54:20 +00001561void Driver::HandleAutocompletions(StringRef PassedFlags) const {
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001562 if (PassedFlags == "")
1563 return;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001564 // Print out all options that start with a given argument. This is used for
1565 // shell autocompletion.
1566 std::vector<std::string> SuggestedCompletions;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001567 std::vector<std::string> Flags;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001568
1569 unsigned short DisableFlags =
1570 options::NoDriverOption | options::Unsupported | options::Ignored;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001571
Yuka Takahashi46106f52018-10-24 12:43:25 +00001572 // Distinguish "--autocomplete=-someflag" and "--autocomplete=-someflag,"
1573 // because the latter indicates that the user put space before pushing tab
1574 // which should end up in a file completion.
1575 const bool HasSpace = PassedFlags.endswith(",");
1576
Yuka Takahashi41789e42018-03-05 08:54:20 +00001577 // Parse PassedFlags by "," as all the command-line flags are passed to this
1578 // function separated by ","
1579 StringRef TargetFlags = PassedFlags;
1580 while (TargetFlags != "") {
1581 StringRef CurFlag;
1582 std::tie(CurFlag, TargetFlags) = TargetFlags.split(",");
1583 Flags.push_back(std::string(CurFlag));
Yuka Takahashi1a895202017-08-29 17:46:46 +00001584 }
1585
Yuka Takahashi41789e42018-03-05 08:54:20 +00001586 // We want to show cc1-only options only when clang is invoked with -cc1 or
1587 // -Xclang.
Fangrui Song9ac13a12019-02-10 05:54:57 +00001588 if (llvm::is_contained(Flags, "-Xclang") || llvm::is_contained(Flags, "-cc1"))
Yuka Takahashi41789e42018-03-05 08:54:20 +00001589 DisableFlags &= ~options::NoDriverOption;
1590
1591 StringRef Cur;
1592 Cur = Flags.at(Flags.size() - 1);
1593 StringRef Prev;
1594 if (Flags.size() >= 2) {
1595 Prev = Flags.at(Flags.size() - 2);
1596 SuggestedCompletions = Opts->suggestValueCompletions(Prev, Cur);
1597 }
1598
1599 if (SuggestedCompletions.empty())
1600 SuggestedCompletions = Opts->suggestValueCompletions(Cur, "");
1601
Yuka Takahashi46106f52018-10-24 12:43:25 +00001602 // If Flags were empty, it means the user typed `clang [tab]` where we should
1603 // list all possible flags. If there was no value completion and the user
1604 // pressed tab after a space, we should fall back to a file completion.
1605 // We're printing a newline to be consistent with what we print at the end of
1606 // this function.
1607 if (SuggestedCompletions.empty() && HasSpace && !Flags.empty()) {
1608 llvm::outs() << '\n';
1609 return;
1610 }
1611
Yuka Takahashidf9c7e32018-10-24 08:24:16 +00001612 // When flag ends with '=' and there was no value completion, return empty
1613 // string and fall back to the file autocompletion.
1614 if (SuggestedCompletions.empty() && !Cur.endswith("=")) {
Yuka Takahashi1a895202017-08-29 17:46:46 +00001615 // If the flag is in the form of "--autocomplete=-foo",
1616 // we were requested to print out all option names that start with "-foo".
1617 // For example, "--autocomplete=-fsyn" is expanded to "-fsyntax-only".
Yuka Takahashi41789e42018-03-05 08:54:20 +00001618 SuggestedCompletions = Opts->findByPrefix(Cur, DisableFlags);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001619
1620 // We have to query the -W flags manually as they're not in the OptTable.
1621 // TODO: Find a good way to add them to OptTable instead and them remove
1622 // this code.
1623 for (StringRef S : DiagnosticIDs::getDiagnosticFlags())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001624 if (S.startswith(Cur))
Yuka Takahashi1a895202017-08-29 17:46:46 +00001625 SuggestedCompletions.push_back(S);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001626 }
1627
1628 // Sort the autocomplete candidates so that shells print them out in a
1629 // deterministic order. We could sort in any way, but we chose
1630 // case-insensitive sorting for consistency with the -help option
1631 // which prints out options in the case-insensitive alphabetical order.
Fangrui Song55fab262018-09-26 22:16:28 +00001632 llvm::sort(SuggestedCompletions, [](StringRef A, StringRef B) {
1633 if (int X = A.compare_lower(B))
1634 return X < 0;
1635 return A.compare(B) > 0;
1636 });
Yuka Takahashi1a895202017-08-29 17:46:46 +00001637
1638 llvm::outs() << llvm::join(SuggestedCompletions, "\n") << '\n';
1639}
1640
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001641bool Driver::HandleImmediateArgs(const Compilation &C) {
Daniel Dunbar18974bd2010-06-11 22:00:19 +00001642 // The order these options are handled in gcc is all over the place, but we
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001643 // don't expect inconsistencies w.r.t. that to matter in practice.
Daniel Dunbar7c925282009-03-31 21:38:17 +00001644
Daniel Dunbar1b09e042010-09-17 02:47:28 +00001645 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1646 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1647 return false;
1648 }
1649
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001650 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
Daniel Dunbare26e5002011-01-12 00:43:47 +00001651 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1652 // return an answer which matches our definition of __VERSION__.
Sylvestre Ledrua199a9b2019-03-25 18:06:20 +00001653 llvm::outs() << CLANG_VERSION_STRING << "\n";
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001654 return false;
1655 }
Daniel Dunbarfb3d7472010-06-14 21:23:12 +00001656
Chris Lattner86ed5b02010-05-05 05:53:24 +00001657 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1658 PrintDiagnosticCategories(llvm::outs());
1659 return false;
1660 }
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001661
James Molloya3c85b82012-05-01 14:57:16 +00001662 if (C.getArgs().hasArg(options::OPT_help) ||
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001663 C.getArgs().hasArg(options::OPT__help_hidden)) {
1664 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
Daniel Dunbar7c925282009-03-31 21:38:17 +00001665 return false;
1666 }
1667
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001668 if (C.getArgs().hasArg(options::OPT__version)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001669 // Follow gcc behavior and use stdout for --version and stderr for -v.
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001670 PrintVersion(C, llvm::outs());
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001671 return false;
1672 }
1673
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001674 if (C.getArgs().hasArg(options::OPT_v) ||
Ziang Wanaf857b92019-06-14 21:42:21 +00001675 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH) ||
1676 C.getArgs().hasArg(options::OPT__print_supported_cpus)) {
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001677 PrintVersion(C, llvm::errs());
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001678 SuppressMissingInputWarning = true;
1679 }
1680
Serge Pavlov208ac652018-01-01 13:27:01 +00001681 if (C.getArgs().hasArg(options::OPT_v)) {
1682 if (!SystemConfigDir.empty())
1683 llvm::errs() << "System configuration file directory: "
1684 << SystemConfigDir << "\n";
1685 if (!UserConfigDir.empty())
1686 llvm::errs() << "User configuration file directory: "
1687 << UserConfigDir << "\n";
1688 }
1689
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001690 const ToolChain &TC = C.getDefaultToolChain();
Chandler Carruth0ae39aa2013-07-30 17:57:09 +00001691
1692 if (C.getArgs().hasArg(options::OPT_v))
1693 TC.printVerboseInfo(llvm::errs());
1694
Meador Inge51208a32017-04-04 21:46:50 +00001695 if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
Meador Ingea9113952017-04-05 22:27:20 +00001696 llvm::outs() << ResourceDir << '\n';
Meador Inge51208a32017-04-04 21:46:50 +00001697 return false;
1698 }
1699
Daniel Dunbard972e222009-03-20 04:37:21 +00001700 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1701 llvm::outs() << "programs: =";
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001702 bool separator = false;
1703 for (const std::string &Path : TC.getProgramPaths()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001704 if (separator)
Martin Storsjoceb71e82019-04-25 20:03:20 +00001705 llvm::outs() << llvm::sys::EnvPathSeparator;
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001706 llvm::outs() << Path;
1707 separator = true;
Daniel Dunbard972e222009-03-20 04:37:21 +00001708 }
1709 llvm::outs() << "\n";
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001710 llvm::outs() << "libraries: =" << ResourceDir;
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001711
Sebastian Pop980920a2012-04-16 04:16:43 +00001712 StringRef sysroot = C.getSysRoot();
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001713
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001714 for (const std::string &Path : TC.getFilePaths()) {
1715 // Always print a separator. ResourceDir was the first item shown.
Martin Storsjoceb71e82019-04-25 20:03:20 +00001716 llvm::outs() << llvm::sys::EnvPathSeparator;
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001717 // Interpretation of leading '=' is needed only for NetBSD.
1718 if (Path[0] == '=')
Douglas Katzman26eabf62015-06-24 15:10:30 +00001719 llvm::outs() << sysroot << Path.substr(1);
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001720 else
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001721 llvm::outs() << Path;
Daniel Dunbard972e222009-03-20 04:37:21 +00001722 }
1723 llvm::outs() << "\n";
Daniel Dunbar7c925282009-03-31 21:38:17 +00001724 return false;
Daniel Dunbard972e222009-03-20 04:37:21 +00001725 }
1726
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001727 // FIXME: The following handlers should use a callback mechanism, we don't
1728 // know what the client would like to do.
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001729 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001730 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001731 return false;
1732 }
1733
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001734 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
Saleem Abdulrasoole5f3cf82018-05-01 18:40:42 +00001735 StringRef ProgName = A->getValue();
1736
1737 // Null program name cannot have a path.
1738 if (! ProgName.empty())
1739 llvm::outs() << GetProgramPath(ProgName, TC);
1740
1741 llvm::outs() << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001742 return false;
1743 }
1744
Yuka Takahashic8068db2017-05-23 18:39:08 +00001745 if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
Yuka Takahashiba5d4af2017-06-20 16:31:31 +00001746 StringRef PassedFlags = A->getValue();
Yuka Takahashi41789e42018-03-05 08:54:20 +00001747 HandleAutocompletions(PassedFlags);
Yuka Takahashic8068db2017-05-23 18:39:08 +00001748 return false;
1749 }
1750
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001751 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
Michal Gorny7cfe4802016-10-10 12:23:40 +00001752 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
Leo Li23bb21c2017-08-24 01:51:51 +00001753 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1754 RegisterEffectiveTriple TripleRAII(TC, Triple);
Michal Gorny7cfe4802016-10-10 12:23:40 +00001755 switch (RLT) {
1756 case ToolChain::RLT_CompilerRT:
1757 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1758 break;
1759 case ToolChain::RLT_Libgcc:
1760 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1761 break;
1762 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001763 return false;
1764 }
1765
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001766 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001767 for (const Multilib &Multilib : TC.getMultilibs())
1768 llvm::outs() << Multilib << "\n";
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001769 return false;
1770 }
1771
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001772 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
Christian Bruel6ccc4a72018-09-06 14:03:44 +00001773 const Multilib &Multilib = TC.getMultilib();
1774 if (Multilib.gccSuffix().empty())
1775 llvm::outs() << ".\n";
1776 else {
1777 StringRef Suffix(Multilib.gccSuffix());
1778 assert(Suffix.front() == '/');
1779 llvm::outs() << Suffix.substr(1) << "\n";
Jonathan Roelofs3fa96d82014-02-12 01:36:51 +00001780 }
Jonathan Roelofs0e7ec602014-02-12 01:29:25 +00001781 return false;
1782 }
Petr Hosekbc86a992018-08-16 00:22:03 +00001783
1784 if (C.getArgs().hasArg(options::OPT_print_target_triple)) {
1785 llvm::outs() << TC.getTripleString() << "\n";
1786 return false;
1787 }
1788
1789 if (C.getArgs().hasArg(options::OPT_print_effective_triple)) {
1790 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1791 llvm::outs() << Triple.getTriple() << "\n";
1792 return false;
1793 }
1794
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001795 return true;
1796}
1797
Douglas Katzmanfd528672015-06-11 15:05:22 +00001798// Display an action graph human-readably. Action A is the "sink" node
1799// and latest-occuring action. Traversal is in pre-order, visiting the
1800// inputs to each action before printing the action itself.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001801static unsigned PrintActions1(const Compilation &C, Action *A,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001802 std::map<Action *, unsigned> &Ids) {
Douglas Katzmanfd528672015-06-11 15:05:22 +00001803 if (Ids.count(A)) // A was already visited.
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001804 return Ids[A];
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001805
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001806 std::string str;
1807 llvm::raw_string_ostream os(str);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001808
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001809 os << Action::getClassName(A->getKind()) << ", ";
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001810 if (InputAction *IA = dyn_cast<InputAction>(A)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001811 os << "\"" << IA->getInputArg().getValue() << "\"";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001812 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001813 os << '"' << BIA->getArchName() << '"' << ", {"
Nico Weber5a459f82016-02-23 19:30:43 +00001814 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
Samuel Antaod06239d2016-07-15 23:13:27 +00001815 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1816 bool IsFirst = true;
1817 OA->doOnEachDependence(
1818 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1819 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1820 // sm_35 this will generate:
1821 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1822 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1823 if (!IsFirst)
1824 os << ", ";
1825 os << '"';
1826 if (TC)
1827 os << A->getOffloadingKindPrefix();
1828 else
1829 os << "host";
1830 os << " (";
1831 os << TC->getTriple().normalize();
1832
1833 if (BoundArch)
1834 os << ":" << BoundArch;
1835 os << ")";
1836 os << '"';
1837 os << " {" << PrintActions1(C, A, Ids) << "}";
1838 IsFirst = false;
1839 });
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001840 } else {
Samuel Antaod06239d2016-07-15 23:13:27 +00001841 const ActionList *AL = &A->getInputs();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00001842
Artem Belevich23256752015-09-22 17:23:09 +00001843 if (AL->size()) {
1844 const char *Prefix = "{";
1845 for (Action *PreRequisite : *AL) {
1846 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1847 Prefix = ", ";
1848 }
1849 os << "}";
1850 } else
1851 os << "{}";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001852 }
1853
Samuel Antaod06239d2016-07-15 23:13:27 +00001854 // Append offload info for all options other than the offloading action
1855 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1856 std::string offload_str;
1857 llvm::raw_string_ostream offload_os(offload_str);
1858 if (!isa<OffloadAction>(A)) {
1859 auto S = A->getOffloadingKindPrefix();
1860 if (!S.empty()) {
1861 offload_os << ", (" << S;
1862 if (A->getOffloadingArch())
1863 offload_os << ", " << A->getOffloadingArch();
1864 offload_os << ")";
1865 }
1866 }
1867
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001868 unsigned Id = Ids.size();
1869 Ids[A] = Id;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001870 llvm::errs() << Id << ": " << os.str() << ", "
Samuel Antaod06239d2016-07-15 23:13:27 +00001871 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001872
1873 return Id;
1874}
1875
Douglas Katzmanfd528672015-06-11 15:05:22 +00001876// Print the action graphs in a compilation C.
1877// For example "clang -c file1.c file2.c" is composed of two subgraphs.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001878void Driver::PrintActions(const Compilation &C) const {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001879 std::map<Action *, unsigned> Ids;
1880 for (Action *A : C.getActions())
1881 PrintActions1(C, A, Ids);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001882}
1883
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001884/// Check whether the given input tree contains any compilation or
Joerg Sonnenberger5fe4a7d2011-05-06 14:05:11 +00001885/// assembly actions.
1886static bool ContainsCompileOrAssembleAction(const Action *A) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001887 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
Bob Wilson23a55f12014-12-21 07:00:00 +00001888 isa<AssembleJobAction>(A))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001889 return true;
1890
Nico Weber5a459f82016-02-23 19:30:43 +00001891 for (const Action *Input : A->inputs())
Nico Weberfb80f962015-09-19 21:36:51 +00001892 if (ContainsCompileOrAssembleAction(Input))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001893 return true;
1894
1895 return false;
1896}
1897
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001898void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1899 const InputList &BAInputs) const {
1900 DerivedArgList &Args = C.getArgs();
1901 ActionList &Actions = C.getActions();
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001902 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1903 // Collect the list of architectures. Duplicates are allowed, but should only
1904 // be handled once (in the order seen).
Daniel Dunbare5dc4822009-03-13 20:33:35 +00001905 llvm::StringSet<> ArchNames;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001906 SmallVector<const char *, 4> Archs;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001907 for (Arg *A : Args) {
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001908 if (A->getOption().matches(options::OPT_arch)) {
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001909 // Validate the option here; we don't save the type here because its
1910 // particular spelling may participate in other driver choices.
1911 llvm::Triple::ArchType Arch =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001912 tools::darwin::getArchTypeForMachOArchName(A->getValue());
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001913 if (Arch == llvm::Triple::UnknownArch) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001914 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001915 continue;
1916 }
1917
Daniel Dunbar2da02722009-03-19 07:55:12 +00001918 A->claim();
David Blaikie61b86d42014-11-19 02:56:13 +00001919 if (ArchNames.insert(A->getValue()).second)
Richard Smithbd55daf2012-11-01 04:30:05 +00001920 Archs.push_back(A->getValue());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001921 }
1922 }
1923
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001924 // When there is no explicit arch for this platform, make sure we still bind
1925 // the architecture (to the default) so that -Xarch_ is handled correctly.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001926 if (!Archs.size())
Daniel Dunbarc3bd9f52012-11-08 03:38:26 +00001927 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001928
Daniel Dunbarf479c122009-03-12 18:40:18 +00001929 ActionList SingleActions;
Justin Lebar0f3474c2016-02-11 02:00:50 +00001930 BuildActions(C, Args, BAInputs, SingleActions);
Daniel Dunbarf479c122009-03-12 18:40:18 +00001931
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001932 // Add in arch bindings for every top level action, as well as lipo and
1933 // dsymutil steps if needed.
Nico Weberfb80f962015-09-19 21:36:51 +00001934 for (Action* Act : SingleActions) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001935 // Make sure we can lipo this kind of output. If not (and it is an actual
1936 // output) then we disallow, since we can't create an output file with the
1937 // right name without overwriting it. We could remove this oddity by just
1938 // changing the output names to include the arch, which would also fix
Daniel Dunbarf479c122009-03-12 18:40:18 +00001939 // -save-temps. Compatibility wins for now.
1940
Daniel Dunbare2ca3bd2009-03-13 17:46:02 +00001941 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
Daniel Dunbarf479c122009-03-12 18:40:18 +00001942 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001943 << types::getTypeName(Act->getType());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001944
1945 ActionList Inputs;
Justin Lebar41094612016-01-11 23:07:27 +00001946 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1947 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001948
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001949 // Lipo if necessary, we do it this way because we need to set the arch flag
1950 // so that -Xarch_ gets overwritten.
Daniel Dunbarf479c122009-03-12 18:40:18 +00001951 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1952 Actions.append(Inputs.begin(), Inputs.end());
1953 else
Justin Lebar41094612016-01-11 23:07:27 +00001954 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001955
Eric Christopher65c05fa2012-02-06 19:43:51 +00001956 // Handle debug info queries.
1957 Arg *A = Args.getLastArg(options::OPT_g_Group);
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001958 if (A && !A->getOption().matches(options::OPT_g0) &&
1959 !A->getOption().matches(options::OPT_gstabs) &&
1960 ContainsCompileOrAssembleAction(Actions.back())) {
Chad Rosier62135492012-07-09 17:31:28 +00001961
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001962 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1963 // have a compile input. We need to run 'dsymutil' ourselves in such cases
Eric Christopher776c26f2013-01-28 17:39:03 +00001964 // because the debug info will refer to a temporary object file which
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001965 // will be removed at the end of the compilation process.
1966 if (Act->getType() == types::TY_Image) {
1967 ActionList Inputs;
1968 Inputs.push_back(Actions.back());
1969 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001970 Actions.push_back(
1971 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001972 }
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001973
Ben Langmuir9b9a8d32014-02-06 18:53:25 +00001974 // Verify the debug info output.
Alp Tokere9d2bfc2014-01-17 02:06:23 +00001975 if (Args.hasArg(options::OPT_verify_debug_info)) {
Justin Lebar41094612016-01-11 23:07:27 +00001976 Action* LastAction = Actions.back();
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001977 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001978 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1979 LastAction, types::TY_Nothing));
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001980 }
1981 }
Daniel Dunbarf479c122009-03-12 18:40:18 +00001982 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001983}
1984
Nico Weber9b2830b2019-05-23 17:58:33 +00001985bool Driver::DiagnoseInputExistence(const DerivedArgList &Args, StringRef Value,
1986 types::ID Ty, bool TypoCorrect) const {
1987 if (!getCheckInputsExist())
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001988 return true;
1989
1990 // stdin always exists.
1991 if (Value == "-")
1992 return true;
1993
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001994 if (getVFS().exists(Value))
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001995 return true;
1996
Nico Weber9b2830b2019-05-23 17:58:33 +00001997 if (IsCLMode()) {
Michael J. Spencer7e48b402019-05-28 22:21:47 +00001998 if (!llvm::sys::path::is_absolute(Twine(Value)) &&
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001999 llvm::sys::Process::FindInEnvPath("LIB", Value))
2000 return true;
2001
2002 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
2003 // Arguments to the /link flag might cause the linker to search for object
2004 // and library files in paths we don't know about. Don't error in such
2005 // cases.
2006 return true;
2007 }
2008 }
Hans Wennborg23d26a32014-06-18 17:21:50 +00002009
Nico Weber9b2830b2019-05-23 17:58:33 +00002010 if (TypoCorrect) {
2011 // Check if the filename is a typo for an option flag. OptTable thinks
2012 // that all args that are not known options and that start with / are
2013 // filenames, but e.g. `/diagnostic:caret` is more likely a typo for
2014 // the option `/diagnostics:caret` than a reference to a file in the root
2015 // directory.
2016 unsigned IncludedFlagsBitmask;
2017 unsigned ExcludedFlagsBitmask;
2018 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
2019 getIncludeExcludeOptionFlagMasks(IsCLMode());
2020 std::string Nearest;
2021 if (getOpts().findNearest(Value, Nearest, IncludedFlagsBitmask,
2022 ExcludedFlagsBitmask) <= 1) {
2023 Diag(clang::diag::err_drv_no_such_file_with_suggestion)
Michael J. Spencer7e48b402019-05-28 22:21:47 +00002024 << Value << Nearest;
Nico Weber9b2830b2019-05-23 17:58:33 +00002025 return false;
2026 }
2027 }
2028
Michael J. Spencer7e48b402019-05-28 22:21:47 +00002029 Diag(clang::diag::err_drv_no_such_file) << Value;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002030 return false;
2031}
2032
Chad Rosierecdede82011-08-12 22:08:57 +00002033// Construct a the list of inputs and their types.
Hans Wennborg55362852014-05-02 22:55:30 +00002034void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
Chad Rosierecdede82011-08-12 22:08:57 +00002035 InputList &Inputs) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002036 // Track the current user specified (-x) input. We also explicitly track the
2037 // argument used to set the type; we only want to claim the type when we
2038 // actually use it, so we warn about unused -x arguments.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002039 types::ID InputType = types::TY_Nothing;
Craig Topper92fc2df2014-05-17 16:56:41 +00002040 Arg *InputTypeArg = nullptr;
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002041
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002042 // The last /TC or /TP option sets the input type to C or C++ globally.
Ehsan Akhgaric249abb2014-09-12 21:44:24 +00002043 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
2044 options::OPT__SLASH_TP)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002045 InputTypeArg = TCTP;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002046 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002047 ? types::TY_C
2048 : types::TY_CXX;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002049
Richard Smith0aef3052017-02-18 01:14:43 +00002050 Arg *Previous = nullptr;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002051 bool ShowNote = false;
Simon Atanasyan27c0f202019-04-02 18:03:15 +00002052 for (Arg *A :
2053 Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
Richard Smith0aef3052017-02-18 01:14:43 +00002054 if (Previous) {
2055 Diag(clang::diag::warn_drv_overriding_flag_option)
2056 << Previous->getSpelling() << A->getSpelling();
2057 ShowNote = true;
2058 }
2059 Previous = A;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002060 }
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002061 if (ShowNote)
2062 Diag(clang::diag::note_drv_t_option_is_global);
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002063
2064 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
2065 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
2066 }
2067
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00002068 for (Arg *A : Args) {
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00002069 if (A->getOption().getKind() == Option::InputClass) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002070 const char *Value = A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002071 types::ID Ty = types::TY_INVALID;
2072
2073 // Infer the input type if necessary.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002074 if (InputType == types::TY_Nothing) {
2075 // If there was an explicit arg for this, claim it.
2076 if (InputTypeArg)
2077 InputTypeArg->claim();
2078
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002079 // stdin must be handled specially.
2080 if (memcmp(Value, "-", 2) == 0) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002081 // If running with -E, treat as a C input (this changes the builtin
2082 // macros, for example). This may be overridden by -ObjC below.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002083 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002084 // Otherwise emit an error but still use a valid type to avoid
2085 // spurious errors (e.g., no inputs).
Hans Wennborg70850d82013-07-18 20:29:38 +00002086 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
Hans Wennborgcfdd8b52014-01-29 01:04:40 +00002087 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
2088 : clang::diag::err_drv_unknown_stdin_type);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002089 Ty = types::TY_C;
2090 } else {
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002091 // Otherwise lookup by extension.
Reid Klecknera643e642018-12-26 21:04:08 +00002092 // Fallback is C if invoked as C preprocessor, C++ if invoked with
2093 // clang-cl /E, or Object otherwise.
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002094 // We use a host hook here because Darwin at least has its own
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002095 // idea of what .s is.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002096 if (const char *Ext = strrchr(Value, '.'))
Daniel Dunbarcc7df6c2010-08-02 05:43:56 +00002097 Ty = TC.LookupTypeForExtension(Ext + 1);
Daniel Dunbarea9f0322009-03-20 23:39:23 +00002098
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002099 if (Ty == types::TY_INVALID) {
Hans Wennborg70850d82013-07-18 20:29:38 +00002100 if (CCCIsCPP())
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002101 Ty = types::TY_C;
Reid Klecknera643e642018-12-26 21:04:08 +00002102 else if (IsCLMode() && Args.hasArgNoClaim(options::OPT_E))
2103 Ty = types::TY_CXX;
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002104 else
2105 Ty = types::TY_Object;
2106 }
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002107
2108 // If the driver is invoked as C++ compiler (like clang++ or c++) it
2109 // should autodetect some input files as C++ for g++ compatibility.
Hans Wennborg70850d82013-07-18 20:29:38 +00002110 if (CCCIsCXX()) {
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002111 types::ID OldTy = Ty;
2112 Ty = types::lookupCXXTypeForCType(Ty);
2113
2114 if (Ty != OldTy)
2115 Diag(clang::diag::warn_drv_treating_input_as_cxx)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002116 << getTypeName(OldTy) << getTypeName(Ty);
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002117 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002118 }
2119
Daniel Dunbar82b22102009-05-18 21:47:54 +00002120 // -ObjC and -ObjC++ override the default language, but only for "source
2121 // files". We just treat everything that isn't a linker input as a
2122 // source file.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002123 //
Daniel Dunbar82b22102009-05-18 21:47:54 +00002124 // FIXME: Clean this up if we move the phase sequence into the type.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002125 if (Ty != types::TY_Object) {
2126 if (Args.hasArg(options::OPT_ObjC))
2127 Ty = types::TY_ObjC;
2128 else if (Args.hasArg(options::OPT_ObjCXX))
2129 Ty = types::TY_ObjCXX;
2130 }
2131 } else {
2132 assert(InputTypeArg && "InputType set w/o InputTypeArg");
Ehsan Akhgari7e954ea2014-09-12 18:15:10 +00002133 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
2134 // If emulating cl.exe, make sure that /TC and /TP don't affect input
2135 // object files.
2136 const char *Ext = strrchr(Value, '.');
2137 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
2138 Ty = types::TY_Object;
2139 }
2140 if (Ty == types::TY_INVALID) {
2141 Ty = InputType;
2142 InputTypeArg->claim();
2143 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002144 }
2145
Nico Weber9b2830b2019-05-23 17:58:33 +00002146 if (DiagnoseInputExistence(Args, Value, Ty, /*TypoCorrect=*/true))
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002147 Inputs.push_back(std::make_pair(Ty, A));
2148
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002149 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
2150 StringRef Value = A->getValue();
Nico Weber9b2830b2019-05-23 17:58:33 +00002151 if (DiagnoseInputExistence(Args, Value, types::TY_C,
2152 /*TypoCorrect=*/false)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002153 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002154 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
2155 }
2156 A->claim();
2157 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
2158 StringRef Value = A->getValue();
Nico Weber9b2830b2019-05-23 17:58:33 +00002159 if (DiagnoseInputExistence(Args, Value, types::TY_CXX,
2160 /*TypoCorrect=*/false)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002161 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002162 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
2163 }
2164 A->claim();
Michael J. Spencer66e2b202012-10-19 22:37:06 +00002165 } else if (A->getOption().hasFlag(options::LinkerInput)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002166 // Just treat as object type, we could make a special type for this if
2167 // necessary.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002168 Inputs.push_back(std::make_pair(types::TY_Object, A));
2169
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00002170 } else if (A->getOption().matches(options::OPT_x)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002171 InputTypeArg = A;
Richard Smithbd55daf2012-11-01 04:30:05 +00002172 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
Chad Rosier706c2352012-04-07 00:01:31 +00002173 A->claim();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002174
2175 // Follow gcc behavior and treat as linker input for invalid -x
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002176 // options. Its not clear why we shouldn't just revert to unknown; but
Michael J. Spencer1a4fe8c2010-12-17 21:22:33 +00002177 // this isn't very important, we might as well be bug compatible.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002178 if (!InputType) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002179 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002180 InputType = types::TY_Object;
2181 }
Hans Wennborg091f1b62017-01-27 17:09:41 +00002182 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
2183 assert(A->getNumValues() == 1 && "The /U option has one value.");
2184 StringRef Val = A->getValue(0);
2185 if (Val.find_first_of("/\\") != StringRef::npos) {
2186 // Warn about e.g. "/Users/me/myfile.c".
2187 Diag(diag::warn_slash_u_filename) << Val;
2188 Diag(diag::note_use_dashdash);
2189 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002190 }
2191 }
Hans Wennborg70850d82013-07-18 20:29:38 +00002192 if (CCCIsCPP() && Inputs.empty()) {
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002193 // If called as standalone preprocessor, stdin is processed
2194 // if no other input is present.
David Blaikie0aaa7622017-01-13 17:34:15 +00002195 Arg *A = MakeInputArg(Args, *Opts, "-");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002196 Inputs.push_back(std::make_pair(types::TY_C, A));
2197 }
Chad Rosierecdede82011-08-12 22:08:57 +00002198}
2199
Samuel Antao64e965e2016-09-30 15:34:19 +00002200namespace {
2201/// Provides a convenient interface for different programming models to generate
2202/// the required device actions.
2203class OffloadingActionBuilder final {
2204 /// Flag used to trace errors in the builder.
2205 bool IsValid = false;
2206
2207 /// The compilation that is using this builder.
2208 Compilation &C;
2209
Samuel Antao64e965e2016-09-30 15:34:19 +00002210 /// Map between an input argument and the offload kinds used to process it.
2211 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
2212
2213 /// Builder interface. It doesn't build anything or keep any state.
2214 class DeviceActionBuilder {
2215 public:
2216 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
2217
2218 enum ActionBuilderReturnCode {
2219 // The builder acted successfully on the current action.
2220 ABRT_Success,
2221 // The builder didn't have to act on the current action.
2222 ABRT_Inactive,
2223 // The builder was successful and requested the host action to not be
2224 // generated.
2225 ABRT_Ignore_Host,
2226 };
2227
2228 protected:
2229 /// Compilation associated with this builder.
2230 Compilation &C;
2231
2232 /// Tool chains associated with this builder. The same programming
2233 /// model may have associated one or more tool chains.
2234 SmallVector<const ToolChain *, 2> ToolChains;
2235
2236 /// The derived arguments associated with this builder.
2237 DerivedArgList &Args;
2238
2239 /// The inputs associated with this builder.
2240 const Driver::InputList &Inputs;
2241
2242 /// The associated offload kind.
2243 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
2244
2245 public:
2246 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
2247 const Driver::InputList &Inputs,
2248 Action::OffloadKind AssociatedOffloadKind)
2249 : C(C), Args(Args), Inputs(Inputs),
2250 AssociatedOffloadKind(AssociatedOffloadKind) {}
2251 virtual ~DeviceActionBuilder() {}
2252
2253 /// Fill up the array \a DA with all the device dependences that should be
2254 /// added to the provided host action \a HostAction. By default it is
2255 /// inactive.
2256 virtual ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002257 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2258 phases::ID CurPhase, phases::ID FinalPhase,
2259 PhasesTy &Phases) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002260 return ABRT_Inactive;
2261 }
2262
2263 /// Update the state to include the provided host action \a HostAction as a
2264 /// dependency of the current device action. By default it is inactive.
2265 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
2266 return ABRT_Inactive;
2267 }
2268
2269 /// Append top level actions generated by the builder. Return true if errors
2270 /// were found.
2271 virtual void appendTopLevelActions(ActionList &AL) {}
2272
2273 /// Append linker actions generated by the builder. Return true if errors
2274 /// were found.
2275 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
2276
2277 /// Initialize the builder. Return true if any initialization errors are
2278 /// found.
2279 virtual bool initialize() { return false; }
2280
Samuel Antao69d6f312016-10-27 17:50:43 +00002281 /// Return true if the builder can use bundling/unbundling.
2282 virtual bool canUseBundlerUnbundler() const { return false; }
2283
Samuel Antao64e965e2016-09-30 15:34:19 +00002284 /// Return true if this builder is valid. We have a valid builder if we have
2285 /// associated device tool chains.
2286 bool isValid() { return !ToolChains.empty(); }
2287
2288 /// Return the associated offload kind.
2289 Action::OffloadKind getAssociatedOffloadKind() {
2290 return AssociatedOffloadKind;
2291 }
2292 };
2293
Yaxun Liu3af038b2018-05-30 00:49:10 +00002294 /// Base class for CUDA/HIP action builder. It injects device code in
2295 /// the host backend action.
2296 class CudaActionBuilderBase : public DeviceActionBuilder {
2297 protected:
Samuel Antao64e965e2016-09-30 15:34:19 +00002298 /// Flags to signal if the user requested host-only or device-only
2299 /// compilation.
2300 bool CompileHostOnly = false;
2301 bool CompileDeviceOnly = false;
2302
2303 /// List of GPU architectures to use in this compilation.
2304 SmallVector<CudaArch, 4> GpuArchList;
2305
2306 /// The CUDA actions for the current input.
2307 ActionList CudaDeviceActions;
2308
2309 /// The CUDA fat binary if it was generated for the current input.
2310 Action *CudaFatBinary = nullptr;
2311
2312 /// Flag that is set to true if this builder acted on the current input.
2313 bool IsActive = false;
Yaxun Liuab851932019-03-05 16:07:56 +00002314
2315 /// Flag for -fgpu-rdc.
2316 bool Relocatable = false;
Yaxun Liu3af038b2018-05-30 00:49:10 +00002317 public:
2318 CudaActionBuilderBase(Compilation &C, DerivedArgList &Args,
2319 const Driver::InputList &Inputs,
2320 Action::OffloadKind OFKind)
2321 : DeviceActionBuilder(C, Args, Inputs, OFKind) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002322
Yaxun Liu3af038b2018-05-30 00:49:10 +00002323 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2324 // While generating code for CUDA, we only depend on the host input action
2325 // to trigger the creation of all the CUDA device actions.
2326
2327 // If we are dealing with an input action, replicate it for each GPU
2328 // architecture. If we are in host-only mode we return 'success' so that
2329 // the host uses the CUDA offload kind.
2330 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2331 assert(!GpuArchList.empty() &&
2332 "We should have at least one GPU architecture.");
2333
2334 // If the host input is not CUDA or HIP, we don't need to bother about
2335 // this input.
2336 if (IA->getType() != types::TY_CUDA &&
2337 IA->getType() != types::TY_HIP) {
2338 // The builder will ignore this input.
2339 IsActive = false;
2340 return ABRT_Inactive;
2341 }
2342
2343 // Set the flag to true, so that the builder acts on the current input.
2344 IsActive = true;
2345
2346 if (CompileHostOnly)
2347 return ABRT_Success;
2348
2349 // Replicate inputs for each GPU architecture.
2350 auto Ty = IA->getType() == types::TY_HIP ? types::TY_HIP_DEVICE
2351 : types::TY_CUDA_DEVICE;
2352 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2353 CudaDeviceActions.push_back(
2354 C.MakeAction<InputAction>(IA->getInputArg(), Ty));
2355 }
2356
2357 return ABRT_Success;
2358 }
2359
2360 // If this is an unbundling action use it as is for each CUDA toolchain.
2361 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
Yaxun Liuab851932019-03-05 16:07:56 +00002362
2363 // If -fgpu-rdc is disabled, should not unbundle since there is no
2364 // device code to link.
2365 if (!Relocatable)
2366 return ABRT_Inactive;
2367
Yaxun Liu3af038b2018-05-30 00:49:10 +00002368 CudaDeviceActions.clear();
Aaron Enye Shibea57bb2019-01-04 19:05:41 +00002369 auto *IA = cast<InputAction>(UA->getInputs().back());
2370 std::string FileName = IA->getInputArg().getAsString(Args);
2371 // Check if the type of the file is the same as the action. Do not
2372 // unbundle it if it is not. Do not unbundle .so files, for example,
2373 // which are not object files.
2374 if (IA->getType() == types::TY_Object &&
2375 (!llvm::sys::path::has_extension(FileName) ||
2376 types::lookupTypeForExtension(
2377 llvm::sys::path::extension(FileName).drop_front()) !=
2378 types::TY_Object))
2379 return ABRT_Inactive;
2380
Yaxun Liu3af038b2018-05-30 00:49:10 +00002381 for (auto Arch : GpuArchList) {
2382 CudaDeviceActions.push_back(UA);
2383 UA->registerDependentActionInfo(ToolChains[0], CudaArchToString(Arch),
2384 AssociatedOffloadKind);
2385 }
2386 return ABRT_Success;
2387 }
2388
2389 return IsActive ? ABRT_Success : ABRT_Inactive;
2390 }
2391
2392 void appendTopLevelActions(ActionList &AL) override {
2393 // Utility to append actions to the top level list.
2394 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
2395 OffloadAction::DeviceDependences Dep;
2396 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
2397 AssociatedOffloadKind);
2398 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2399 };
2400
2401 // If we have a fat binary, add it to the list.
2402 if (CudaFatBinary) {
2403 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
2404 CudaDeviceActions.clear();
2405 CudaFatBinary = nullptr;
2406 return;
2407 }
2408
2409 if (CudaDeviceActions.empty())
2410 return;
2411
2412 // If we have CUDA actions at this point, that's because we have a have
2413 // partial compilation, so we should have an action for each GPU
2414 // architecture.
2415 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2416 "Expecting one action per GPU architecture.");
2417 assert(ToolChains.size() == 1 &&
2418 "Expecting to have a sing CUDA toolchain.");
2419 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
2420 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
2421
2422 CudaDeviceActions.clear();
2423 }
2424
2425 bool initialize() override {
2426 assert(AssociatedOffloadKind == Action::OFK_Cuda ||
2427 AssociatedOffloadKind == Action::OFK_HIP);
2428
2429 // We don't need to support CUDA.
2430 if (AssociatedOffloadKind == Action::OFK_Cuda &&
2431 !C.hasOffloadToolChain<Action::OFK_Cuda>())
2432 return false;
2433
2434 // We don't need to support HIP.
2435 if (AssociatedOffloadKind == Action::OFK_HIP &&
2436 !C.hasOffloadToolChain<Action::OFK_HIP>())
2437 return false;
2438
Yaxun Liuab851932019-03-05 16:07:56 +00002439 Relocatable = Args.hasFlag(options::OPT_fgpu_rdc,
2440 options::OPT_fno_gpu_rdc, /*Default=*/false);
2441
Yaxun Liu3af038b2018-05-30 00:49:10 +00002442 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
2443 assert(HostTC && "No toolchain for host compilation.");
2444 if (HostTC->getTriple().isNVPTX() ||
2445 HostTC->getTriple().getArch() == llvm::Triple::amdgcn) {
2446 // We do not support targeting NVPTX/AMDGCN for host compilation. Throw
2447 // an error and abort pipeline construction early so we don't trip
2448 // asserts that assume device-side compilation.
2449 C.getDriver().Diag(diag::err_drv_cuda_host_arch)
2450 << HostTC->getTriple().getArchName();
2451 return true;
2452 }
2453
2454 ToolChains.push_back(
2455 AssociatedOffloadKind == Action::OFK_Cuda
2456 ? C.getSingleOffloadToolChain<Action::OFK_Cuda>()
2457 : C.getSingleOffloadToolChain<Action::OFK_HIP>());
2458
2459 Arg *PartialCompilationArg = Args.getLastArg(
2460 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
2461 options::OPT_cuda_compile_host_device);
2462 CompileHostOnly = PartialCompilationArg &&
2463 PartialCompilationArg->getOption().matches(
2464 options::OPT_cuda_host_only);
2465 CompileDeviceOnly = PartialCompilationArg &&
2466 PartialCompilationArg->getOption().matches(
2467 options::OPT_cuda_device_only);
2468
2469 // Collect all cuda_gpu_arch parameters, removing duplicates.
2470 std::set<CudaArch> GpuArchs;
2471 bool Error = false;
2472 for (Arg *A : Args) {
2473 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
2474 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
2475 continue;
2476 A->claim();
2477
2478 const StringRef ArchStr = A->getValue();
2479 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
2480 ArchStr == "all") {
2481 GpuArchs.clear();
2482 continue;
2483 }
2484 CudaArch Arch = StringToCudaArch(ArchStr);
2485 if (Arch == CudaArch::UNKNOWN) {
2486 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
2487 Error = true;
2488 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
2489 GpuArchs.insert(Arch);
2490 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
2491 GpuArchs.erase(Arch);
2492 else
2493 llvm_unreachable("Unexpected option.");
2494 }
2495
2496 // Collect list of GPUs remaining in the set.
2497 for (CudaArch Arch : GpuArchs)
2498 GpuArchList.push_back(Arch);
2499
2500 // Default to sm_20 which is the lowest common denominator for
2501 // supported GPUs. sm_20 code should work correctly, if
2502 // suboptimally, on all newer GPUs.
2503 if (GpuArchList.empty())
2504 GpuArchList.push_back(CudaArch::SM_20);
2505
2506 return Error;
2507 }
2508 };
2509
2510 /// \brief CUDA action builder. It injects device code in the host backend
2511 /// action.
2512 class CudaActionBuilder final : public CudaActionBuilderBase {
Samuel Antao64e965e2016-09-30 15:34:19 +00002513 public:
2514 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
2515 const Driver::InputList &Inputs)
Yaxun Liu3af038b2018-05-30 00:49:10 +00002516 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_Cuda) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002517
2518 ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002519 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2520 phases::ID CurPhase, phases::ID FinalPhase,
2521 PhasesTy &Phases) override {
Samuel Antao64e965e2016-09-30 15:34:19 +00002522 if (!IsActive)
2523 return ABRT_Inactive;
2524
2525 // If we don't have more CUDA actions, we don't have any dependences to
2526 // create for the host.
2527 if (CudaDeviceActions.empty())
2528 return ABRT_Success;
2529
2530 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2531 "Expecting one action per GPU architecture.");
2532 assert(!CompileHostOnly &&
2533 "Not expecting CUDA actions in host-only compilation.");
2534
2535 // If we are generating code for the device or we are in a backend phase,
2536 // we attempt to generate the fat binary. We compile each arch to ptx and
2537 // assemble to cubin, then feed the cubin *and* the ptx into a device
2538 // "link" action, which uses fatbinary to combine these cubins into one
2539 // fatbin. The fatbin is then an input to the host action if not in
2540 // device-only mode.
2541 if (CompileDeviceOnly || CurPhase == phases::Backend) {
2542 ActionList DeviceActions;
2543 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2544 // Produce the device action from the current phase up to the assemble
2545 // phase.
2546 for (auto Ph : Phases) {
2547 // Skip the phases that were already dealt with.
2548 if (Ph < CurPhase)
2549 continue;
2550 // We have to be consistent with the host final phase.
2551 if (Ph > FinalPhase)
2552 break;
2553
2554 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
Artem Belevichecb178b2018-03-21 22:22:59 +00002555 C, Args, Ph, CudaDeviceActions[I], Action::OFK_Cuda);
Samuel Antao64e965e2016-09-30 15:34:19 +00002556
2557 if (Ph == phases::Assemble)
2558 break;
2559 }
2560
2561 // If we didn't reach the assemble phase, we can't generate the fat
2562 // binary. We don't need to generate the fat binary if we are not in
2563 // device-only mode.
2564 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
2565 CompileDeviceOnly)
2566 continue;
2567
2568 Action *AssembleAction = CudaDeviceActions[I];
2569 assert(AssembleAction->getType() == types::TY_Object);
2570 assert(AssembleAction->getInputs().size() == 1);
2571
2572 Action *BackendAction = AssembleAction->getInputs()[0];
2573 assert(BackendAction->getType() == types::TY_PP_Asm);
2574
2575 for (auto &A : {AssembleAction, BackendAction}) {
2576 OffloadAction::DeviceDependences DDep;
2577 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
2578 Action::OFK_Cuda);
2579 DeviceActions.push_back(
2580 C.MakeAction<OffloadAction>(DDep, A->getType()));
2581 }
2582 }
2583
2584 // We generate the fat binary if we have device input actions.
2585 if (!DeviceActions.empty()) {
2586 CudaFatBinary =
2587 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
2588
2589 if (!CompileDeviceOnly) {
2590 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2591 Action::OFK_Cuda);
2592 // Clear the fat binary, it is already a dependence to an host
2593 // action.
2594 CudaFatBinary = nullptr;
2595 }
2596
2597 // Remove the CUDA actions as they are already connected to an host
2598 // action or fat binary.
2599 CudaDeviceActions.clear();
2600 }
2601
2602 // We avoid creating host action in device-only mode.
2603 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Samuel Antao5b1a89a2016-10-27 00:53:34 +00002604 } else if (CurPhase > phases::Backend) {
2605 // If we are past the backend phase and still have a device action, we
2606 // don't have to do anything as this action is already a device
2607 // top-level action.
2608 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002609 }
2610
2611 assert(CurPhase < phases::Backend && "Generating single CUDA "
2612 "instructions should only occur "
2613 "before the backend phase!");
2614
2615 // By default, we produce an action for each device arch.
2616 for (Action *&A : CudaDeviceActions)
2617 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2618
2619 return ABRT_Success;
2620 }
Yaxun Liu3af038b2018-05-30 00:49:10 +00002621 };
2622 /// \brief HIP action builder. It injects device code in the host backend
2623 /// action.
2624 class HIPActionBuilder final : public CudaActionBuilderBase {
2625 /// The linker inputs obtained for each device arch.
2626 SmallVector<ActionList, 8> DeviceLinkerInputs;
Samuel Antao64e965e2016-09-30 15:34:19 +00002627
Yaxun Liu3af038b2018-05-30 00:49:10 +00002628 public:
2629 HIPActionBuilder(Compilation &C, DerivedArgList &Args,
2630 const Driver::InputList &Inputs)
Yaxun Liuab851932019-03-05 16:07:56 +00002631 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_HIP) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002632
Yaxun Liu3af038b2018-05-30 00:49:10 +00002633 bool canUseBundlerUnbundler() const override { return true; }
Samuel Antao64e965e2016-09-30 15:34:19 +00002634
Yaxun Liu3af038b2018-05-30 00:49:10 +00002635 ActionBuilderReturnCode
2636 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2637 phases::ID CurPhase, phases::ID FinalPhase,
2638 PhasesTy &Phases) override {
2639 // amdgcn does not support linking of object files, therefore we skip
Yaxun Liu97670892018-10-02 17:48:54 +00002640 // backend and assemble phases to output LLVM IR. Except for generating
2641 // non-relocatable device coee, where we generate fat binary for device
2642 // code and pass to host in Backend phase.
2643 if (CudaDeviceActions.empty() ||
2644 (CurPhase == phases::Backend && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002645 CurPhase == phases::Assemble)
2646 return ABRT_Success;
2647
Yaxun Liu97670892018-10-02 17:48:54 +00002648 assert(((CurPhase == phases::Link && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002649 CudaDeviceActions.size() == GpuArchList.size()) &&
2650 "Expecting one action per GPU architecture.");
2651 assert(!CompileHostOnly &&
2652 "Not expecting CUDA actions in host-only compilation.");
2653
Yaxun Liu97670892018-10-02 17:48:54 +00002654 if (!Relocatable && CurPhase == phases::Backend) {
2655 // If we are in backend phase, we attempt to generate the fat binary.
2656 // We compile each arch to IR and use a link action to generate code
2657 // object containing ISA. Then we use a special "link" action to create
2658 // a fat binary containing all the code objects for different GPU's.
2659 // The fat binary is then an input to the host action.
2660 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2661 // Create a link action to link device IR with device library
2662 // and generate ISA.
2663 ActionList AL;
2664 AL.push_back(CudaDeviceActions[I]);
2665 CudaDeviceActions[I] =
2666 C.MakeAction<LinkJobAction>(AL, types::TY_Image);
2667
2668 // OffloadingActionBuilder propagates device arch until an offload
2669 // action. Since the next action for creating fatbin does
2670 // not have device arch, whereas the above link action and its input
2671 // have device arch, an offload action is needed to stop the null
2672 // device arch of the next action being propagated to the above link
2673 // action.
2674 OffloadAction::DeviceDependences DDep;
2675 DDep.add(*CudaDeviceActions[I], *ToolChains.front(),
2676 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2677 CudaDeviceActions[I] = C.MakeAction<OffloadAction>(
2678 DDep, CudaDeviceActions[I]->getType());
2679 }
2680 // Create HIP fat binary with a special "link" action.
2681 CudaFatBinary =
2682 C.MakeAction<LinkJobAction>(CudaDeviceActions,
2683 types::TY_HIP_FATBIN);
2684
Yaxun Liu2bcc9512018-11-14 04:47:31 +00002685 if (!CompileDeviceOnly) {
2686 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2687 AssociatedOffloadKind);
2688 // Clear the fat binary, it is already a dependence to an host
2689 // action.
2690 CudaFatBinary = nullptr;
2691 }
Yaxun Liu97670892018-10-02 17:48:54 +00002692
2693 // Remove the CUDA actions as they are already connected to an host
2694 // action or fat binary.
2695 CudaDeviceActions.clear();
2696
Yaxun Liu2bcc9512018-11-14 04:47:31 +00002697 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Yaxun Liu97670892018-10-02 17:48:54 +00002698 } else if (CurPhase == phases::Link) {
2699 // Save CudaDeviceActions to DeviceLinkerInputs for each GPU subarch.
2700 // This happens to each device action originated from each input file.
2701 // Later on, device actions in DeviceLinkerInputs are used to create
2702 // device link actions in appendLinkDependences and the created device
2703 // link actions are passed to the offload action as device dependence.
Yaxun Liu3af038b2018-05-30 00:49:10 +00002704 DeviceLinkerInputs.resize(CudaDeviceActions.size());
2705 auto LI = DeviceLinkerInputs.begin();
2706 for (auto *A : CudaDeviceActions) {
2707 LI->push_back(A);
2708 ++LI;
Samuel Antao64e965e2016-09-30 15:34:19 +00002709 }
2710
Yaxun Liu3af038b2018-05-30 00:49:10 +00002711 // We will pass the device action as a host dependence, so we don't
2712 // need to do anything else with them.
2713 CudaDeviceActions.clear();
Samuel Antao64e965e2016-09-30 15:34:19 +00002714 return ABRT_Success;
2715 }
2716
Yaxun Liu3af038b2018-05-30 00:49:10 +00002717 // By default, we produce an action for each device arch.
2718 for (Action *&A : CudaDeviceActions)
2719 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A,
2720 AssociatedOffloadKind);
2721
2722 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002723 }
2724
Yaxun Liu3af038b2018-05-30 00:49:10 +00002725 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2726 // Append a new link action for each device.
2727 unsigned I = 0;
2728 for (auto &LI : DeviceLinkerInputs) {
2729 auto *DeviceLinkAction =
2730 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2731 DA.add(*DeviceLinkAction, *ToolChains[0],
2732 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2733 ++I;
Samuel Antao64e965e2016-09-30 15:34:19 +00002734 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002735 }
2736 };
2737
Samuel Antao28c4f182016-10-27 17:08:03 +00002738 /// OpenMP action builder. The host bitcode is passed to the device frontend
2739 /// and all the device linked images are passed to the host link phase.
2740 class OpenMPActionBuilder final : public DeviceActionBuilder {
2741 /// The OpenMP actions for the current input.
2742 ActionList OpenMPDeviceActions;
2743
2744 /// The linker inputs obtained for each toolchain.
2745 SmallVector<ActionList, 8> DeviceLinkerInputs;
2746
2747 public:
2748 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2749 const Driver::InputList &Inputs)
2750 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2751
2752 ActionBuilderReturnCode
2753 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2754 phases::ID CurPhase, phases::ID FinalPhase,
2755 PhasesTy &Phases) override {
Alexey Bataeva5178f52018-09-28 16:17:59 +00002756 if (OpenMPDeviceActions.empty())
2757 return ABRT_Inactive;
Samuel Antao28c4f182016-10-27 17:08:03 +00002758
2759 // We should always have an action for each input.
2760 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2761 "Number of OpenMP actions and toolchains do not match.");
2762
2763 // The host only depends on device action in the linking phase, when all
2764 // the device images have to be embedded in the host image.
2765 if (CurPhase == phases::Link) {
2766 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2767 "Toolchains and linker inputs sizes do not match.");
2768 auto LI = DeviceLinkerInputs.begin();
2769 for (auto *A : OpenMPDeviceActions) {
2770 LI->push_back(A);
2771 ++LI;
2772 }
2773
2774 // We passed the device action as a host dependence, so we don't need to
2775 // do anything else with them.
2776 OpenMPDeviceActions.clear();
2777 return ABRT_Success;
2778 }
2779
2780 // By default, we produce an action for each device arch.
2781 for (Action *&A : OpenMPDeviceActions)
2782 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2783
2784 return ABRT_Success;
2785 }
2786
2787 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2788
2789 // If this is an input action replicate it for each OpenMP toolchain.
2790 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2791 OpenMPDeviceActions.clear();
2792 for (unsigned I = 0; I < ToolChains.size(); ++I)
2793 OpenMPDeviceActions.push_back(
2794 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2795 return ABRT_Success;
2796 }
2797
Samuel Antaofab4f372016-10-27 18:00:51 +00002798 // If this is an unbundling action use it as is for each OpenMP toolchain.
2799 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2800 OpenMPDeviceActions.clear();
Alexey Bataeva5178f52018-09-28 16:17:59 +00002801 auto *IA = cast<InputAction>(UA->getInputs().back());
2802 std::string FileName = IA->getInputArg().getAsString(Args);
2803 // Check if the type of the file is the same as the action. Do not
2804 // unbundle it if it is not. Do not unbundle .so files, for example,
2805 // which are not object files.
2806 if (IA->getType() == types::TY_Object &&
2807 (!llvm::sys::path::has_extension(FileName) ||
2808 types::lookupTypeForExtension(
2809 llvm::sys::path::extension(FileName).drop_front()) !=
2810 types::TY_Object))
2811 return ABRT_Inactive;
Samuel Antaofab4f372016-10-27 18:00:51 +00002812 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2813 OpenMPDeviceActions.push_back(UA);
2814 UA->registerDependentActionInfo(
2815 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2816 }
2817 return ABRT_Success;
2818 }
2819
Samuel Antao28c4f182016-10-27 17:08:03 +00002820 // When generating code for OpenMP we use the host compile phase result as
2821 // a dependence to the device compile phase so that it can learn what
2822 // declarations should be emitted. However, this is not the only use for
2823 // the host action, so we prevent it from being collapsed.
2824 if (isa<CompileJobAction>(HostAction)) {
2825 HostAction->setCannotBeCollapsedWithNextDependentAction();
2826 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2827 "Toolchains and device action sizes do not match.");
2828 OffloadAction::HostDependence HDep(
2829 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2830 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2831 auto TC = ToolChains.begin();
2832 for (Action *&A : OpenMPDeviceActions) {
2833 assert(isa<CompileJobAction>(A));
2834 OffloadAction::DeviceDependences DDep;
2835 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2836 A = C.MakeAction<OffloadAction>(HDep, DDep);
2837 ++TC;
2838 }
2839 }
2840 return ABRT_Success;
2841 }
2842
Samuel Antao69d6f312016-10-27 17:50:43 +00002843 void appendTopLevelActions(ActionList &AL) override {
2844 if (OpenMPDeviceActions.empty())
2845 return;
2846
2847 // We should always have an action for each input.
2848 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2849 "Number of OpenMP actions and toolchains do not match.");
2850
2851 // Append all device actions followed by the proper offload action.
2852 auto TI = ToolChains.begin();
2853 for (auto *A : OpenMPDeviceActions) {
2854 OffloadAction::DeviceDependences Dep;
2855 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2856 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2857 ++TI;
2858 }
2859 // We no longer need the action stored in this builder.
2860 OpenMPDeviceActions.clear();
2861 }
2862
Samuel Antao28c4f182016-10-27 17:08:03 +00002863 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2864 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2865 "Toolchains and linker inputs sizes do not match.");
2866
2867 // Append a new link action for each device.
2868 auto TC = ToolChains.begin();
2869 for (auto &LI : DeviceLinkerInputs) {
2870 auto *DeviceLinkAction =
2871 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2872 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2873 Action::OFK_OpenMP);
2874 ++TC;
2875 }
2876 }
2877
2878 bool initialize() override {
2879 // Get the OpenMP toolchains. If we don't get any, the action builder will
2880 // know there is nothing to do related to OpenMP offloading.
2881 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2882 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2883 ++TI)
2884 ToolChains.push_back(TI->second);
2885
2886 DeviceLinkerInputs.resize(ToolChains.size());
2887 return false;
2888 }
Samuel Antao69d6f312016-10-27 17:50:43 +00002889
2890 bool canUseBundlerUnbundler() const override {
2891 // OpenMP should use bundled files whenever possible.
2892 return true;
2893 }
Samuel Antao28c4f182016-10-27 17:08:03 +00002894 };
2895
2896 ///
2897 /// TODO: Add the implementation for other specialized builders here.
2898 ///
Samuel Antao64e965e2016-09-30 15:34:19 +00002899
2900 /// Specialized builders being used by this offloading action builder.
2901 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2902
Samuel Antao69d6f312016-10-27 17:50:43 +00002903 /// Flag set to true if all valid builders allow file bundling/unbundling.
2904 bool CanUseBundler;
2905
Samuel Antao64e965e2016-09-30 15:34:19 +00002906public:
2907 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2908 const Driver::InputList &Inputs)
Samuel Antao10e905c2016-10-27 01:08:58 +00002909 : C(C) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002910 // Create a specialized builder for each device toolchain.
2911
2912 IsValid = true;
2913
2914 // Create a specialized builder for CUDA.
2915 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2916
Yaxun Liu3af038b2018-05-30 00:49:10 +00002917 // Create a specialized builder for HIP.
2918 SpecializedBuilders.push_back(new HIPActionBuilder(C, Args, Inputs));
2919
Samuel Antao28c4f182016-10-27 17:08:03 +00002920 // Create a specialized builder for OpenMP.
2921 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2922
Samuel Antao64e965e2016-09-30 15:34:19 +00002923 //
2924 // TODO: Build other specialized builders here.
2925 //
2926
Samuel Antao69d6f312016-10-27 17:50:43 +00002927 // Initialize all the builders, keeping track of errors. If all valid
2928 // builders agree that we can use bundling, set the flag to true.
2929 unsigned ValidBuilders = 0u;
2930 unsigned ValidBuildersSupportingBundling = 0u;
2931 for (auto *SB : SpecializedBuilders) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002932 IsValid = IsValid && !SB->initialize();
Samuel Antao69d6f312016-10-27 17:50:43 +00002933
2934 // Update the counters if the builder is valid.
2935 if (SB->isValid()) {
2936 ++ValidBuilders;
2937 if (SB->canUseBundlerUnbundler())
2938 ++ValidBuildersSupportingBundling;
2939 }
2940 }
2941 CanUseBundler =
2942 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
Artem Belevichf981e30b2016-08-02 22:37:47 +00002943 }
Justin Lebardc3c5042016-04-19 02:27:07 +00002944
Samuel Antao64e965e2016-09-30 15:34:19 +00002945 ~OffloadingActionBuilder() {
2946 for (auto *SB : SpecializedBuilders)
2947 delete SB;
Samuel Antaod06239d2016-07-15 23:13:27 +00002948 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002949
Samuel Antao64e965e2016-09-30 15:34:19 +00002950 /// Generate an action that adds device dependences (if any) to a host action.
2951 /// If no device dependence actions exist, just return the host action \a
2952 /// HostAction. If an error is found or if no builder requires the host action
2953 /// to be generated, return nullptr.
2954 Action *
2955 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2956 phases::ID CurPhase, phases::ID FinalPhase,
2957 DeviceActionBuilder::PhasesTy &Phases) {
2958 if (!IsValid)
2959 return nullptr;
Justin Lebar7bf77982016-01-11 23:27:13 +00002960
Samuel Antao64e965e2016-09-30 15:34:19 +00002961 if (SpecializedBuilders.empty())
2962 return HostAction;
2963
2964 assert(HostAction && "Invalid host action!");
2965
2966 OffloadAction::DeviceDependences DDeps;
2967 // Check if all the programming models agree we should not emit the host
2968 // action. Also, keep track of the offloading kinds employed.
2969 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2970 unsigned InactiveBuilders = 0u;
2971 unsigned IgnoringBuilders = 0u;
2972 for (auto *SB : SpecializedBuilders) {
2973 if (!SB->isValid()) {
2974 ++InactiveBuilders;
2975 continue;
2976 }
2977
Samuel Antao28c4f182016-10-27 17:08:03 +00002978 auto RetCode =
2979 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
Samuel Antao64e965e2016-09-30 15:34:19 +00002980
2981 // If the builder explicitly says the host action should be ignored,
2982 // we need to increment the variable that tracks the builders that request
2983 // the host object to be ignored.
2984 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2985 ++IgnoringBuilders;
2986
2987 // Unless the builder was inactive for this action, we have to record the
2988 // offload kind because the host will have to use it.
2989 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2990 OffloadKind |= SB->getAssociatedOffloadKind();
2991 }
2992
2993 // If all builders agree that the host object should be ignored, just return
2994 // nullptr.
2995 if (IgnoringBuilders &&
2996 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2997 return nullptr;
2998
2999 if (DDeps.getActions().empty())
3000 return HostAction;
3001
3002 // We have dependences we need to bundle together. We use an offload action
3003 // for that.
3004 OffloadAction::HostDependence HDep(
3005 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
3006 /*BoundArch=*/nullptr, DDeps);
3007 return C.MakeAction<OffloadAction>(HDep, DDeps);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003008 }
3009
Samuel Antao64e965e2016-09-30 15:34:19 +00003010 /// Generate an action that adds a host dependence to a device action. The
3011 /// results will be kept in this action builder. Return true if an error was
3012 /// found.
Samuel Antaofab4f372016-10-27 18:00:51 +00003013 bool addHostDependenceToDeviceActions(Action *&HostAction,
Samuel Antao64e965e2016-09-30 15:34:19 +00003014 const Arg *InputArg) {
3015 if (!IsValid)
3016 return true;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003017
Samuel Antaofab4f372016-10-27 18:00:51 +00003018 // If we are supporting bundling/unbundling and the current action is an
3019 // input action of non-source file, we replace the host action by the
3020 // unbundling action. The bundler tool has the logic to detect if an input
3021 // is a bundle or not and if the input is not a bundle it assumes it is a
3022 // host file. Therefore it is safe to create an unbundling action even if
3023 // the input is not a bundle.
3024 if (CanUseBundler && isa<InputAction>(HostAction) &&
3025 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
3026 !types::isSrcFile(HostAction->getType())) {
3027 auto UnbundlingHostAction =
3028 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
3029 UnbundlingHostAction->registerDependentActionInfo(
3030 C.getSingleOffloadToolChain<Action::OFK_Host>(),
Yaxun Liuf37b50a2018-07-24 01:03:44 +00003031 /*BoundArch=*/StringRef(), Action::OFK_Host);
Samuel Antaofab4f372016-10-27 18:00:51 +00003032 HostAction = UnbundlingHostAction;
3033 }
3034
Samuel Antao64e965e2016-09-30 15:34:19 +00003035 assert(HostAction && "Invalid host action!");
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003036
Samuel Antao64e965e2016-09-30 15:34:19 +00003037 // Register the offload kinds that are used.
3038 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
3039 for (auto *SB : SpecializedBuilders) {
3040 if (!SB->isValid())
3041 continue;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003042
Samuel Antao64e965e2016-09-30 15:34:19 +00003043 auto RetCode = SB->addDeviceDepences(HostAction);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003044
Samuel Antao64e965e2016-09-30 15:34:19 +00003045 // Host dependences for device actions are not compatible with that same
3046 // action being ignored.
3047 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
3048 "Host dependence not expected to be ignored.!");
Samuel Antaod06239d2016-07-15 23:13:27 +00003049
Samuel Antao64e965e2016-09-30 15:34:19 +00003050 // Unless the builder was inactive for this action, we have to record the
3051 // offload kind because the host will have to use it.
3052 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
3053 OffloadKind |= SB->getAssociatedOffloadKind();
3054 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003055
Alexey Bataeva5178f52018-09-28 16:17:59 +00003056 // Do not use unbundler if the Host does not depend on device action.
3057 if (OffloadKind == Action::OFK_None && CanUseBundler)
3058 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction))
3059 HostAction = UA->getInputs().back();
3060
Samuel Antao64e965e2016-09-30 15:34:19 +00003061 return false;
3062 }
3063
Samuel Antao69d6f312016-10-27 17:50:43 +00003064 /// Add the offloading top level actions to the provided action list. This
3065 /// function can replace the host action by a bundling action if the
3066 /// programming models allow it.
Samuel Antao64e965e2016-09-30 15:34:19 +00003067 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
3068 const Arg *InputArg) {
Samuel Antao69d6f312016-10-27 17:50:43 +00003069 // Get the device actions to be appended.
3070 ActionList OffloadAL;
Samuel Antao64e965e2016-09-30 15:34:19 +00003071 for (auto *SB : SpecializedBuilders) {
3072 if (!SB->isValid())
3073 continue;
Samuel Antao69d6f312016-10-27 17:50:43 +00003074 SB->appendTopLevelActions(OffloadAL);
Samuel Antao64e965e2016-09-30 15:34:19 +00003075 }
3076
Samuel Antao69d6f312016-10-27 17:50:43 +00003077 // If we can use the bundler, replace the host action by the bundling one in
Yaxun Liu2bcc9512018-11-14 04:47:31 +00003078 // the resulting list. Otherwise, just append the device actions. For
3079 // device only compilation, HostAction is a null pointer, therefore only do
3080 // this when HostAction is not a null pointer.
3081 if (CanUseBundler && HostAction && !OffloadAL.empty()) {
Samuel Antao69d6f312016-10-27 17:50:43 +00003082 // Add the host action to the list in order to create the bundling action.
3083 OffloadAL.push_back(HostAction);
3084
3085 // We expect that the host action was just appended to the action list
3086 // before this method was called.
3087 assert(HostAction == AL.back() && "Host action not in the list??");
3088 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
3089 AL.back() = HostAction;
3090 } else
3091 AL.append(OffloadAL.begin(), OffloadAL.end());
3092
Samuel Antao64e965e2016-09-30 15:34:19 +00003093 // Propagate to the current host action (if any) the offload information
3094 // associated with the current input.
3095 if (HostAction)
3096 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
3097 /*BoundArch=*/nullptr);
Samuel Antao64e965e2016-09-30 15:34:19 +00003098 return false;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003099 }
Artem Belevich5bde4e02015-07-20 20:02:54 +00003100
Samuel Antao64e965e2016-09-30 15:34:19 +00003101 /// Processes the host linker action. This currently consists of replacing it
3102 /// with an offload action if there are device link objects and propagate to
3103 /// the host action all the offload kinds used in the current compilation. The
3104 /// resulting action is returned.
3105 Action *processHostLinkAction(Action *HostAction) {
3106 // Add all the dependences from the device linking actions.
3107 OffloadAction::DeviceDependences DDeps;
3108 for (auto *SB : SpecializedBuilders) {
3109 if (!SB->isValid())
3110 continue;
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003111
Samuel Antao64e965e2016-09-30 15:34:19 +00003112 SB->appendLinkDependences(DDeps);
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003113 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003114
Samuel Antao64e965e2016-09-30 15:34:19 +00003115 // Calculate all the offload kinds used in the current compilation.
3116 unsigned ActiveOffloadKinds = 0u;
3117 for (auto &I : InputArgToOffloadKindMap)
3118 ActiveOffloadKinds |= I.second;
3119
3120 // If we don't have device dependencies, we don't have to create an offload
3121 // action.
3122 if (DDeps.getActions().empty()) {
3123 // Propagate all the active kinds to host action. Given that it is a link
3124 // action it is assumed to depend on all actions generated so far.
3125 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
3126 /*BoundArch=*/nullptr);
3127 return HostAction;
3128 }
3129
3130 // Create the offload action with all dependences. When an offload action
3131 // is created the kinds are propagated to the host action, so we don't have
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003132 // to do that explicitly here.
Samuel Antao64e965e2016-09-30 15:34:19 +00003133 OffloadAction::HostDependence HDep(
3134 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
3135 /*BoundArch*/ nullptr, ActiveOffloadKinds);
3136 return C.MakeAction<OffloadAction>(HDep, DDeps);
3137 }
3138};
3139} // anonymous namespace.
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003140
Justin Lebar0f3474c2016-02-11 02:00:50 +00003141void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
3142 const InputList &Inputs, ActionList &Actions) const {
Chad Rosierecdede82011-08-12 22:08:57 +00003143 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00003144
Daniel Dunbar34c41872009-03-13 00:17:48 +00003145 if (!SuppressMissingInputWarning && Inputs.empty()) {
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003146 Diag(clang::diag::err_drv_no_input_files);
3147 return;
3148 }
3149
Chad Rosier7742b5d2011-07-27 23:36:45 +00003150 Arg *FinalPhaseArg;
3151 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003152
Bob Haarmanaaf51912017-02-27 19:40:19 +00003153 if (FinalPhase == phases::Link) {
3154 if (Args.hasArg(options::OPT_emit_llvm))
3155 Diag(clang::diag::err_drv_emit_llvm_link);
3156 if (IsCLMode() && LTOMode != LTOK_None &&
3157 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
3158 Diag(clang::diag::err_drv_lto_without_lld);
Rafael Espindolae8025642013-08-25 14:27:09 +00003159 }
3160
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003161 // Reject -Z* at the top level, these options should never have been exposed
3162 // by gcc.
Daniel Dunbardd765242009-03-26 16:12:09 +00003163 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
Daniel Dunbar0e759942009-03-20 06:14:23 +00003164 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003165
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003166 // Diagnose misuse of /Fo.
3167 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003168 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003169 if (Inputs.size() > 1 && !V.empty() &&
3170 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003171 // Check whether /Fo tries to name an output file for multiple inputs.
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003172 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003173 << A->getSpelling() << V;
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003174 Args.eraseArg(options::OPT__SLASH_Fo);
3175 }
3176 }
3177
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003178 // Diagnose misuse of /Fa.
3179 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
3180 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003181 if (Inputs.size() > 1 && !V.empty() &&
3182 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003183 // Check whether /Fa tries to name an asm file for multiple inputs.
3184 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003185 << A->getSpelling() << V;
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003186 Args.eraseArg(options::OPT__SLASH_Fa);
3187 }
3188 }
3189
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00003190 // Diagnose misuse of /o.
3191 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
3192 if (A->getValue()[0] == '\0') {
3193 // It has to have a value.
3194 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
3195 Args.eraseArg(options::OPT__SLASH_o);
3196 }
3197 }
3198
Mike Rice58df1af2018-09-11 17:10:44 +00003199 // Ignore /Yc/Yu if both /Yc and /Yu passed but with different filenames.
Nico Weber2ca4be92016-03-01 23:16:44 +00003200 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
3201 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
Nico Weber2ca4be92016-03-01 23:16:44 +00003202 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
3203 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
3204 Args.eraseArg(options::OPT__SLASH_Yc);
3205 Args.eraseArg(options::OPT__SLASH_Yu);
3206 YcArg = YuArg = nullptr;
3207 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003208 if (YcArg && Inputs.size() > 1) {
3209 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
3210 Args.eraseArg(options::OPT__SLASH_Yc);
3211 YcArg = nullptr;
3212 }
Erich Keaneeaca3882018-08-17 13:43:39 +00003213 if (FinalPhase == phases::Preprocess || Args.hasArg(options::OPT__SLASH_Y_)) {
3214 // If only preprocessing or /Y- is used, all pch handling is disabled.
3215 // Rather than check for it everywhere, just remove clang-cl pch-related
3216 // flags here.
Nico Weber2ca4be92016-03-01 23:16:44 +00003217 Args.eraseArg(options::OPT__SLASH_Fp);
3218 Args.eraseArg(options::OPT__SLASH_Yc);
3219 Args.eraseArg(options::OPT__SLASH_Yu);
3220 YcArg = YuArg = nullptr;
3221 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003222
Samuel Antao64e965e2016-09-30 15:34:19 +00003223 // Builder to be used to build offloading actions.
3224 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
Samuel Antaod06239d2016-07-15 23:13:27 +00003225
Daniel Dunbar65229332009-03-13 11:38:42 +00003226 // Construct the actions to perform.
Richard Smithcd35eff2018-09-15 01:21:16 +00003227 HeaderModulePrecompileJobAction *HeaderModuleAction = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003228 ActionList LinkerInputs;
Alp Toker965f8822013-11-27 05:22:15 +00003229
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003230 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
Artem Belevich5bde4e02015-07-20 20:02:54 +00003231 for (auto &I : Inputs) {
3232 types::ID InputType = I.first;
3233 const Arg *InputArg = I.second;
Daniel Dunbar65229332009-03-13 11:38:42 +00003234
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003235 PL.clear();
3236 types::getCompilationPhases(InputType, PL);
Daniel Dunbar65229332009-03-13 11:38:42 +00003237
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003238 // If the first step comes after the final phase we are doing as part of
3239 // this compilation, warn the user about it.
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003240 phases::ID InitialPhase = PL[0];
Daniel Dunbar65229332009-03-13 11:38:42 +00003241 if (InitialPhase > FinalPhase) {
Martin Storsjo665c7a42018-05-04 06:05:58 +00003242 if (InputArg->isClaimed())
3243 continue;
3244
Daniel Dunbaradc5c7c2009-03-19 07:57:08 +00003245 // Claim here to avoid the more general unused warning.
3246 InputArg->claim();
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003247
Daniel Dunbar2db3e732011-04-20 15:44:48 +00003248 // Suppress all unused style warnings with -Qunused-arguments
3249 if (Args.hasArg(options::OPT_Qunused_arguments))
3250 continue;
3251
Richard Smith403f76e2012-08-06 04:09:06 +00003252 // Special case when final phase determined by binary name, rather than
3253 // by a command-line argument with a corresponding Arg.
Hans Wennborg70850d82013-07-18 20:29:38 +00003254 if (CCCIsCPP())
Richard Smith403f76e2012-08-06 04:09:06 +00003255 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003256 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003257 // Special case '-E' warning on a previously preprocessed file to make
3258 // more sense.
Richard Smith403f76e2012-08-06 04:09:06 +00003259 else if (InitialPhase == phases::Compile &&
3260 FinalPhase == phases::Preprocess &&
3261 getPreprocessedType(InputType) == types::TY_INVALID)
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003262 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003263 << InputArg->getAsString(Args) << !!FinalPhaseArg
3264 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003265 else
3266 Diag(clang::diag::warn_drv_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003267 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
3268 << !!FinalPhaseArg
3269 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar65229332009-03-13 11:38:42 +00003270 continue;
3271 }
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003272
Nico Weberad2d8f32016-04-21 19:59:10 +00003273 if (YcArg) {
3274 // Add a separate precompile phase for the compile phase.
3275 if (FinalPhase >= phases::Compile) {
Richard Smith8cd452d2016-08-30 18:55:16 +00003276 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003277 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
Richard Smith8cd452d2016-08-30 18:55:16 +00003278 types::getCompilationPhases(HeaderType, PCHPL);
Nico Weberad2d8f32016-04-21 19:59:10 +00003279 // Build the pipeline for the pch file.
Richard Smith8cd452d2016-08-30 18:55:16 +00003280 Action *ClangClPch =
Erich Keane76675de2018-07-05 17:22:13 +00003281 C.MakeAction<InputAction>(*InputArg, HeaderType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003282 for (phases::ID Phase : PCHPL)
3283 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
3284 assert(ClangClPch);
3285 Actions.push_back(ClangClPch);
3286 // The driver currently exits after the first failed command. This
3287 // relies on that behavior, to make sure if the pch generation fails,
3288 // the main compilation won't run.
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00003289 // FIXME: If the main compilation fails, the PCH generation should
3290 // probably not be considered successful either.
Nico Weberad2d8f32016-04-21 19:59:10 +00003291 }
3292 }
3293
Daniel Dunbar65229332009-03-13 11:38:42 +00003294 // Build the pipeline for this file.
Justin Lebar41094612016-01-11 23:07:27 +00003295 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
Samuel Antao64e965e2016-09-30 15:34:19 +00003296
3297 // Use the current host action in any of the offloading actions, if
3298 // required.
3299 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3300 break;
3301
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003302 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
3303 i != e; ++i) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003304 phases::ID Phase = *i;
Daniel Dunbar65229332009-03-13 11:38:42 +00003305
3306 // We are done if this step is past what the user requested.
3307 if (Phase > FinalPhase)
3308 break;
3309
Samuel Antao64e965e2016-09-30 15:34:19 +00003310 // Add any offload action the host action depends on.
3311 Current = OffloadBuilder.addDeviceDependencesToHostAction(
3312 Current, InputArg, Phase, FinalPhase, PL);
3313 if (!Current)
3314 break;
3315
Daniel Dunbar65229332009-03-13 11:38:42 +00003316 // Queue linker inputs.
3317 if (Phase == phases::Link) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003318 assert((i + 1) == e && "linking must be final compilation step.");
Justin Lebar41094612016-01-11 23:07:27 +00003319 LinkerInputs.push_back(Current);
3320 Current = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003321 break;
3322 }
3323
Richard Smithcd35eff2018-09-15 01:21:16 +00003324 // Each precompiled header file after a module file action is a module
3325 // header of that same module file, rather than being compiled to a
3326 // separate PCH.
3327 if (Phase == phases::Precompile && HeaderModuleAction &&
3328 getPrecompiledType(InputType) == types::TY_PCH) {
3329 HeaderModuleAction->addModuleHeaderInput(Current);
3330 Current = nullptr;
3331 break;
3332 }
3333
3334 // FIXME: Should we include any prior module file outputs as inputs of
3335 // later actions in the same command line?
3336
Samuel Antao64e965e2016-09-30 15:34:19 +00003337 // Otherwise construct the appropriate action.
Richard Smithcd35eff2018-09-15 01:21:16 +00003338 Action *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003339
3340 // We didn't create a new action, so we will just move to the next phase.
3341 if (NewCurrent == Current)
Daniel Dunbar13864952009-03-24 20:17:30 +00003342 continue;
3343
Richard Smithcd35eff2018-09-15 01:21:16 +00003344 if (auto *HMA = dyn_cast<HeaderModulePrecompileJobAction>(NewCurrent))
3345 HeaderModuleAction = HMA;
3346
Samuel Antao64e965e2016-09-30 15:34:19 +00003347 Current = NewCurrent;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003348
Samuel Antao64e965e2016-09-30 15:34:19 +00003349 // Use the current host action in any of the offloading actions, if
3350 // required.
3351 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3352 break;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003353
Daniel Dunbar65229332009-03-13 11:38:42 +00003354 if (Current->getType() == types::TY_Nothing)
3355 break;
3356 }
3357
Samuel Antao64e965e2016-09-30 15:34:19 +00003358 // If we ended with something, add to the output list.
3359 if (Current)
Justin Lebar41094612016-01-11 23:07:27 +00003360 Actions.push_back(Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003361
3362 // Add any top level actions generated for offloading.
3363 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003364 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003365
Samuel Antao64e965e2016-09-30 15:34:19 +00003366 // Add a link action if necessary.
Samuel Antaod06239d2016-07-15 23:13:27 +00003367 if (!LinkerInputs.empty()) {
Samuel Antao64e965e2016-09-30 15:34:19 +00003368 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
3369 LA = OffloadBuilder.processHostLinkAction(LA);
3370 Actions.push_back(LA);
Samuel Antaod06239d2016-07-15 23:13:27 +00003371 }
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003372
3373 // If we are linking, claim any options which are obviously only used for
3374 // compilation.
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003375 if (FinalPhase == phases::Link && PL.size() == 1) {
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003376 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003377 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
3378 }
3379
Ziang Wanaf857b92019-06-14 21:42:21 +00003380 // If the use specify --print-supported-cpus, clang will only print out
3381 // supported cpu names without doing compilation.
3382 if (Arg *A = Args.getLastArg(options::OPT__print_supported_cpus)) {
3383 Actions.clear();
3384 // the compilation now has only two phases: Input and Compile
3385 // use the --prints-supported-cpus flag as the dummy input to cc1
3386 Action *InputAc = C.MakeAction<InputAction>(*A, types::TY_C);
3387 Actions.push_back(
3388 C.MakeAction<PrecompileJobAction>(InputAc, types::TY_Nothing));
3389 }
3390
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003391 // Claim ignored clang-cl options.
3392 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
Artem Belevichbaae0932015-07-28 21:01:30 +00003393
Justin Lebardc3c5042016-04-19 02:27:07 +00003394 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
3395 // to non-CUDA compilations and should not trigger warnings there.
Artem Belevichbaae0932015-07-28 21:01:30 +00003396 Args.ClaimAllArgs(options::OPT_cuda_host_only);
Justin Lebardc3c5042016-04-19 02:27:07 +00003397 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
Daniel Dunbar65229332009-03-13 11:38:42 +00003398}
3399
Artem Belevichecb178b2018-03-21 22:22:59 +00003400Action *Driver::ConstructPhaseAction(
3401 Compilation &C, const ArgList &Args, phases::ID Phase, Action *Input,
3402 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003403 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
Samuel Antao64e965e2016-09-30 15:34:19 +00003404
3405 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
3406 // encode this in the steps because the intermediate type depends on
3407 // arguments. Just special case here.
3408 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
3409 return Input;
3410
Daniel Dunbar65229332009-03-13 11:38:42 +00003411 // Build the appropriate action.
3412 switch (Phase) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003413 case phases::Link:
3414 llvm_unreachable("link action invalid here.");
Daniel Dunbar65229332009-03-13 11:38:42 +00003415 case phases::Preprocess: {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003416 types::ID OutputTy;
3417 // -{M, MM} alter the output type.
Daniel Dunbar86aed7d2010-12-08 21:33:40 +00003418 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003419 OutputTy = types::TY_Dependencies;
3420 } else {
David Blaikie5d577a22012-06-29 22:03:56 +00003421 OutputTy = Input->getType();
3422 if (!Args.hasFlag(options::OPT_frewrite_includes,
Justin Bognerce8245b2014-06-24 08:01:01 +00003423 options::OPT_fno_rewrite_includes, false) &&
Richard Smith86a3ef52017-06-09 21:24:02 +00003424 !Args.hasFlag(options::OPT_frewrite_imports,
3425 options::OPT_fno_rewrite_imports, false) &&
Justin Bognerce8245b2014-06-24 08:01:01 +00003426 !CCGenDiagnostics)
David Blaikie5d577a22012-06-29 22:03:56 +00003427 OutputTy = types::getPreprocessedType(OutputTy);
Daniel Dunbard67a3222009-03-30 06:36:42 +00003428 assert(OutputTy != types::TY_INVALID &&
3429 "Cannot preprocess this input type!");
3430 }
Justin Lebar41094612016-01-11 23:07:27 +00003431 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
Daniel Dunbar65229332009-03-13 11:38:42 +00003432 }
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003433 case phases::Precompile: {
Richard Smithdd4ad3d2016-08-30 19:06:26 +00003434 types::ID OutputTy = getPrecompiledType(Input->getType());
3435 assert(OutputTy != types::TY_INVALID &&
3436 "Cannot precompile this input type!");
Richard Smithcd35eff2018-09-15 01:21:16 +00003437
3438 // If we're given a module name, precompile header file inputs as a
3439 // module, not as a precompiled header.
3440 const char *ModName = nullptr;
3441 if (OutputTy == types::TY_PCH) {
3442 if (Arg *A = Args.getLastArg(options::OPT_fmodule_name_EQ))
3443 ModName = A->getValue();
3444 if (ModName)
3445 OutputTy = types::TY_ModuleFile;
3446 }
3447
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003448 if (Args.hasArg(options::OPT_fsyntax_only)) {
3449 // Syntax checks should not emit a PCH file
3450 OutputTy = types::TY_Nothing;
3451 }
Richard Smithcd35eff2018-09-15 01:21:16 +00003452
3453 if (ModName)
3454 return C.MakeAction<HeaderModulePrecompileJobAction>(Input, OutputTy,
3455 ModName);
Justin Lebar41094612016-01-11 23:07:27 +00003456 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003457 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003458 case phases::Compile: {
David Blaikie486f4402014-08-29 07:25:23 +00003459 if (Args.hasArg(options::OPT_fsyntax_only))
Justin Lebar41094612016-01-11 23:07:27 +00003460 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
David Blaikie486f4402014-08-29 07:25:23 +00003461 if (Args.hasArg(options::OPT_rewrite_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003462 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003463 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003464 return C.MakeAction<CompileJobAction>(Input,
3465 types::TY_RewrittenLegacyObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003466 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
Justin Lebar41094612016-01-11 23:07:27 +00003467 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
David Blaikie486f4402014-08-29 07:25:23 +00003468 if (Args.hasArg(options::OPT__migrate))
Justin Lebar41094612016-01-11 23:07:27 +00003469 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
David Blaikie486f4402014-08-29 07:25:23 +00003470 if (Args.hasArg(options::OPT_emit_ast))
Justin Lebar41094612016-01-11 23:07:27 +00003471 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
David Blaikie486f4402014-08-29 07:25:23 +00003472 if (Args.hasArg(options::OPT_module_file_info))
Justin Lebar41094612016-01-11 23:07:27 +00003473 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
David Blaikie486f4402014-08-29 07:25:23 +00003474 if (Args.hasArg(options::OPT_verify_pch))
Justin Lebar41094612016-01-11 23:07:27 +00003475 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
Puyan Lotfi68f29da2019-06-20 16:59:48 +00003476 if (Args.hasArg(options::OPT_emit_iterface_stubs))
3477 return C.MakeAction<CompileJobAction>(Input, types::TY_IFS);
Justin Lebar41094612016-01-11 23:07:27 +00003478 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
Bob Wilson23a55f12014-12-21 07:00:00 +00003479 }
3480 case phases::Backend: {
Artem Belevichecb178b2018-03-21 22:22:59 +00003481 if (isUsingLTO() && TargetDeviceOffloadKind == Action::OFK_None) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003482 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003483 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003484 return C.MakeAction<BackendJobAction>(Input, Output);
David Blaikie486f4402014-08-29 07:25:23 +00003485 }
3486 if (Args.hasArg(options::OPT_emit_llvm)) {
Shuxin Yang4b3c7ff2013-08-23 21:34:57 +00003487 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003488 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003489 return C.MakeAction<BackendJobAction>(Input, Output);
Daniel Dunbar65229332009-03-13 11:38:42 +00003490 }
Justin Lebar41094612016-01-11 23:07:27 +00003491 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
Daniel Dunbar65229332009-03-13 11:38:42 +00003492 }
3493 case phases::Assemble:
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003494 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
Daniel Dunbar65229332009-03-13 11:38:42 +00003495 }
3496
David Blaikie83d382b2011-09-23 05:06:16 +00003497 llvm_unreachable("invalid phase in ConstructPhaseAction");
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003498}
3499
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00003500void Driver::BuildJobs(Compilation &C) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003501 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003502
3503 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3504
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003505 // It is an error to provide a -o option if we are making multiple output
3506 // files.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003507 if (FinalOutput) {
3508 unsigned NumOutputs = 0;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003509 for (const Action *A : C.getActions())
3510 if (A->getType() != types::TY_Nothing)
Daniel Dunbare75d8342009-03-16 06:56:51 +00003511 ++NumOutputs;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003512
Daniel Dunbare75d8342009-03-16 06:56:51 +00003513 if (NumOutputs > 1) {
3514 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
Craig Topper92fc2df2014-05-17 16:56:41 +00003515 FinalOutput = nullptr;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003516 }
3517 }
3518
Chad Rosier35767232013-04-30 22:01:21 +00003519 // Collect the list of architectures.
3520 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003521 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
3522 for (const Arg *A : C.getArgs())
Chad Rosier35767232013-04-30 22:01:21 +00003523 if (A->getOption().matches(options::OPT_arch))
3524 ArchNames.insert(A->getValue());
Chad Rosier35767232013-04-30 22:01:21 +00003525
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003526 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
3527 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003528 for (Action *A : C.getActions()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003529 // If we are linking an image for multiple archs then the linker wants
3530 // -arch_multiple and -final_output <final image name>. Unfortunately, this
3531 // doesn't fit in cleanly because we have to pass this information down.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003532 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003533 // FIXME: This is a hack; find a cleaner way to integrate this into the
3534 // process.
Craig Topper92fc2df2014-05-17 16:56:41 +00003535 const char *LinkingOutput = nullptr;
Daniel Dunbardd765242009-03-26 16:12:09 +00003536 if (isa<LipoJobAction>(A)) {
Daniel Dunbare75d8342009-03-16 06:56:51 +00003537 if (FinalOutput)
Richard Smithbd55daf2012-11-01 04:30:05 +00003538 LinkingOutput = FinalOutput->getValue();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003539 else
Hans Wennborga7707222015-01-09 17:38:53 +00003540 LinkingOutput = getDefaultImageName();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003541 }
3542
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003543 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003544 /*BoundArch*/ StringRef(),
Daniel Dunbare75d8342009-03-16 06:56:51 +00003545 /*AtTopLevel*/ true,
Chad Rosier35767232013-04-30 22:01:21 +00003546 /*MultipleArchs*/ ArchNames.size() > 1,
Samuel Antaod06239d2016-07-15 23:13:27 +00003547 /*LinkingOutput*/ LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003548 /*TargetDeviceOffloadKind*/ Action::OFK_None);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003549 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003550
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003551 // If the user passed -Qunused-arguments or there were errors, don't warn
3552 // about any unused arguments.
Argyrios Kyrtzidis31448a42010-11-18 21:47:07 +00003553 if (Diags.hasErrorOccurred() ||
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003554 C.getArgs().hasArg(options::OPT_Qunused_arguments))
Daniel Dunbard175d972009-03-18 18:03:46 +00003555 return;
3556
Daniel Dunbar58399ae2009-03-29 22:24:54 +00003557 // Claim -### here.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003558 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003559
Nico Weber47bf5052016-04-25 21:15:49 +00003560 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003561 (void)C.getArgs().hasArg(options::OPT_driver_mode);
Nico Weber47bf5052016-04-25 21:15:49 +00003562 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
Hans Wennborg70850d82013-07-18 20:29:38 +00003563
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003564 for (Arg *A : C.getArgs()) {
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003565 // FIXME: It would be nice to be able to send the argument to the
David Blaikie9c902b52011-09-25 23:23:43 +00003566 // DiagnosticsEngine, so that extra values, position, and so on could be
3567 // printed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003568 if (!A->isClaimed()) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +00003569 if (A->getOption().hasFlag(options::NoArgumentUnused))
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003570 continue;
3571
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003572 // Suppress the warning automatically if this is just a flag, and it is an
3573 // instance of an argument we already claimed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003574 const Option &Opt = A->getOption();
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00003575 if (Opt.getKind() == Option::FlagClass) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003576 bool DuplicateClaimed = false;
3577
Sean Silva14facf32015-06-09 01:57:17 +00003578 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
3579 if (AA->isClaimed()) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003580 DuplicateClaimed = true;
3581 break;
3582 }
3583 }
3584
3585 if (DuplicateClaimed)
3586 continue;
3587 }
3588
Ehsan Akhgarid8518332016-01-25 21:14:52 +00003589 // In clang-cl, don't mention unknown arguments here since they have
3590 // already been warned about.
3591 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
3592 Diag(clang::diag::warn_drv_unused_argument)
3593 << A->getAsString(C.getArgs());
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003594 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003595 }
Daniel Dunbar95e6b192009-03-13 22:12:33 +00003596}
Daniel Dunbarc4343942010-02-03 03:07:56 +00003597
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003598namespace {
3599/// Utility class to control the collapse of dependent actions and select the
3600/// tools accordingly.
3601class ToolSelector final {
3602 /// The tool chain this selector refers to.
3603 const ToolChain &TC;
Daniel Dunbarf9ff3502010-05-14 02:03:00 +00003604
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003605 /// The compilation this selector refers to.
3606 const Compilation &C;
Samuel Antaod06239d2016-07-15 23:13:27 +00003607
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003608 /// The base action this selector refers to.
3609 const JobAction *BaseAction;
Samuel Antaod06239d2016-07-15 23:13:27 +00003610
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003611 /// Set to true if the current toolchain refers to host actions.
3612 bool IsHostSelector;
Samuel Antaod06239d2016-07-15 23:13:27 +00003613
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003614 /// Set to true if save-temps and embed-bitcode functionalities are active.
3615 bool SaveTemps;
3616 bool EmbedBitcode;
3617
3618 /// Get previous dependent action or null if that does not exist. If
3619 /// \a CanBeCollapsed is false, that action must be legal to collapse or
3620 /// null will be returned.
3621 const JobAction *getPrevDependentAction(const ActionList &Inputs,
3622 ActionList &SavedOffloadAction,
3623 bool CanBeCollapsed = true) {
3624 // An option can be collapsed only if it has a single input.
3625 if (Inputs.size() != 1)
Craig Topper92fc2df2014-05-17 16:56:41 +00003626 return nullptr;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003627
3628 Action *CurAction = *Inputs.begin();
3629 if (CanBeCollapsed &&
3630 !CurAction->isCollapsingWithNextDependentActionLegal())
3631 return nullptr;
3632
3633 // If the input action is an offload action. Look through it and save any
3634 // offload action that can be dropped in the event of a collapse.
3635 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
3636 // If the dependent action is a device action, we will attempt to collapse
3637 // only with other device actions. Otherwise, we would do the same but
3638 // with host actions only.
3639 if (!IsHostSelector) {
3640 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
3641 CurAction =
3642 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
3643 if (CanBeCollapsed &&
3644 !CurAction->isCollapsingWithNextDependentActionLegal())
3645 return nullptr;
3646 SavedOffloadAction.push_back(OA);
3647 return dyn_cast<JobAction>(CurAction);
3648 }
3649 } else if (OA->hasHostDependence()) {
3650 CurAction = OA->getHostDependence();
3651 if (CanBeCollapsed &&
3652 !CurAction->isCollapsingWithNextDependentActionLegal())
3653 return nullptr;
3654 SavedOffloadAction.push_back(OA);
3655 return dyn_cast<JobAction>(CurAction);
3656 }
3657 return nullptr;
3658 }
3659
3660 return dyn_cast<JobAction>(CurAction);
3661 }
3662
3663 /// Return true if an assemble action can be collapsed.
3664 bool canCollapseAssembleAction() const {
3665 return TC.useIntegratedAs() && !SaveTemps &&
3666 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
3667 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
3668 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
3669 }
3670
3671 /// Return true if a preprocessor action can be collapsed.
3672 bool canCollapsePreprocessorAction() const {
3673 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
3674 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
3675 !C.getArgs().hasArg(options::OPT_rewrite_objc);
3676 }
3677
3678 /// Struct that relates an action with the offload actions that would be
3679 /// collapsed with it.
3680 struct JobActionInfo final {
3681 /// The action this info refers to.
3682 const JobAction *JA = nullptr;
3683 /// The offload actions we need to take care off if this action is
3684 /// collapsed.
3685 ActionList SavedOffloadAction;
3686 };
3687
3688 /// Append collapsed offload actions from the give nnumber of elements in the
3689 /// action info array.
3690 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
3691 ArrayRef<JobActionInfo> &ActionInfo,
3692 unsigned ElementNum) {
3693 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
3694 for (unsigned I = 0; I < ElementNum; ++I)
3695 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
3696 ActionInfo[I].SavedOffloadAction.end());
3697 }
3698
3699 /// Functions that attempt to perform the combining. They detect if that is
3700 /// legal, and if so they update the inputs \a Inputs and the offload action
3701 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
3702 /// the combined action is returned. If the combining is not legal or if the
3703 /// tool does not exist, null is returned.
3704 /// Currently three kinds of collapsing are supported:
3705 /// - Assemble + Backend + Compile;
3706 /// - Assemble + Backend ;
3707 /// - Backend + Compile.
3708 const Tool *
3709 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003710 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003711 ActionList &CollapsedOffloadAction) {
3712 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
3713 return nullptr;
3714 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3715 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3716 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
3717 if (!AJ || !BJ || !CJ)
3718 return nullptr;
3719
3720 // Get compiler tool.
3721 const Tool *T = TC.SelectTool(*CJ);
3722 if (!T)
3723 return nullptr;
3724
Steven Wu574b0f22016-03-01 01:07:58 +00003725 // When using -fembed-bitcode, it is required to have the same tool (clang)
3726 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
3727 if (EmbedBitcode) {
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003728 const Tool *BT = TC.SelectTool(*BJ);
3729 if (BT == T)
3730 return nullptr;
Steven Wu574b0f22016-03-01 01:07:58 +00003731 }
Bob Wilson23a55f12014-12-21 07:00:00 +00003732
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003733 if (!T->hasIntegratedAssembler())
Bob Wilson23a55f12014-12-21 07:00:00 +00003734 return nullptr;
Samuel Antaod06239d2016-07-15 23:13:27 +00003735
Richard Smithcd35eff2018-09-15 01:21:16 +00003736 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003737 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3738 /*NumElements=*/3);
3739 return T;
3740 }
3741 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003742 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003743 ActionList &CollapsedOffloadAction) {
3744 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
3745 return nullptr;
3746 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3747 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3748 if (!AJ || !BJ)
3749 return nullptr;
3750
3751 // Retrieve the compile job, backend action must always be preceded by one.
3752 ActionList CompileJobOffloadActions;
3753 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
3754 /*CanBeCollapsed=*/false);
3755 if (!AJ || !BJ || !CJ)
3756 return nullptr;
3757
3758 assert(isa<CompileJobAction>(CJ) &&
3759 "Expecting compile job preceding backend job.");
3760
3761 // Get compiler tool.
3762 const Tool *T = TC.SelectTool(*CJ);
3763 if (!T)
3764 return nullptr;
3765
3766 if (!T->hasIntegratedAssembler())
3767 return nullptr;
3768
Richard Smithcd35eff2018-09-15 01:21:16 +00003769 Inputs = BJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003770 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3771 /*NumElements=*/2);
3772 return T;
3773 }
3774 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003775 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003776 ActionList &CollapsedOffloadAction) {
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003777 if (ActionInfo.size() < 2)
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003778 return nullptr;
3779 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3780 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3781 if (!BJ || !CJ)
3782 return nullptr;
3783
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003784 // Check if the initial input (to the compile job or its predessor if one
3785 // exists) is LLVM bitcode. In that case, no preprocessor step is required
3786 // and we can still collapse the compile and backend jobs when we have
3787 // -save-temps. I.e. there is no need for a separate compile job just to
3788 // emit unoptimized bitcode.
3789 bool InputIsBitcode = true;
3790 for (size_t i = 1; i < ActionInfo.size(); i++)
3791 if (ActionInfo[i].JA->getType() != types::TY_LLVM_BC &&
3792 ActionInfo[i].JA->getType() != types::TY_LTO_BC) {
3793 InputIsBitcode = false;
3794 break;
3795 }
3796 if (!InputIsBitcode && !canCollapsePreprocessorAction())
3797 return nullptr;
3798
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003799 // Get compiler tool.
3800 const Tool *T = TC.SelectTool(*CJ);
3801 if (!T)
3802 return nullptr;
3803
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003804 if (T->canEmitIR() && ((SaveTemps && !InputIsBitcode) || EmbedBitcode))
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003805 return nullptr;
3806
Richard Smithcd35eff2018-09-15 01:21:16 +00003807 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003808 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3809 /*NumElements=*/2);
3810 return T;
3811 }
3812
3813 /// Updates the inputs if the obtained tool supports combining with
3814 /// preprocessor action, and the current input is indeed a preprocessor
3815 /// action. If combining results in the collapse of offloading actions, those
3816 /// are appended to \a CollapsedOffloadAction.
Richard Smithcd35eff2018-09-15 01:21:16 +00003817 void combineWithPreprocessor(const Tool *T, ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003818 ActionList &CollapsedOffloadAction) {
3819 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3820 return;
3821
3822 // Attempt to get a preprocessor action dependence.
3823 ActionList PreprocessJobOffloadActions;
Richard Smithcd35eff2018-09-15 01:21:16 +00003824 ActionList NewInputs;
3825 for (Action *A : Inputs) {
3826 auto *PJ = getPrevDependentAction({A}, PreprocessJobOffloadActions);
3827 if (!PJ || !isa<PreprocessJobAction>(PJ)) {
3828 NewInputs.push_back(A);
3829 continue;
3830 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003831
Richard Smithcd35eff2018-09-15 01:21:16 +00003832 // This is legal to combine. Append any offload action we found and add the
3833 // current input to preprocessor inputs.
3834 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3835 PreprocessJobOffloadActions.end());
3836 NewInputs.append(PJ->input_begin(), PJ->input_end());
3837 }
3838 Inputs = NewInputs;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003839 }
3840
3841public:
3842 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3843 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3844 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3845 EmbedBitcode(EmbedBitcode) {
3846 assert(BaseAction && "Invalid base action.");
3847 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3848 }
3849
3850 /// Check if a chain of actions can be combined and return the tool that can
3851 /// handle the combination of actions. The pointer to the current inputs \a
3852 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3853 /// connected to collapsed actions are updated accordingly. The latter enables
3854 /// the caller of the selector to process them afterwards instead of just
3855 /// dropping them. If no suitable tool is found, null will be returned.
Richard Smithcd35eff2018-09-15 01:21:16 +00003856 const Tool *getTool(ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003857 ActionList &CollapsedOffloadAction) {
3858 //
3859 // Get the largest chain of actions that we could combine.
3860 //
3861
3862 SmallVector<JobActionInfo, 5> ActionChain(1);
3863 ActionChain.back().JA = BaseAction;
3864 while (ActionChain.back().JA) {
3865 const Action *CurAction = ActionChain.back().JA;
3866
3867 // Grow the chain by one element.
3868 ActionChain.resize(ActionChain.size() + 1);
3869 JobActionInfo &AI = ActionChain.back();
3870
3871 // Attempt to fill it with the
3872 AI.JA =
3873 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
Daniel Dunbarc4343942010-02-03 03:07:56 +00003874 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003875
3876 // Pop the last action info as it could not be filled.
3877 ActionChain.pop_back();
3878
3879 //
3880 // Attempt to combine actions. If all combining attempts failed, just return
3881 // the tool of the provided action. At the end we attempt to combine the
3882 // action with any preprocessor action it may depend on.
3883 //
3884
3885 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3886 CollapsedOffloadAction);
3887 if (!T)
3888 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3889 if (!T)
3890 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3891 if (!T) {
Richard Smithcd35eff2018-09-15 01:21:16 +00003892 Inputs = BaseAction->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003893 T = TC.SelectTool(*BaseAction);
3894 }
3895
3896 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3897 return T;
Daniel Dunbarc4343942010-02-03 03:07:56 +00003898 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003899};
Daniel Dunbarc4343942010-02-03 03:07:56 +00003900}
3901
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003902/// Return a string that uniquely identifies the result of a job. The bound arch
3903/// is not necessarily represented in the toolchain's triple -- for example,
3904/// armv7 and armv7s both map to the same triple -- so we need both in our map.
3905/// Also, we need to add the offloading device kind, as the same tool chain can
3906/// be used for host and device for some programming models, e.g. OpenMP.
3907static std::string GetTriplePlusArchString(const ToolChain *TC,
3908 StringRef BoundArch,
3909 Action::OffloadKind OffloadKind) {
Justin Lebar55c83322016-01-16 03:30:08 +00003910 std::string TriplePlusArch = TC->getTriple().normalize();
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003911 if (!BoundArch.empty()) {
Justin Lebar55c83322016-01-16 03:30:08 +00003912 TriplePlusArch += "-";
3913 TriplePlusArch += BoundArch;
3914 }
Samuel Antao59efaed2016-10-27 17:31:22 +00003915 TriplePlusArch += "-";
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003916 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3917 return TriplePlusArch;
3918}
3919
3920InputInfo Driver::BuildJobsForAction(
3921 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3922 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3923 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3924 Action::OffloadKind TargetDeviceOffloadKind) const {
3925 std::pair<const Action *, std::string> ActionTC = {
3926 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003927 auto CachedResult = CachedResults.find(ActionTC);
3928 if (CachedResult != CachedResults.end()) {
3929 return CachedResult->second;
3930 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003931 InputInfo Result = BuildJobsForActionNoCache(
3932 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003933 CachedResults, TargetDeviceOffloadKind);
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003934 CachedResults[ActionTC] = Result;
3935 return Result;
3936}
3937
3938InputInfo Driver::BuildJobsForActionNoCache(
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003939 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003940 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
Samuel Antaod06239d2016-07-15 23:13:27 +00003941 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003942 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003943 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbarc4acf9d2009-03-18 23:18:19 +00003944
Samuel Antaod06239d2016-07-15 23:13:27 +00003945 InputInfoList OffloadDependencesInputInfo;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003946 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
Samuel Antaod06239d2016-07-15 23:13:27 +00003947 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
Alex Lorenz4003a982017-08-08 11:22:21 +00003948 // The 'Darwin' toolchain is initialized only when its arguments are
3949 // computed. Get the default arguments for OFK_None to ensure that
3950 // initialization is performed before processing the offload action.
3951 // FIXME: Remove when darwin's toolchain is initialized during construction.
3952 C.getArgsForToolChain(TC, BoundArch, Action::OFK_None);
3953
Samuel Antaod06239d2016-07-15 23:13:27 +00003954 // The offload action is expected to be used in four different situations.
3955 //
3956 // a) Set a toolchain/architecture/kind for a host action:
3957 // Host Action 1 -> OffloadAction -> Host Action 2
3958 //
3959 // b) Set a toolchain/architecture/kind for a device action;
3960 // Device Action 1 -> OffloadAction -> Device Action 2
3961 //
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003962 // c) Specify a device dependence to a host action;
Samuel Antaod06239d2016-07-15 23:13:27 +00003963 // Device Action 1 _
3964 // \
3965 // Host Action 1 ---> OffloadAction -> Host Action 2
3966 //
3967 // d) Specify a host dependence to a device action.
3968 // Host Action 1 _
3969 // \
3970 // Device Action 1 ---> OffloadAction -> Device Action 2
3971 //
3972 // For a) and b), we just return the job generated for the dependence. For
3973 // c) and d) we override the current action with the host/device dependence
3974 // if the current toolchain is host/device and set the offload dependences
3975 // info with the jobs obtained from the device/host dependence(s).
3976
3977 // If there is a single device option, just generate the job for it.
3978 if (OA->hasSingleDeviceDependence()) {
3979 InputInfo DevA;
3980 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3981 const char *DepBoundArch) {
3982 DevA =
3983 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3984 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003985 CachedResults, DepA->getOffloadingDeviceKind());
Samuel Antaod06239d2016-07-15 23:13:27 +00003986 });
3987 return DevA;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003988 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003989
3990 // If 'Action 2' is host, we generate jobs for the device dependences and
3991 // override the current action with the host dependence. Otherwise, we
3992 // generate the host dependences and override the action with the device
3993 // dependence. The dependences can't therefore be a top-level action.
3994 OA->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003995 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003996 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3997 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3998 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3999 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004000 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00004001 });
4002
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004003 A = BuildingForOffloadDevice
Samuel Antaod06239d2016-07-15 23:13:27 +00004004 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
4005 : OA->getHostDependence();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00004006 }
4007
Daniel Dunbare75d8342009-03-16 06:56:51 +00004008 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004009 // FIXME: It would be nice to not claim this here; maybe the old scheme of
4010 // just using Args was better?
Daniel Dunbar5cdf3e02009-03-19 07:29:38 +00004011 const Arg &Input = IA->getInputArg();
4012 Input.claim();
Daniel Dunbar35cbfeb2010-06-09 22:31:08 +00004013 if (Input.getOption().matches(options::OPT_INPUT)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00004014 const char *Name = Input.getValue();
Justin Lebard98cea82016-01-11 23:15:21 +00004015 return InputInfo(A, Name, /* BaseInput = */ Name);
Douglas Katzman678d0cb2015-06-16 18:01:24 +00004016 }
Justin Lebard98cea82016-01-11 23:15:21 +00004017 return InputInfo(A, &Input, /* BaseInput = */ "");
Daniel Dunbare75d8342009-03-16 06:56:51 +00004018 }
4019
4020 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
Chad Rosiera78a6eb2012-04-27 16:50:38 +00004021 const ToolChain *TC;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004022 StringRef ArchName = BAA->getArchName();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00004023
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004024 if (!ArchName.empty())
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00004025 TC = &getToolChain(C.getArgs(),
Petr Hosekdd38d932018-05-29 22:35:39 +00004026 computeTargetTriple(*this, TargetTriple,
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00004027 C.getArgs(), ArchName));
Chad Rosiera78a6eb2012-04-27 16:50:38 +00004028 else
4029 TC = &C.getDefaultToolChain();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00004030
Nico Weber5a459f82016-02-23 19:30:43 +00004031 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00004032 MultipleArchs, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004033 TargetDeviceOffloadKind);
Daniel Dunbare75d8342009-03-16 06:56:51 +00004034 }
4035
Artem Belevich0ff05cd2015-07-13 23:27:56 +00004036
Richard Smithcd35eff2018-09-15 01:21:16 +00004037 ActionList Inputs = A->getInputs();
Daniel Dunbarc4343942010-02-03 03:07:56 +00004038
4039 const JobAction *JA = cast<JobAction>(A);
Samuel Antaod06239d2016-07-15 23:13:27 +00004040 ActionList CollapsedOffloadActions;
4041
Mehdi Amini6683e222017-01-24 18:12:25 +00004042 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
4043 embedBitcodeInObject() && !isUsingLTO());
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00004044 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
4045
Rafael Espindola79764462013-03-24 15:06:53 +00004046 if (!T)
Justin Lebar9eaa4892016-01-11 23:09:32 +00004047 return InputInfo();
Daniel Dunbare75d8342009-03-16 06:56:51 +00004048
Samuel Antaod06239d2016-07-15 23:13:27 +00004049 // If we've collapsed action list that contained OffloadAction we
4050 // need to build jobs for host/device-side inputs it may have held.
4051 for (const auto *OA : CollapsedOffloadActions)
4052 cast<OffloadAction>(OA)->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004053 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00004054 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
4055 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
Artem Belevichbee2f412016-08-22 18:50:34 +00004056 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
Samuel Antaod06239d2016-07-15 23:13:27 +00004057 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004058 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00004059 });
Artem Belevichf8144ab2015-08-27 18:10:41 +00004060
Daniel Dunbare75d8342009-03-16 06:56:51 +00004061 // Only use pipes when there is exactly one input.
Daniel Dunbar1a093d22009-03-18 06:00:36 +00004062 InputInfoList InputInfos;
Richard Smithcd35eff2018-09-15 01:21:16 +00004063 for (const Action *Input : Inputs) {
Eric Christopher14668dd2013-02-18 00:38:25 +00004064 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
4065 // shouldn't get temporary output names.
Daniel Dunbar6beaf512010-06-04 18:28:41 +00004066 // FIXME: Clean this up.
Justin Lebar9eaa4892016-01-11 23:09:32 +00004067 bool SubJobAtTopLevel =
4068 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
Samuel Antaod06239d2016-07-15 23:13:27 +00004069 InputInfos.push_back(BuildJobsForAction(
4070 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004071 CachedResults, A->getOffloadingDeviceKind()));
Daniel Dunbare75d8342009-03-16 06:56:51 +00004072 }
4073
Daniel Dunbare75d8342009-03-16 06:56:51 +00004074 // Always use the first input as the base input.
4075 const char *BaseInput = InputInfos[0].getBaseInput();
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004076
Daniel Dunbar6beaf512010-06-04 18:28:41 +00004077 // ... except dsymutil actions, which use their actual input as the base
4078 // input.
4079 if (JA->getType() == types::TY_dSYM)
4080 BaseInput = InputInfos[0].getFilename();
4081
Richard Smithcd35eff2018-09-15 01:21:16 +00004082 // ... and in header module compilations, which use the module name.
4083 if (auto *ModuleJA = dyn_cast<HeaderModulePrecompileJobAction>(JA))
4084 BaseInput = ModuleJA->getModuleName();
4085
Samuel Antaod06239d2016-07-15 23:13:27 +00004086 // Append outputs of offload device jobs to the input list
4087 if (!OffloadDependencesInputInfo.empty())
4088 InputInfos.append(OffloadDependencesInputInfo.begin(),
4089 OffloadDependencesInputInfo.end());
Artem Belevich0ff05cd2015-07-13 23:27:56 +00004090
Vedant Kumar18286cf2016-07-27 23:02:20 +00004091 // Set the effective triple of the toolchain for the duration of this job.
4092 llvm::Triple EffectiveTriple;
4093 const ToolChain &ToolTC = T->getToolChain();
Samuel Antao31fef982016-10-27 17:39:44 +00004094 const ArgList &Args =
4095 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
Vedant Kumar18286cf2016-07-27 23:02:20 +00004096 if (InputInfos.size() != 1) {
4097 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
4098 } else {
4099 // Pass along the input type if it can be unambiguously determined.
4100 EffectiveTriple = llvm::Triple(
4101 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
4102 }
4103 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
4104
Daniel Dunbard00272f2010-08-02 02:38:15 +00004105 // Determine the place to write output to, if any.
Justin Lebar9eaa4892016-01-11 23:09:32 +00004106 InputInfo Result;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004107 InputInfoList UnbundlingResults;
4108 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
4109 // If we have an unbundling job, we need to create results for all the
4110 // outputs. We also update the results cache so that other actions using
4111 // this unbundling action can get the right results.
4112 for (auto &UI : UA->getDependentActionsInfo()) {
4113 assert(UI.DependentOffloadKind != Action::OFK_None &&
4114 "Unbundling with no offloading??");
4115
4116 // Unbundling actions are never at the top level. When we generate the
4117 // offloading prefix, we also do that for the host file because the
4118 // unbundling action does not change the type of the output which can
4119 // cause a overwrite.
4120 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4121 UI.DependentOffloadKind,
4122 UI.DependentToolChain->getTriple().normalize(),
4123 /*CreatePrefixForHost=*/true);
4124 auto CurI = InputInfo(
Yaxun Liu609f7522018-05-11 19:02:18 +00004125 UA,
4126 GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
4127 /*AtTopLevel=*/false,
4128 MultipleArchs ||
4129 UI.DependentOffloadKind == Action::OFK_HIP,
4130 OffloadingPrefix),
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004131 BaseInput);
4132 // Save the unbundling result.
4133 UnbundlingResults.push_back(CurI);
4134
4135 // Get the unique string identifier for this dependence and cache the
4136 // result.
Yaxun Liu470b8332018-06-06 19:44:10 +00004137 StringRef Arch;
4138 if (TargetDeviceOffloadKind == Action::OFK_HIP) {
4139 if (UI.DependentOffloadKind == Action::OFK_Host)
Yaxun Liuf37b50a2018-07-24 01:03:44 +00004140 Arch = StringRef();
Yaxun Liu470b8332018-06-06 19:44:10 +00004141 else
4142 Arch = UI.DependentBoundArch;
4143 } else
4144 Arch = BoundArch;
4145
4146 CachedResults[{A, GetTriplePlusArchString(UI.DependentToolChain, Arch,
4147 UI.DependentOffloadKind)}] =
4148 CurI;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004149 }
4150
4151 // Now that we have all the results generated, select the one that should be
4152 // returned for the current depending action.
4153 std::pair<const Action *, std::string> ActionTC = {
4154 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
4155 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
4156 "Result does not exist??");
4157 Result = CachedResults[ActionTC];
4158 } else if (JA->getType() == types::TY_Nothing)
Justin Lebard98cea82016-01-11 23:15:21 +00004159 Result = InputInfo(A, BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004160 else {
4161 // We only have to generate a prefix for the host if this is not a top-level
4162 // action.
4163 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4164 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
4165 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
4166 !AtTopLevel);
Justin Lebard98cea82016-01-11 23:15:21 +00004167 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
Samuel Antaod06239d2016-07-15 23:13:27 +00004168 AtTopLevel, MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004169 OffloadingPrefix),
Justin Lebard98cea82016-01-11 23:15:21 +00004170 BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004171 }
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004172
Chad Rosierbe10f982011-08-02 17:58:04 +00004173 if (CCCPrintBindings && !CCGenDiagnostics) {
Rafael Espindola79764462013-03-24 15:06:53 +00004174 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
4175 << " - \"" << T->getName() << "\", inputs: [";
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004176 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
4177 llvm::errs() << InputInfos[i].getAsString();
4178 if (i + 1 != e)
4179 llvm::errs() << ", ";
4180 }
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004181 if (UnbundlingResults.empty())
4182 llvm::errs() << "], output: " << Result.getAsString() << "\n";
4183 else {
4184 llvm::errs() << "], outputs: [";
4185 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
4186 llvm::errs() << UnbundlingResults[i].getAsString();
4187 if (i + 1 != e)
4188 llvm::errs() << ", ";
4189 }
4190 llvm::errs() << "] \n";
4191 }
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004192 } else {
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004193 if (UnbundlingResults.empty())
4194 T->ConstructJob(
4195 C, *JA, Result, InputInfos,
4196 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4197 LinkingOutput);
4198 else
Samuel Antao7108bf32016-11-03 15:41:50 +00004199 T->ConstructJobMultipleOutputs(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004200 C, *JA, UnbundlingResults, InputInfos,
4201 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4202 LinkingOutput);
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004203 }
Justin Lebar9eaa4892016-01-11 23:09:32 +00004204 return Result;
Daniel Dunbare75d8342009-03-16 06:56:51 +00004205}
4206
Hans Wennborga7707222015-01-09 17:38:53 +00004207const char *Driver::getDefaultImageName() const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004208 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Hans Wennborga7707222015-01-09 17:38:53 +00004209 return Target.isOSWindows() ? "a.exe" : "a.out";
4210}
4211
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004212/// Create output filename based on ArgValue, which could either be a
Hans Wennborg2c21f742013-10-17 16:16:23 +00004213/// full filename, filename without extension, or a directory. If ArgValue
4214/// does not provide a filename, then use BaseName, and use the extension
4215/// suitable for FileType.
Hans Wennborg207fcf02013-08-12 21:56:42 +00004216static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004217 StringRef BaseName,
4218 types::ID FileType) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004219 SmallString<128> Filename = ArgValue;
Justin Bogner5aaf2e72014-06-26 20:59:36 +00004220
Hans Wennborgf1a74252013-09-10 20:18:04 +00004221 if (ArgValue.empty()) {
4222 // If the argument is empty, output to BaseName in the current dir.
4223 Filename = BaseName;
4224 } else if (llvm::sys::path::is_separator(Filename.back())) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004225 // If the argument is a directory, output to BaseName in that dir.
4226 llvm::sys::path::append(Filename, BaseName);
4227 }
4228
4229 if (!llvm::sys::path::has_extension(ArgValue)) {
4230 // If the argument didn't provide an extension, then set it.
4231 const char *Extension = types::getTypeTempSuffix(FileType, true);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004232
4233 if (FileType == types::TY_Image &&
4234 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
4235 // The output file is a dll.
4236 Extension = "dll";
4237 }
4238
Hans Wennborg207fcf02013-08-12 21:56:42 +00004239 llvm::sys::path::replace_extension(Filename, Extension);
4240 }
4241
4242 return Args.MakeArgString(Filename.c_str());
4243}
4244
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004245const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004246 const char *BaseInput,
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004247 StringRef BoundArch, bool AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00004248 bool MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004249 StringRef OffloadingPrefix) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00004250 llvm::PrettyStackTraceString CrashInfo("Computing output path");
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004251 // Output to a user requested destination?
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004252 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004253 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
Chad Rosier633dcdc2013-01-24 19:14:47 +00004254 return C.addResultFile(FinalOutput->getValue(), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004255 }
4256
Hans Wennborge0053472013-12-20 18:40:46 +00004257 // For /P, preprocess to file named after BaseInput.
4258 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
4259 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
4260 StringRef BaseName = llvm::sys::path::filename(BaseInput);
Hans Wennborg04c764f2014-06-17 00:19:12 +00004261 StringRef NameArg;
Greg Bedwell065f70a2015-06-09 10:24:06 +00004262 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
Hans Wennborg04c764f2014-06-17 00:19:12 +00004263 NameArg = A->getValue();
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004264 return C.addResultFile(
4265 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
4266 &JA);
Hans Wennborge0053472013-12-20 18:40:46 +00004267 }
4268
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004269 // Default to writing to stdout?
David Blaikiebc023c92018-06-14 23:09:06 +00004270 if (AtTopLevel && !CCGenDiagnostics && isa<PreprocessJobAction>(JA))
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004271 return "-";
4272
Hans Wennborg2c21f742013-10-17 16:16:23 +00004273 // Is this the assembly listing for /FA?
4274 if (JA.getType() == types::TY_PP_Asm &&
4275 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
4276 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
4277 // Use /Fa and the input filename to determine the asm file name.
4278 StringRef BaseName = llvm::sys::path::filename(BaseInput);
4279 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004280 return C.addResultFile(
4281 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
4282 &JA);
Hans Wennborg2c21f742013-10-17 16:16:23 +00004283 }
4284
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004285 // Output to a temporary file?
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004286 if ((!AtTopLevel && !isSaveTempsEnabled() &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004287 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
Chad Rosierbe10f982011-08-02 17:58:04 +00004288 CCGenDiagnostics) {
Chad Rosier97c37372011-08-26 22:27:02 +00004289 StringRef Name = llvm::sys::path::filename(BaseInput);
4290 std::pair<StringRef, StringRef> Split = Name.split('.');
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004291 SmallString<128> TmpName;
4292 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
4293 Arg *A = C.getArgs().getLastArg(options::OPT_fcrash_diagnostics_dir);
4294 if (CCGenDiagnostics && A) {
4295 SmallString<128> CrashDirectory(A->getValue());
Petr Hosek1e393062019-05-04 00:55:14 +00004296 if (!getVFS().exists(CrashDirectory))
4297 llvm::sys::fs::create_directories(CrashDirectory);
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004298 llvm::sys::path::append(CrashDirectory, Split.first);
4299 const char *Middle = Suffix ? "-%%%%%%." : "-%%%%%%";
Simon Atanasyan27c0f202019-04-02 18:03:15 +00004300 std::error_code EC = llvm::sys::fs::createUniqueFile(
4301 CrashDirectory + Middle + Suffix, TmpName);
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004302 if (EC) {
4303 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4304 return "";
4305 }
4306 } else {
4307 TmpName = GetTemporaryPath(Split.first, Suffix);
4308 }
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004309 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004310 }
4311
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004312 SmallString<128> BasePath(BaseInput);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004313 StringRef BaseName;
Daniel Dunbar67fea712011-03-25 18:16:51 +00004314
4315 // Dsymutil actions should use the full path.
Eric Christopher551ef452011-08-23 17:56:55 +00004316 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
Daniel Dunbar67fea712011-03-25 18:16:51 +00004317 BaseName = BasePath;
4318 else
4319 BaseName = llvm::sys::path::filename(BasePath);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004320
4321 // Determine what the derived output name should be.
4322 const char *NamedOutput;
Hans Wennborg2b89a262013-08-06 22:11:28 +00004323
Hans Wennborg625fba82016-10-04 21:01:04 +00004324 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004325 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
4326 // The /Fo or /o flag decides the object filename.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004327 StringRef Val =
4328 C.getArgs()
4329 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
4330 ->getValue();
4331 NamedOutput =
4332 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
Hans Wennborg207fcf02013-08-12 21:56:42 +00004333 } else if (JA.getType() == types::TY_Image &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004334 C.getArgs().hasArg(options::OPT__SLASH_Fe,
4335 options::OPT__SLASH_o)) {
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004336 // The /Fe or /o flag names the linked file.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004337 StringRef Val =
4338 C.getArgs()
4339 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
4340 ->getValue();
4341 NamedOutput =
4342 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004343 } else if (JA.getType() == types::TY_Image) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004344 if (IsCLMode()) {
4345 // clang-cl uses BaseName for the executable name.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004346 NamedOutput =
4347 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
Samuel Antao59efaed2016-10-27 17:31:22 +00004348 } else {
Hans Wennborga7707222015-01-09 17:38:53 +00004349 SmallString<128> Output(getDefaultImageName());
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004350 Output += OffloadingPrefix;
Samuel Antao59efaed2016-10-27 17:31:22 +00004351 if (MultipleArchs && !BoundArch.empty()) {
4352 Output += "-";
4353 Output.append(BoundArch);
4354 }
Chad Rosier35767232013-04-30 22:01:21 +00004355 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
Nico Weber2ca4be92016-03-01 23:16:44 +00004356 }
4357 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004358 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004359 } else {
Hans Wennborg0a096a02013-09-05 17:05:56 +00004360 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004361 assert(Suffix && "All types used for output should have a suffix.");
4362
4363 std::string::size_type End = std::string::npos;
4364 if (!types::appendSuffixForType(JA.getType()))
4365 End = BaseName.rfind('.');
Chad Rosier35767232013-04-30 22:01:21 +00004366 SmallString<128> Suffixed(BaseName.substr(0, End));
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004367 Suffixed += OffloadingPrefix;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004368 if (MultipleArchs && !BoundArch.empty()) {
Chad Rosier35767232013-04-30 22:01:21 +00004369 Suffixed += "-";
4370 Suffixed.append(BoundArch);
4371 }
Bob Wilson23a55f12014-12-21 07:00:00 +00004372 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
4373 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
4374 // optimized bitcode output.
4375 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
4376 JA.getType() == types::TY_LLVM_BC)
4377 Suffixed += ".tmp";
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004378 Suffixed += '.';
4379 Suffixed += Suffix;
4380 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
4381 }
4382
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004383 // Prepend object file path if -save-temps=obj
4384 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
4385 JA.getType() != types::TY_PCH) {
4386 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
4387 SmallString<128> TempPath(FinalOutput->getValue());
4388 llvm::sys::path::remove_filename(TempPath);
4389 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
4390 llvm::sys::path::append(TempPath, OutputFileName);
4391 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
4392 }
4393
Chad Rosier62135492012-07-09 17:31:28 +00004394 // If we're saving temps and the temp file conflicts with the input file,
Chad Rosier5b58af02012-04-20 20:05:08 +00004395 // then avoid overwriting input file.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004396 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
Chad Rosier5b58af02012-04-20 20:05:08 +00004397 bool SameFile = false;
4398 SmallString<256> Result;
4399 llvm::sys::fs::current_path(Result);
4400 llvm::sys::path::append(Result, BaseName);
4401 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
4402 // Must share the same path to conflict.
4403 if (SameFile) {
4404 StringRef Name = llvm::sys::path::filename(BaseInput);
4405 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004406 std::string TmpName = GetTemporaryPath(
4407 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004408 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Chad Rosier5b58af02012-04-20 20:05:08 +00004409 }
Chad Rosierf8412cd2011-07-15 21:54:29 +00004410 }
4411
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004412 // As an annoying special case, PCH generation doesn't strip the pathname.
Nico Weber8ab92192016-03-02 23:29:29 +00004413 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
Michael J. Spencere1696752010-12-18 00:19:12 +00004414 llvm::sys::path::remove_filename(BasePath);
4415 if (BasePath.empty())
Daniel Dunbare6c83192009-03-18 09:58:30 +00004416 BasePath = NamedOutput;
4417 else
Michael J. Spencere1696752010-12-18 00:19:12 +00004418 llvm::sys::path::append(BasePath, NamedOutput);
Chad Rosier633dcdc2013-01-24 19:14:47 +00004419 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004420 } else {
Chad Rosier633dcdc2013-01-24 19:14:47 +00004421 return C.addResultFile(NamedOutput, &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004422 }
4423}
4424
Mehdi Amini12011172016-10-06 05:11:48 +00004425std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
Raphael Isemannb23ccec2018-12-10 12:37:46 +00004426 // Search for Name in a list of paths.
Petr Hosek8f2499f2018-09-12 03:26:10 +00004427 auto SearchPaths = [&](const llvm::SmallVectorImpl<std::string> &P)
4428 -> llvm::Optional<std::string> {
4429 // Respect a limited subset of the '-Bprefix' functionality in GCC by
4430 // attempting to use this prefix when looking for file paths.
4431 for (const auto &Dir : P) {
4432 if (Dir.empty())
4433 continue;
4434 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
4435 llvm::sys::path::append(P, Name);
4436 if (llvm::sys::fs::exists(Twine(P)))
Simon Pilgrim4588fc82018-09-13 10:10:18 +00004437 return P.str().str();
Petr Hosek8f2499f2018-09-12 03:26:10 +00004438 }
4439 return None;
4440 };
4441
4442 if (auto P = SearchPaths(PrefixDirs))
4443 return *P;
Chandler Carruth84559242010-03-22 01:52:07 +00004444
Petr Hosek916a4672017-08-10 04:16:38 +00004445 SmallString<128> R(ResourceDir);
4446 llvm::sys::path::append(R, Name);
4447 if (llvm::sys::fs::exists(Twine(R)))
4448 return R.str();
4449
4450 SmallString<128> P(TC.getCompilerRTPath());
Rafael Espindola609a6642013-06-24 18:33:43 +00004451 llvm::sys::path::append(P, Name);
4452 if (llvm::sys::fs::exists(Twine(P)))
Peter Collingbournefa9771f2011-09-06 02:08:31 +00004453 return P.str();
4454
Petr Hosek92d706e2019-05-29 00:01:05 +00004455 SmallString<128> D(Dir);
4456 llvm::sys::path::append(D, "..", Name);
4457 if (llvm::sys::fs::exists(Twine(D)))
4458 return D.str();
4459
Petr Hosek8f2499f2018-09-12 03:26:10 +00004460 if (auto P = SearchPaths(TC.getLibraryPaths()))
4461 return *P;
4462
4463 if (auto P = SearchPaths(TC.getFilePaths()))
4464 return *P;
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004465
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004466 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004467}
4468
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004469void Driver::generatePrefixedToolNames(
Mehdi Amini12011172016-10-06 05:11:48 +00004470 StringRef Tool, const ToolChain &TC,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004471 SmallVectorImpl<std::string> &Names) const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004472 // FIXME: Needs a better variable than TargetTriple
4473 Names.emplace_back((TargetTriple + "-" + Tool).str());
Benjamin Kramer3204b152015-05-29 19:42:19 +00004474 Names.emplace_back(Tool);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004475
4476 // Allow the discovery of tools prefixed with LLVM's default target triple.
Petr Hosekdd38d932018-05-29 22:35:39 +00004477 std::string DefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
4478 if (DefaultTargetTriple != TargetTriple)
4479 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004480}
4481
Benjamin Kramer7111b912014-11-04 20:26:01 +00004482static bool ScanDirForExecutable(SmallString<128> &Dir,
4483 ArrayRef<std::string> Names) {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004484 for (const auto &Name : Names) {
4485 llvm::sys::path::append(Dir, Name);
4486 if (llvm::sys::fs::can_execute(Twine(Dir)))
4487 return true;
4488 llvm::sys::path::remove_filename(Dir);
4489 }
4490 return false;
4491}
4492
Mehdi Amini12011172016-10-06 05:11:48 +00004493std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004494 SmallVector<std::string, 2> TargetSpecificExecutables;
4495 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
4496
Chandler Carruth84559242010-03-22 01:52:07 +00004497 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00004498 // attempting to use this prefix when looking for program paths.
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004499 for (const auto &PrefixDir : PrefixDirs) {
4500 if (llvm::sys::fs::is_directory(PrefixDir)) {
4501 SmallString<128> P(PrefixDir);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004502 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004503 return P.str();
Simon Atanasyana47ba292012-10-31 14:39:28 +00004504 } else {
Mehdi Amini12011172016-10-06 05:11:48 +00004505 SmallString<128> P((PrefixDir + Name).str());
Rafael Espindola609a6642013-06-24 18:33:43 +00004506 if (llvm::sys::fs::can_execute(Twine(P)))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004507 return P.str();
Simon Atanasyan86bdab72012-10-31 12:01:53 +00004508 }
Chandler Carruth84559242010-03-22 01:52:07 +00004509 }
4510
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004511 const ToolChain::path_list &List = TC.getProgramPaths();
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004512 for (const auto &Path : List) {
4513 SmallString<128> P(Path);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004514 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004515 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004516 }
4517
Daniel Dunbar76ce7412009-03-23 16:15:50 +00004518 // If all else failed, search the path.
Michael J. Spencerb011d482014-11-07 21:30:32 +00004519 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
4520 if (llvm::ErrorOr<std::string> P =
4521 llvm::sys::findProgramByName(TargetSpecificExecutable))
Michael J. Spencer04162ea2014-11-04 01:30:55 +00004522 return *P;
Daniel Dunbar6f668772009-03-18 21:34:08 +00004523
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004524 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004525}
4526
Mehdi Amini12011172016-10-06 05:11:48 +00004527std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
Rafael Espindola37d229d2013-06-25 04:26:55 +00004528 SmallString<128> Path;
Rafael Espindolac0809172014-06-12 14:02:15 +00004529 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
Rafael Espindola37d229d2013-06-25 04:26:55 +00004530 if (EC) {
4531 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004532 return "";
4533 }
4534
Rafael Espindola37d229d2013-06-25 04:26:55 +00004535 return Path.str();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004536}
4537
Steven Wuc3399db62019-01-11 21:16:04 +00004538std::string Driver::GetTemporaryDirectory(StringRef Prefix) const {
4539 SmallString<128> Path;
4540 std::error_code EC = llvm::sys::fs::createUniqueDirectory(Prefix, Path);
4541 if (EC) {
4542 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4543 return "";
4544 }
4545
4546 return Path.str();
4547}
4548
Nico Weber2ca4be92016-03-01 23:16:44 +00004549std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
4550 SmallString<128> Output;
4551 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
4552 // FIXME: If anybody needs it, implement this obscure rule:
4553 // "If you specify a directory without a file name, the default file name
4554 // is VCx0.pch., where x is the major version of Visual C++ in use."
4555 Output = FpArg->getValue();
4556
4557 // "If you do not specify an extension as part of the path name, an
4558 // extension of .pch is assumed. "
4559 if (!llvm::sys::path::has_extension(Output))
4560 Output += ".pch";
4561 } else {
Mike Rice58df1af2018-09-11 17:10:44 +00004562 if (Arg *YcArg = C.getArgs().getLastArg(options::OPT__SLASH_Yc))
4563 Output = YcArg->getValue();
4564 if (Output.empty())
4565 Output = BaseName;
Nico Weber2ca4be92016-03-01 23:16:44 +00004566 llvm::sys::path::replace_extension(Output, ".pch");
4567 }
4568 return Output.str();
4569}
4570
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004571const ToolChain &Driver::getToolChain(const ArgList &Args,
Artem Belevich959e0542015-07-10 19:47:55 +00004572 const llvm::Triple &Target) const {
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004573
David Blaikie6ad71012017-01-13 18:53:43 +00004574 auto &TC = ToolChains[Target.str()];
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004575 if (!TC) {
4576 switch (Target.getOS()) {
Reid Kleckner330fb172016-05-11 16:19:05 +00004577 case llvm::Triple::Haiku:
David Blaikie6ad71012017-01-13 18:53:43 +00004578 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
Reid Kleckner330fb172016-05-11 16:19:05 +00004579 break;
Ed Schouten4dabea22017-06-25 08:29:09 +00004580 case llvm::Triple::Ananas:
4581 TC = llvm::make_unique<toolchains::Ananas>(*this, Target, Args);
4582 break;
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004583 case llvm::Triple::CloudABI:
David Blaikie6ad71012017-01-13 18:53:43 +00004584 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004585 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004586 case llvm::Triple::Darwin:
4587 case llvm::Triple::MacOSX:
4588 case llvm::Triple::IOS:
Tim Northover6f3ff222015-10-30 16:30:27 +00004589 case llvm::Triple::TvOS:
4590 case llvm::Triple::WatchOS:
David Blaikie6ad71012017-01-13 18:53:43 +00004591 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004592 break;
4593 case llvm::Triple::DragonFly:
David Blaikie6ad71012017-01-13 18:53:43 +00004594 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004595 break;
4596 case llvm::Triple::OpenBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004597 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004598 break;
4599 case llvm::Triple::NetBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004600 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004601 break;
4602 case llvm::Triple::FreeBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004603 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004604 break;
4605 case llvm::Triple::Minix:
David Blaikie6ad71012017-01-13 18:53:43 +00004606 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004607 break;
4608 case llvm::Triple::Linux:
Andrey Turetskiy4798eb62016-06-16 10:36:09 +00004609 case llvm::Triple::ELFIAMCU:
Chandler Carruthcf705b22012-01-25 21:03:58 +00004610 if (Target.getArch() == llvm::Triple::hexagon)
David Blaikie6ad71012017-01-13 18:53:43 +00004611 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4612 Args);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004613 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
4614 !Target.hasEnvironment())
David Blaikie6ad71012017-01-13 18:53:43 +00004615 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
4616 Args);
Qiu Chaofan19828e32019-04-23 05:50:24 +00004617 else if (Target.getArch() == llvm::Triple::ppc ||
4618 Target.getArch() == llvm::Triple::ppc64 ||
4619 Target.getArch() == llvm::Triple::ppc64le)
4620 TC = llvm::make_unique<toolchains::PPCLinuxToolChain>(*this, Target,
4621 Args);
Chandler Carruthcf705b22012-01-25 21:03:58 +00004622 else
David Blaikie6ad71012017-01-13 18:53:43 +00004623 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004624 break;
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004625 case llvm::Triple::NaCl:
David Blaikie6ad71012017-01-13 18:53:43 +00004626 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004627 break;
Petr Hosek62e1d232016-10-06 06:08:09 +00004628 case llvm::Triple::Fuchsia:
David Blaikie6ad71012017-01-13 18:53:43 +00004629 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
Petr Hosek62e1d232016-10-06 06:08:09 +00004630 break;
David Chisnallf571cde2012-02-15 13:39:01 +00004631 case llvm::Triple::Solaris:
David Blaikie6ad71012017-01-13 18:53:43 +00004632 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
David Chisnallf571cde2012-02-15 13:39:01 +00004633 break;
Tom Stellard8fa33092015-07-18 01:49:05 +00004634 case llvm::Triple::AMDHSA:
Matt Arsenault5d0bebc2019-06-14 13:39:57 +00004635 case llvm::Triple::AMDPAL:
4636 case llvm::Triple::Mesa3D:
David Blaikie6ad71012017-01-13 18:53:43 +00004637 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
Tom Stellard8fa33092015-07-18 01:49:05 +00004638 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004639 case llvm::Triple::Win32:
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004640 switch (Target.getEnvironment()) {
4641 default:
4642 if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004643 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004644 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004645 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004646 else
David Blaikie6ad71012017-01-13 18:53:43 +00004647 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004648 break;
4649 case llvm::Triple::GNU:
David Blaikie6ad71012017-01-13 18:53:43 +00004650 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004651 break;
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004652 case llvm::Triple::Itanium:
David Blaikie6ad71012017-01-13 18:53:43 +00004653 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
4654 Args);
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004655 break;
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004656 case llvm::Triple::MSVC:
4657 case llvm::Triple::UnknownEnvironment:
Dave Leef96bedf2017-11-06 21:18:05 +00004658 if (Args.getLastArgValue(options::OPT_fuse_ld_EQ)
4659 .startswith_lower("bfd"))
4660 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(
4661 *this, Target, Args);
4662 else
4663 TC =
4664 llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004665 break;
4666 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004667 break;
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004668 case llvm::Triple::PS4:
David Blaikie6ad71012017-01-13 18:53:43 +00004669 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004670 break;
David L Kreitzerd397ea42016-10-14 20:44:33 +00004671 case llvm::Triple::Contiki:
David Blaikie6ad71012017-01-13 18:53:43 +00004672 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
David L Kreitzerd397ea42016-10-14 20:44:33 +00004673 break;
Kristina Brooks77a4adc2018-11-29 03:49:14 +00004674 case llvm::Triple::Hurd:
4675 TC = llvm::make_unique<toolchains::Hurd>(*this, Target, Args);
4676 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004677 default:
Douglas Katzman9f5e70e2015-05-26 18:01:33 +00004678 // Of these targets, Hexagon is the only one that might have
4679 // an OS of Linux, in which case it got handled above already.
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004680 switch (Target.getArch()) {
4681 case llvm::Triple::tce:
David Blaikie6ad71012017-01-13 18:53:43 +00004682 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004683 break;
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004684 case llvm::Triple::tcele:
David Blaikie6ad71012017-01-13 18:53:43 +00004685 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004686 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004687 case llvm::Triple::hexagon:
David Blaikie6ad71012017-01-13 18:53:43 +00004688 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4689 Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004690 break;
Jacques Pienaard964cc22016-03-28 21:02:54 +00004691 case llvm::Triple::lanai:
David Blaikie6ad71012017-01-13 18:53:43 +00004692 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
Jacques Pienaard964cc22016-03-28 21:02:54 +00004693 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004694 case llvm::Triple::xcore:
David Blaikie6ad71012017-01-13 18:53:43 +00004695 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004696 break;
Dan Gohmanc2853072015-09-03 22:51:53 +00004697 case llvm::Triple::wasm32:
4698 case llvm::Triple::wasm64:
David Blaikie6ad71012017-01-13 18:53:43 +00004699 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
Dan Gohmanc2853072015-09-03 22:51:53 +00004700 break;
Dylan McKay924fa3a2017-01-05 05:20:27 +00004701 case llvm::Triple::avr:
David Blaikie6ad71012017-01-13 18:53:43 +00004702 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
Dylan McKay924fa3a2017-01-05 05:20:27 +00004703 break;
Anton Korobeynikov93165d62019-01-15 19:44:05 +00004704 case llvm::Triple::msp430:
4705 TC =
4706 llvm::make_unique<toolchains::MSP430ToolChain>(*this, Target, Args);
4707 break;
David Bolvanskyf4be2532018-07-31 14:21:46 +00004708 case llvm::Triple::riscv32:
4709 case llvm::Triple::riscv64:
4710 TC = llvm::make_unique<toolchains::RISCVToolChain>(*this, Target, Args);
4711 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004712 default:
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004713 if (Target.getVendor() == llvm::Triple::Myriad)
David Blaikie6ad71012017-01-13 18:53:43 +00004714 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
4715 Args);
Jonathan Roelofs901c7762017-05-25 15:42:13 +00004716 else if (toolchains::BareMetal::handlesTarget(Target))
4717 TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004718 else if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004719 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004720 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004721 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004722 else
David Blaikie6ad71012017-01-13 18:53:43 +00004723 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004724 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004725 }
4726 }
Justin Lebar66c4fd72016-11-18 00:41:22 +00004727
4728 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
4729 // compiles always need two toolchains, the CUDA toolchain and the host
4730 // toolchain. So the only valid way to create a CUDA toolchain is via
4731 // CreateOffloadingDeviceToolChains.
4732
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004733 return *TC;
Daniel Dunbar4dff6a42009-03-10 23:41:59 +00004734}
Daniel Dunbar8fa879d2009-03-24 18:57:02 +00004735
Rafael Espindola2f69d402013-03-18 15:33:26 +00004736bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
Douglas Katzman00249092015-06-12 15:45:21 +00004737 // Say "no" if there is not exactly one input of a type clang understands.
Nico Weber5a459f82016-02-23 19:30:43 +00004738 if (JA.size() != 1 ||
4739 !types::isAcceptedByClang((*JA.input_begin())->getType()))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004740 return false;
4741
Douglas Katzman00249092015-06-12 15:45:21 +00004742 // And say "no" if this is not a kind of action clang understands.
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004743 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
Bob Wilson23a55f12014-12-21 07:00:00 +00004744 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004745 return false;
4746
4747 return true;
4748}
4749
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004750/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
4751/// grouped values as integers. Numbers which are not provided are set to 0.
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004752///
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004753/// \return True if the entire string was parsed (9.2), or all groups were
4754/// parsed (10.3.5extrastuff).
Mehdi Amini12011172016-10-06 05:11:48 +00004755bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
4756 unsigned &Micro, bool &HadExtra) {
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004757 HadExtra = false;
4758
4759 Major = Minor = Micro = 0;
Mehdi Amini12011172016-10-06 05:11:48 +00004760 if (Str.empty())
Bob Wilson433cb312015-04-07 01:03:35 +00004761 return false;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004762
Mehdi Amini12011172016-10-06 05:11:48 +00004763 if (Str.consumeInteger(10, Major))
4764 return false;
4765 if (Str.empty())
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004766 return true;
Mehdi Amini12011172016-10-06 05:11:48 +00004767 if (Str[0] != '.')
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004768 return false;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004769
Mehdi Amini12011172016-10-06 05:11:48 +00004770 Str = Str.drop_front(1);
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004771
Mehdi Amini12011172016-10-06 05:11:48 +00004772 if (Str.consumeInteger(10, Minor))
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004773 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004774 if (Str.empty())
4775 return true;
4776 if (Str[0] != '.')
4777 return false;
4778 Str = Str.drop_front(1);
4779
4780 if (Str.consumeInteger(10, Micro))
4781 return false;
4782 if (!Str.empty())
4783 HadExtra = true;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004784 return true;
4785}
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004786
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004787/// Parse digits from a string \p Str and fulfill \p Digits with
4788/// the parsed numbers. This method assumes that the max number of
4789/// digits to look for is equal to Digits.size().
4790///
4791/// \return True if the entire string was parsed and there are
4792/// no extra characters remaining at the end.
Mehdi Amini12011172016-10-06 05:11:48 +00004793bool Driver::GetReleaseVersion(StringRef Str,
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004794 MutableArrayRef<unsigned> Digits) {
Mehdi Amini12011172016-10-06 05:11:48 +00004795 if (Str.empty())
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004796 return false;
4797
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004798 unsigned CurDigit = 0;
4799 while (CurDigit < Digits.size()) {
Mehdi Amini12011172016-10-06 05:11:48 +00004800 unsigned Digit;
4801 if (Str.consumeInteger(10, Digit))
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004802 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004803 Digits[CurDigit] = Digit;
4804 if (Str.empty())
4805 return true;
4806 if (Str[0] != '.')
4807 return false;
4808 Str = Str.drop_front(1);
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004809 CurDigit++;
4810 }
4811
4812 // More digits than requested, bail out...
4813 return false;
4814}
4815
Simon Atanasyan27c0f202019-04-02 18:03:15 +00004816std::pair<unsigned, unsigned>
4817Driver::getIncludeExcludeOptionFlagMasks(bool IsClCompatMode) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004818 unsigned IncludedFlagsBitmask = 0;
Rafael Espindolacc707bc2013-09-25 15:54:41 +00004819 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004820
Hans Wennborg797004d2018-11-08 11:27:04 +00004821 if (IsClCompatMode) {
Hans Wennborg19076102013-07-31 20:51:53 +00004822 // Include CL and Core options.
4823 IncludedFlagsBitmask |= options::CLOption;
4824 IncludedFlagsBitmask |= options::CoreOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004825 } else {
4826 ExcludedFlagsBitmask |= options::CLOption;
4827 }
4828
4829 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
4830}
Benjamin Kramerab88f622014-03-25 18:02:07 +00004831
Douglas Katzmanf08fadf2015-06-04 14:40:44 +00004832bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
Benjamin Kramerab88f622014-03-25 18:02:07 +00004833 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
4834}