blob: ebf2ffc3558ffb15af9bb4972c023ec20c90adbc [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//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Daniel Dunbar544ecd12009-03-02 19:59:07 +000010#include "clang/Driver/Driver.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000011#include "InputInfo.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000012#include "ToolChains/AMDGPU.h"
13#include "ToolChains/AVR.h"
Ed Schouten4dabea22017-06-25 08:29:09 +000014#include "ToolChains/Ananas.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000015#include "ToolChains/BareMetal.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000016#include "ToolChains/Clang.h"
17#include "ToolChains/CloudABI.h"
18#include "ToolChains/Contiki.h"
19#include "ToolChains/CrossWindows.h"
20#include "ToolChains/Cuda.h"
21#include "ToolChains/Darwin.h"
22#include "ToolChains/DragonFly.h"
23#include "ToolChains/FreeBSD.h"
24#include "ToolChains/Fuchsia.h"
25#include "ToolChains/Gnu.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000026#include "ToolChains/HIP.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000027#include "ToolChains/Haiku.h"
28#include "ToolChains/Hexagon.h"
29#include "ToolChains/Lanai.h"
30#include "ToolChains/Linux.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000031#include "ToolChains/MSVC.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000032#include "ToolChains/MinGW.h"
33#include "ToolChains/Minix.h"
Konstantin Zhuravlyove37b32c2017-03-08 22:36:04 +000034#include "ToolChains/MipsLinux.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000035#include "ToolChains/Myriad.h"
36#include "ToolChains/NaCl.h"
37#include "ToolChains/NetBSD.h"
38#include "ToolChains/OpenBSD.h"
39#include "ToolChains/PS4CPU.h"
Erik Pilkington46420b62018-09-27 20:36:28 +000040#include "ToolChains/RISCVToolchain.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000041#include "ToolChains/Solaris.h"
42#include "ToolChains/TCE.h"
43#include "ToolChains/WebAssembly.h"
44#include "ToolChains/XCore.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000045#include "clang/Basic/Version.h"
Benjamin Kramerd45b2052015-10-07 15:48:01 +000046#include "clang/Basic/VirtualFileSystem.h"
Alp Toker1d257e12014-06-04 03:28:55 +000047#include "clang/Config/config.h"
Daniel Dunbar1688f1a2009-03-12 07:58:46 +000048#include "clang/Driver/Action.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000049#include "clang/Driver/Compilation.h"
Daniel Dunbarc0b3e952009-03-12 08:55:43 +000050#include "clang/Driver/DriverDiagnostic.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000051#include "clang/Driver/Job.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000052#include "clang/Driver/Options.h"
Peter Collingbournea4ccff32015-02-20 20:30:56 +000053#include "clang/Driver/SanitizerArgs.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000054#include "clang/Driver/Tool.h"
55#include "clang/Driver/ToolChain.h"
Chris Lattnerce6c42f2011-03-23 04:04:01 +000056#include "llvm/ADT/ArrayRef.h"
Hans Wennborg6ddc6902013-07-27 00:23:45 +000057#include "llvm/ADT/STLExtras.h"
Justin Lebar62907612016-07-06 21:21:39 +000058#include "llvm/ADT/SmallSet.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000059#include "llvm/ADT/StringExtras.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000060#include "llvm/ADT/StringSet.h"
Hans Wennborg70850d82013-07-18 20:29:38 +000061#include "llvm/ADT/StringSwitch.h"
Nico Weberd637c052018-04-30 13:52:15 +000062#include "llvm/Config/llvm-config.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000063#include "llvm/Option/Arg.h"
64#include "llvm/Option/ArgList.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000065#include "llvm/Option/OptSpecifier.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000066#include "llvm/Option/OptTable.h"
67#include "llvm/Option/Option.h"
Serge Pavlov208ac652018-01-01 13:27:01 +000068#include "llvm/Support/CommandLine.h"
David Blaikie79000202011-09-23 05:57:42 +000069#include "llvm/Support/ErrorHandling.h"
Michael J. Spencerf28df4c2010-12-17 21:22:22 +000070#include "llvm/Support/FileSystem.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000071#include "llvm/Support/Path.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000072#include "llvm/Support/PrettyStackTrace.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000073#include "llvm/Support/Process.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000074#include "llvm/Support/Program.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000075#include "llvm/Support/StringSaver.h"
Dimitry Andric81c40422017-06-06 21:54:21 +000076#include "llvm/Support/TargetRegistry.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000077#include "llvm/Support/raw_ostream.h"
Dylan Noblesmith4f4e7452012-02-02 00:40:14 +000078#include <map>
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000079#include <memory>
Benjamin Kramercfeacf52016-05-27 14:27:13 +000080#include <utility>
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +000081#if LLVM_ON_UNIX
82#include <unistd.h> // getpid
83#endif
Dylan Noblesmith86780e92012-02-01 14:25:28 +000084
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000085using namespace clang::driver;
Chris Lattnerada1c912009-03-26 05:56:24 +000086using namespace clang;
Reid Kleckner898229a2013-06-14 17:17:23 +000087using namespace llvm::opt;
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000088
Petr Hosekdd38d932018-05-29 22:35:39 +000089Driver::Driver(StringRef ClangExecutable, StringRef TargetTriple,
Benjamin Kramerd45b2052015-10-07 15:48:01 +000090 DiagnosticsEngine &Diags,
91 IntrusiveRefCntPtr<vfs::FileSystem> VFS)
Benjamin Kramercfeacf52016-05-27 14:27:13 +000092 : Opts(createDriverOptTable()), Diags(Diags), VFS(std::move(VFS)),
93 Mode(GCCMode), SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
94 LTOMode(LTOK_None), ClangExecutable(ClangExecutable),
Alex Lorenz045c5142018-04-07 00:03:27 +000095 SysRoot(DEFAULT_SYSROOT), DriverTitle("clang LLVM compiler"),
96 CCPrintOptionsFilename(nullptr), CCPrintHeadersFilename(nullptr),
97 CCLogDiagnosticsFilename(nullptr), CCCPrintBindings(false),
98 CCPrintOptions(false), CCPrintHeaders(false), CCLogDiagnostics(false),
Petr Hosekdd38d932018-05-29 22:35:39 +000099 CCGenDiagnostics(false), TargetTriple(TargetTriple),
Alex Lorenz045c5142018-04-07 00:03:27 +0000100 CCCGenericGCCName(""), Saver(Alloc), CheckInputsExist(true),
101 CCCUsePCH(true), GenReproducer(false),
102 SuppressMissingInputWarning(false) {
Daniel Dunbar3f3e2cd2010-01-20 02:35:16 +0000103
Benjamin Kramerd45b2052015-10-07 15:48:01 +0000104 // Provide a sane fallback if no VFS is specified.
105 if (!this->VFS)
106 this->VFS = vfs::getRealFileSystem();
107
Sumanth Gundapaneni3a1592942015-03-03 20:43:12 +0000108 Name = llvm::sys::path::filename(ClangExecutable);
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000109 Dir = llvm::sys::path::parent_path(ClangExecutable);
Benjamin Kramerf420dda2015-10-13 15:19:32 +0000110 InstalledDir = Dir; // Provide a sensible default installed dir.
Bob Wilsona20a1da2013-03-23 05:17:59 +0000111
Serge Pavlov208ac652018-01-01 13:27:01 +0000112#if defined(CLANG_CONFIG_FILE_SYSTEM_DIR)
113 SystemConfigDir = CLANG_CONFIG_FILE_SYSTEM_DIR;
114#endif
115#if defined(CLANG_CONFIG_FILE_USER_DIR)
116 UserConfigDir = CLANG_CONFIG_FILE_USER_DIR;
117#endif
118
Bob Wilsona20a1da2013-03-23 05:17:59 +0000119 // Compute the path to the resource directory.
120 StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
121 SmallString<128> P(Dir);
Chandler Carruthfd3cc702014-12-29 12:09:08 +0000122 if (ClangResourceDir != "") {
Bob Wilsona20a1da2013-03-23 05:17:59 +0000123 llvm::sys::path::append(P, ClangResourceDir);
Chandler Carruthfd3cc702014-12-29 12:09:08 +0000124 } else {
125 StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX);
Argyrios Kyrtzidisbcae0472017-02-25 18:14:35 +0000126 P = llvm::sys::path::parent_path(Dir);
127 llvm::sys::path::append(P, Twine("lib") + ClangLibdirSuffix, "clang",
Chandler Carruthfd3cc702014-12-29 12:09:08 +0000128 CLANG_VERSION_STRING);
129 }
Bob Wilsona20a1da2013-03-23 05:17:59 +0000130 ResourceDir = P.str();
Daniel Dunbar544ecd12009-03-02 19:59:07 +0000131}
132
Zachary Turneraff19c32016-08-12 17:47:52 +0000133void Driver::ParseDriverMode(StringRef ProgramName,
134 ArrayRef<const char *> Args) {
Martin Storsjo1fab23d2018-04-25 21:23:59 +0000135 if (ClangNameParts.isEmpty())
136 ClangNameParts = ToolChain::getTargetAndModeFromProgramName(ProgramName);
Serge Pavlov4e769842017-08-29 05:22:26 +0000137 setDriverModeFromOption(ClangNameParts.DriverMode);
Hans Wennborg70850d82013-07-18 20:29:38 +0000138
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000139 for (const char *ArgPtr : Args) {
Erich Keane258f0592018-02-07 00:19:58 +0000140 // Ignore nullptrs, they are the response file's EOL markers.
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000141 if (ArgPtr == nullptr)
Reid Kleckneraf5fd6a2014-08-22 19:29:30 +0000142 continue;
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000143 const StringRef Arg = ArgPtr;
Zachary Turneraff19c32016-08-12 17:47:52 +0000144 setDriverModeFromOption(Arg);
Hans Wennborg70850d82013-07-18 20:29:38 +0000145 }
146}
147
Zachary Turneraff19c32016-08-12 17:47:52 +0000148void Driver::setDriverModeFromOption(StringRef Opt) {
149 const std::string OptName =
150 getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
151 if (!Opt.startswith(OptName))
152 return;
153 StringRef Value = Opt.drop_front(OptName.size());
154
Erich Keane2908a042018-02-12 17:47:01 +0000155 if (auto M = llvm::StringSwitch<llvm::Optional<DriverMode>>(Value)
156 .Case("gcc", GCCMode)
157 .Case("g++", GXXMode)
158 .Case("cpp", CPPMode)
159 .Case("cl", CLMode)
160 .Default(None))
161 Mode = *M;
Zachary Turneraff19c32016-08-12 17:47:52 +0000162 else
163 Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
164}
165
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000166InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings,
167 bool &ContainsError) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000168 llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000169 ContainsError = false;
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000170
171 unsigned IncludedFlagsBitmask;
172 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000173 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000174 getIncludeExcludeOptionFlagMasks();
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000175
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000176 unsigned MissingArgIndex, MissingArgCount;
David Blaikie69a1d8c2015-06-22 22:07:27 +0000177 InputArgList Args =
David Blaikie6d492ad2015-06-21 06:32:36 +0000178 getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
179 IncludedFlagsBitmask, ExcludedFlagsBitmask);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000180
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000181 // Check for missing argument error.
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000182 if (MissingArgCount) {
183 Diag(diag::err_drv_missing_argument)
David Blaikie69a1d8c2015-06-22 22:07:27 +0000184 << Args.getArgString(MissingArgIndex) << MissingArgCount;
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000185 ContainsError |=
186 Diags.getDiagnosticLevel(diag::err_drv_missing_argument,
187 SourceLocation()) > DiagnosticsEngine::Warning;
188 }
Daniel Dunbar65229332009-03-13 11:38:42 +0000189
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000190 // Check for unsupported options.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000191 for (const Arg *A : Args) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +0000192 if (A->getOption().hasFlag(options::Unsupported)) {
Brian Gesiak24910762018-01-06 00:25:40 +0000193 unsigned DiagID;
194 auto ArgString = A->getAsString(Args);
195 std::string Nearest;
196 if (getOpts().findNearest(
197 ArgString, Nearest, IncludedFlagsBitmask,
198 ExcludedFlagsBitmask | options::Unsupported) > 1) {
199 DiagID = diag::err_drv_unsupported_opt;
200 Diag(DiagID) << ArgString;
201 } else {
202 DiagID = diag::err_drv_unsupported_opt_with_suggestion;
203 Diag(DiagID) << ArgString << Nearest;
204 }
205 ContainsError |= Diags.getDiagnosticLevel(DiagID, SourceLocation()) >
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000206 DiagnosticsEngine::Warning;
Daniel Dunbard8500f32009-03-22 23:26:43 +0000207 continue;
208 }
Chad Rosierce975d92012-02-22 17:55:22 +0000209
210 // Warn about -mcpu= without an argument.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000211 if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000212 Diag(diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
213 ContainsError |= Diags.getDiagnosticLevel(
214 diag::warn_drv_empty_joined_argument,
215 SourceLocation()) > DiagnosticsEngine::Warning;
Chad Rosierce975d92012-02-22 17:55:22 +0000216 }
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000217 }
218
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000219 for (const Arg *A : Args.filtered(options::OPT_UNKNOWN)) {
Brian Gesiak24910762018-01-06 00:25:40 +0000220 unsigned DiagID;
221 auto ArgString = A->getAsString(Args);
222 std::string Nearest;
223 if (getOpts().findNearest(
224 ArgString, Nearest, IncludedFlagsBitmask, ExcludedFlagsBitmask) > 1) {
225 DiagID = IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl
226 : diag::err_drv_unknown_argument;
227 Diags.Report(DiagID) << ArgString;
228 } else {
229 DiagID = IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl_with_suggestion
230 : diag::err_drv_unknown_argument_with_suggestion;
231 Diags.Report(DiagID) << ArgString << Nearest;
232 }
233 ContainsError |= Diags.getDiagnosticLevel(DiagID, SourceLocation()) >
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000234 DiagnosticsEngine::Warning;
235 }
Rafael Espindola8a2d4962013-09-23 23:55:25 +0000236
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000237 return Args;
238}
239
Chad Rosier7742b5d2011-07-27 23:36:45 +0000240// Determine which compilation mode we are in. We look for options which
241// affect the phase, starting with the earliest phases, and record which
242// option we used to determine the final phase.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000243phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
244 Arg **FinalPhaseArg) const {
Craig Topper92fc2df2014-05-17 16:56:41 +0000245 Arg *PhaseArg = nullptr;
Chad Rosier7742b5d2011-07-27 23:36:45 +0000246 phases::ID FinalPhase;
Eric Christopherf901e852011-08-17 22:59:59 +0000247
Hans Wennborge50cec32014-06-13 20:59:54 +0000248 // -{E,EP,P,M,MM} only run the preprocessor.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000249 if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
Hans Wennborge50cec32014-06-13 20:59:54 +0000250 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
Hans Wennborge0053472013-12-20 18:40:46 +0000251 (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
252 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000253 FinalPhase = phases::Preprocess;
Eric Christopherf901e852011-08-17 22:59:59 +0000254
Richard Smithdd4ad3d2016-08-30 19:06:26 +0000255 // --precompile only runs up to precompilation.
256 } else if ((PhaseArg = DAL.getLastArg(options::OPT__precompile))) {
257 FinalPhase = phases::Precompile;
258
Bob Wilson23a55f12014-12-21 07:00:00 +0000259 // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
Chad Rosier7742b5d2011-07-27 23:36:45 +0000260 } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000261 (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000262 (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000263 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
Fariborz Jahanian73223bb2012-04-02 15:59:19 +0000264 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
Ted Kremenekf7639e12012-03-06 20:06:33 +0000265 (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000266 (PhaseArg = DAL.getLastArg(options::OPT__analyze,
Chad Rosier1aeb15a2012-03-06 23:14:35 +0000267 options::OPT__analyze_auto)) ||
Bob Wilson23a55f12014-12-21 07:00:00 +0000268 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000269 FinalPhase = phases::Compile;
270
Bob Wilson23a55f12014-12-21 07:00:00 +0000271 // -S only runs up to the backend.
272 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
273 FinalPhase = phases::Backend;
274
Artem Belevich4242f412015-07-28 21:01:21 +0000275 // -c compilation only runs up to the assembler.
276 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000277 FinalPhase = phases::Assemble;
278
279 // Otherwise do everything.
280 } else
281 FinalPhase = phases::Link;
282
283 if (FinalPhaseArg)
284 *FinalPhaseArg = PhaseArg;
285
286 return FinalPhase;
287}
288
David Blaikie0aaa7622017-01-13 17:34:15 +0000289static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
Martin Storsjo665c7a42018-05-04 06:05:58 +0000290 StringRef Value, bool Claim = true) {
David Blaikie0aaa7622017-01-13 17:34:15 +0000291 Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
Hans Wennborged1d0722013-08-13 21:32:29 +0000292 Args.getBaseArgs().MakeIndex(Value), Value.data());
Hans Wennborg55362852014-05-02 22:55:30 +0000293 Args.AddSynthesizedArg(A);
Martin Storsjo665c7a42018-05-04 06:05:58 +0000294 if (Claim)
295 A->claim();
Hans Wennborged1d0722013-08-13 21:32:29 +0000296 return A;
297}
298
Daniel Dunbar775d4062010-06-11 22:00:26 +0000299DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
300 DerivedArgList *DAL = new DerivedArgList(Args);
301
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000302 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
Nirav Daveb0bb6142015-11-24 16:07:21 +0000303 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000304 for (Arg *A : Args) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000305 // Unfortunately, we have to parse some forwarding options (-Xassembler,
306 // -Xlinker, -Xpreprocessor) because we either integrate their functionality
307 // (assembler and preprocessor), or bypass a previous driver ('collect2').
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000308
309 // Rewrite linker options, to replace --no-demangle with a custom internal
310 // option.
311 if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
312 A->getOption().matches(options::OPT_Xlinker)) &&
313 A->containsValue("--no-demangle")) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000314 // Add the rewritten no-demangle argument.
315 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
316
317 // Add the remaining values as Xlinker arguments.
Benjamin Kramer72e64312015-09-24 14:48:49 +0000318 for (StringRef Val : A->getValues())
Douglas Katzmana34b7bf2015-06-30 19:32:57 +0000319 if (Val != "--no-demangle")
320 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000321
322 continue;
323 }
324
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000325 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
326 // some build systems. We don't try to be complete here because we don't
327 // care to encourage this usage model.
328 if (A->getOption().matches(options::OPT_Wp_COMMA) &&
Richard Smithbd55daf2012-11-01 04:30:05 +0000329 (A->getValue(0) == StringRef("-MD") ||
330 A->getValue(0) == StringRef("-MMD"))) {
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000331 // Rewrite to -MD/-MMD along with -MF.
Richard Smithbd55daf2012-11-01 04:30:05 +0000332 if (A->getValue(0) == StringRef("-MD"))
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000333 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
334 else
335 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
Michael J. Spencer70d85be2012-11-07 23:37:14 +0000336 if (A->getNumValues() == 2)
337 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
338 A->getValue(1));
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000339 continue;
340 }
341
Shantonu Senafeb03b2010-09-17 18:39:08 +0000342 // Rewrite reserved library names.
343 if (A->getOption().matches(options::OPT_l)) {
Richard Smithbd55daf2012-11-01 04:30:05 +0000344 StringRef Value = A->getValue();
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000345
Shantonu Senafeb03b2010-09-17 18:39:08 +0000346 // Rewrite unless -nostdlib is present.
Nirav Daveb0bb6142015-11-24 16:07:21 +0000347 if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000348 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000349 continue;
350 }
Shantonu Senafeb03b2010-09-17 18:39:08 +0000351
352 // Rewrite unconditionally.
353 if (Value == "cc_kext") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000354 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
Shantonu Senafeb03b2010-09-17 18:39:08 +0000355 continue;
356 }
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000357 }
358
Hans Wennborged1d0722013-08-13 21:32:29 +0000359 // Pick up inputs via the -- option.
360 if (A->getOption().matches(options::OPT__DASH_DASH)) {
361 A->claim();
Benjamin Kramer72e64312015-09-24 14:48:49 +0000362 for (StringRef Val : A->getValues())
Martin Storsjo665c7a42018-05-04 06:05:58 +0000363 DAL->append(MakeInputArg(*DAL, *Opts, Val, false));
Hans Wennborged1d0722013-08-13 21:32:29 +0000364 continue;
365 }
366
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000367 DAL->append(A);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000368 }
Daniel Dunbar775d4062010-06-11 22:00:26 +0000369
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000370 // Enforce -static if -miamcu is present.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000371 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
372 DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000373
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000374// Add a default value of -mlinker-version=, if one was given and the user
375// didn't specify one.
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000376#if defined(HOST_LINK_VERSION)
Tim Northover018578c2015-06-12 19:21:35 +0000377 if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
378 strlen(HOST_LINK_VERSION) > 0) {
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000379 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
380 HOST_LINK_VERSION);
Daniel Dunbarb613ffc2010-08-17 22:32:45 +0000381 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000382 }
383#endif
384
Daniel Dunbar775d4062010-06-11 22:00:26 +0000385 return DAL;
386}
387
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000388/// Compute target triple from args.
Artem Belevich959e0542015-07-10 19:47:55 +0000389///
390/// This routine provides the logic to compute a target triple from various
391/// args passed to the driver and the default triple string.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000392static llvm::Triple computeTargetTriple(const Driver &D,
Petr Hosekdd38d932018-05-29 22:35:39 +0000393 StringRef TargetTriple,
Artem Belevich959e0542015-07-10 19:47:55 +0000394 const ArgList &Args,
395 StringRef DarwinArchName = "") {
396 // FIXME: Already done in Compilation *Driver::BuildCompilation
397 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +0000398 TargetTriple = A->getValue();
Artem Belevich959e0542015-07-10 19:47:55 +0000399
Petr Hosekdd38d932018-05-29 22:35:39 +0000400 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Artem Belevich959e0542015-07-10 19:47:55 +0000401
402 // Handle Apple-specific options available here.
403 if (Target.isOSBinFormatMachO()) {
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000404 // If an explicit Darwin arch name is given, that trumps all.
Artem Belevich959e0542015-07-10 19:47:55 +0000405 if (!DarwinArchName.empty()) {
406 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
407 return Target;
408 }
409
410 // Handle the Darwin '-arch' flag.
411 if (Arg *A = Args.getLastArg(options::OPT_arch)) {
412 StringRef ArchName = A->getValue();
413 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
414 }
415 }
416
417 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
418 // '-mbig-endian'/'-EB'.
419 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
420 options::OPT_mbig_endian)) {
421 if (A->getOption().matches(options::OPT_mlittle_endian)) {
422 llvm::Triple LE = Target.getLittleEndianArchVariant();
423 if (LE.getArch() != llvm::Triple::UnknownArch)
424 Target = std::move(LE);
425 } else {
426 llvm::Triple BE = Target.getBigEndianArchVariant();
427 if (BE.getArch() != llvm::Triple::UnknownArch)
428 Target = std::move(BE);
429 }
430 }
431
432 // Skip further flag support on OSes which don't support '-m32' or '-m64'.
Douglas Katzman15a63ed2015-08-12 18:36:12 +0000433 if (Target.getArch() == llvm::Triple::tce ||
434 Target.getOS() == llvm::Triple::Minix)
Artem Belevich959e0542015-07-10 19:47:55 +0000435 return Target;
436
437 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000438 Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
439 options::OPT_m32, options::OPT_m16);
440 if (A) {
Artem Belevich959e0542015-07-10 19:47:55 +0000441 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
442
443 if (A->getOption().matches(options::OPT_m64)) {
444 AT = Target.get64BitArchVariant().getArch();
445 if (Target.getEnvironment() == llvm::Triple::GNUX32)
446 Target.setEnvironment(llvm::Triple::GNU);
447 } else if (A->getOption().matches(options::OPT_mx32) &&
448 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
449 AT = llvm::Triple::x86_64;
450 Target.setEnvironment(llvm::Triple::GNUX32);
451 } else if (A->getOption().matches(options::OPT_m32)) {
452 AT = Target.get32BitArchVariant().getArch();
453 if (Target.getEnvironment() == llvm::Triple::GNUX32)
454 Target.setEnvironment(llvm::Triple::GNU);
455 } else if (A->getOption().matches(options::OPT_m16) &&
456 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
457 AT = llvm::Triple::x86;
458 Target.setEnvironment(llvm::Triple::CODE16);
459 }
460
461 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
462 Target.setArch(AT);
463 }
464
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000465 // Handle -miamcu flag.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000466 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
467 if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
468 D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
469 << Target.str();
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000470
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000471 if (A && !A->getOption().matches(options::OPT_m32))
472 D.Diag(diag::err_drv_argument_not_allowed_with)
473 << "-miamcu" << A->getBaseArg().getAsString(Args);
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000474
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000475 Target.setArch(llvm::Triple::x86);
476 Target.setArchName("i586");
477 Target.setEnvironment(llvm::Triple::UnknownEnvironment);
478 Target.setEnvironmentName("");
479 Target.setOS(llvm::Triple::ELFIAMCU);
480 Target.setVendor(llvm::Triple::UnknownVendor);
481 Target.setVendorName("intel");
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000482 }
483
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000484 // If target is MIPS adjust the target triple
485 // accordingly to provided ABI name.
486 A = Args.getLastArg(options::OPT_mabi_EQ);
487 if (A && Target.isMIPS())
488 Target = llvm::StringSwitch<llvm::Triple>(A->getValue())
489 .Case("32", Target.get32BitArchVariant())
490 .Case("n32", Target.get64BitArchVariant())
491 .Case("64", Target.get64BitArchVariant())
492 .Default(Target);
493
Artem Belevich959e0542015-07-10 19:47:55 +0000494 return Target;
495}
496
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000497// Parse the LTO options and record the type of LTO compilation
Teresa Johnson945bc502015-10-15 20:35:53 +0000498// based on which -f(no-)?lto(=.*)? option occurs last.
499void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
500 LTOMode = LTOK_None;
501 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
502 options::OPT_fno_lto, false))
503 return;
504
505 StringRef LTOName("full");
506
507 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
Teresa Johnson6ef80dc2015-11-02 18:03:12 +0000508 if (A)
509 LTOName = A->getValue();
Teresa Johnson945bc502015-10-15 20:35:53 +0000510
511 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
512 .Case("full", LTOK_Full)
513 .Case("thin", LTOK_Thin)
514 .Default(LTOK_Unknown);
515
516 if (LTOMode == LTOK_Unknown) {
517 assert(A);
518 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
519 << A->getValue();
520 }
521}
522
Samuel Antao39f9da22016-10-27 16:38:05 +0000523/// Compute the desired OpenMP runtime from the flags provided.
524Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
525 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
526
527 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
528 if (A)
529 RuntimeName = A->getValue();
530
531 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
532 .Case("libomp", OMPRT_OMP)
533 .Case("libgomp", OMPRT_GOMP)
534 .Case("libiomp5", OMPRT_IOMP5)
535 .Default(OMPRT_Unknown);
536
537 if (RT == OMPRT_Unknown) {
538 if (A)
539 Diag(diag::err_drv_unsupported_option_argument)
540 << A->getOption().getName() << A->getValue();
541 else
542 // FIXME: We could use a nicer diagnostic here.
543 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
544 }
545
546 return RT;
547}
548
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000549void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
550 InputList &Inputs) {
551
552 //
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000553 // CUDA/HIP
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000554 //
Yaxun Liuf6144222018-05-30 00:53:50 +0000555 // We need to generate a CUDA/HIP toolchain if any of the inputs has a CUDA
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000556 // or HIP type. However, mixed CUDA/HIP compilation is not supported.
557 bool IsCuda =
558 llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000559 return types::isCuda(I.first);
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000560 });
561 bool IsHIP =
562 llvm::any_of(Inputs,
563 [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
564 return types::isHIP(I.first);
565 }) ||
566 C.getInputArgs().hasArg(options::OPT_hip_link);
567 if (IsCuda && IsHIP) {
568 Diag(clang::diag::err_drv_mix_cuda_hip);
569 return;
570 }
Yaxun Liuf6144222018-05-30 00:53:50 +0000571 if (IsCuda) {
Justin Lebar66c4fd72016-11-18 00:41:22 +0000572 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
573 const llvm::Triple &HostTriple = HostTC->getTriple();
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000574 StringRef DeviceTripleStr;
Yaxun Liuf6144222018-05-30 00:53:50 +0000575 auto OFK = Action::OFK_Cuda;
576 DeviceTripleStr =
577 HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda" : "nvptx-nvidia-cuda";
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000578 llvm::Triple CudaTriple(DeviceTripleStr);
Yaxun Liuf6144222018-05-30 00:53:50 +0000579 // Use the CUDA and host triples as the key into the ToolChains map,
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000580 // because the device toolchain we create depends on both.
David Blaikie6ad71012017-01-13 18:53:43 +0000581 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
Justin Lebar66c4fd72016-11-18 00:41:22 +0000582 if (!CudaTC) {
David Blaikie6ad71012017-01-13 18:53:43 +0000583 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000584 *this, CudaTriple, *HostTC, C.getInputArgs(), OFK);
Justin Lebar66c4fd72016-11-18 00:41:22 +0000585 }
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000586 C.addOffloadDeviceToolChain(CudaTC.get(), OFK);
Yaxun Liuf6144222018-05-30 00:53:50 +0000587 } else if (IsHIP) {
588 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
589 const llvm::Triple &HostTriple = HostTC->getTriple();
590 StringRef DeviceTripleStr;
591 auto OFK = Action::OFK_HIP;
592 DeviceTripleStr = "amdgcn-amd-amdhsa";
593 llvm::Triple HIPTriple(DeviceTripleStr);
594 // Use the HIP and host triples as the key into the ToolChains map,
595 // because the device toolchain we create depends on both.
596 auto &HIPTC = ToolChains[HIPTriple.str() + "/" + HostTriple.str()];
597 if (!HIPTC) {
598 HIPTC = llvm::make_unique<toolchains::HIPToolChain>(
599 *this, HIPTriple, *HostTC, C.getInputArgs());
600 }
601 C.addOffloadDeviceToolChain(HIPTC.get(), OFK);
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000602 }
603
604 //
Samuel Antao39f9da22016-10-27 16:38:05 +0000605 // OpenMP
606 //
607 // We need to generate an OpenMP toolchain if the user specified targets with
608 // the -fopenmp-targets option.
609 if (Arg *OpenMPTargets =
610 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
611 if (OpenMPTargets->getNumValues()) {
612 // We expect that -fopenmp-targets is always used in conjunction with the
613 // option -fopenmp specifying a valid runtime with offloading support,
614 // i.e. libomp or libiomp.
615 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
616 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
617 options::OPT_fno_openmp, false);
618 if (HasValidOpenMPRuntime) {
619 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
620 HasValidOpenMPRuntime =
621 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
622 }
623
624 if (HasValidOpenMPRuntime) {
625 llvm::StringMap<const char *> FoundNormalizedTriples;
626 for (const char *Val : OpenMPTargets->getValues()) {
627 llvm::Triple TT(Val);
628 std::string NormalizedName = TT.normalize();
629
630 // Make sure we don't have a duplicate triple.
631 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
632 if (Duplicate != FoundNormalizedTriples.end()) {
633 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
634 << Val << Duplicate->second;
635 continue;
636 }
637
638 // Store the current triple so that we can check for duplicates in the
639 // following iterations.
640 FoundNormalizedTriples[NormalizedName] = Val;
641
642 // If the specified target is invalid, emit a diagnostic.
643 if (TT.getArch() == llvm::Triple::UnknownArch)
644 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
645 else {
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000646 const ToolChain *TC;
647 // CUDA toolchains have to be selected differently. They pair host
648 // and device in their implementation.
649 if (TT.isNVPTX()) {
650 const ToolChain *HostTC =
651 C.getSingleOffloadToolChain<Action::OFK_Host>();
652 assert(HostTC && "Host toolchain should be always defined.");
653 auto &CudaTC =
Gheorghe-Teodor Bercea52898432017-08-09 01:02:19 +0000654 ToolChains[TT.str() + "/" + HostTC->getTriple().normalize()];
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000655 if (!CudaTC)
656 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Gheorghe-Teodor Bercea2c926932017-08-08 14:33:05 +0000657 *this, TT, *HostTC, C.getInputArgs(), Action::OFK_OpenMP);
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000658 TC = CudaTC.get();
659 } else
660 TC = &getToolChain(C.getInputArgs(), TT);
661 C.addOffloadDeviceToolChain(TC, Action::OFK_OpenMP);
Samuel Antao39f9da22016-10-27 16:38:05 +0000662 }
663 }
664 } else
665 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
666 } else
667 Diag(clang::diag::warn_drv_empty_joined_argument)
668 << OpenMPTargets->getAsString(C.getInputArgs());
669 }
670
671 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000672 // TODO: Add support for other offloading programming models here.
673 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000674}
675
Serge Pavlov208ac652018-01-01 13:27:01 +0000676/// Looks the given directories for the specified file.
677///
678/// \param[out] FilePath File path, if the file was found.
679/// \param[in] Dirs Directories used for the search.
680/// \param[in] FileName Name of the file to search for.
681/// \return True if file was found.
682///
683/// Looks for file specified by FileName sequentially in directories specified
684/// by Dirs.
685///
686static bool searchForFile(SmallVectorImpl<char> &FilePath,
687 ArrayRef<std::string> Dirs,
688 StringRef FileName) {
689 SmallString<128> WPath;
690 for (const StringRef &Dir : Dirs) {
691 if (Dir.empty())
692 continue;
693 WPath.clear();
694 llvm::sys::path::append(WPath, Dir, FileName);
695 llvm::sys::path::native(WPath);
696 if (llvm::sys::fs::is_regular_file(WPath)) {
697 FilePath = std::move(WPath);
698 return true;
699 }
700 }
701 return false;
702}
703
704bool Driver::readConfigFile(StringRef FileName) {
705 // Try reading the given file.
706 SmallVector<const char *, 32> NewCfgArgs;
707 if (!llvm::cl::readConfigFile(FileName, Saver, NewCfgArgs)) {
708 Diag(diag::err_drv_cannot_read_config_file) << FileName;
709 return true;
710 }
711
712 // Read options from config file.
713 llvm::SmallString<128> CfgFileName(FileName);
714 llvm::sys::path::native(CfgFileName);
715 ConfigFile = CfgFileName.str();
716 bool ContainErrors;
717 CfgOptions = llvm::make_unique<InputArgList>(
718 ParseArgStrings(NewCfgArgs, ContainErrors));
719 if (ContainErrors) {
720 CfgOptions.reset();
721 return true;
722 }
723
724 if (CfgOptions->hasArg(options::OPT_config)) {
725 CfgOptions.reset();
726 Diag(diag::err_drv_nested_config_file);
727 return true;
728 }
729
730 // Claim all arguments that come from a configuration file so that the driver
731 // does not warn on any that is unused.
732 for (Arg *A : *CfgOptions)
733 A->claim();
734 return false;
735}
736
737bool Driver::loadConfigFile() {
738 std::string CfgFileName;
739 bool FileSpecifiedExplicitly = false;
740
741 // Process options that change search path for config files.
742 if (CLOptions) {
743 if (CLOptions->hasArg(options::OPT_config_system_dir_EQ)) {
744 SmallString<128> CfgDir;
745 CfgDir.append(
746 CLOptions->getLastArgValue(options::OPT_config_system_dir_EQ));
747 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000748 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000749 SystemConfigDir.clear();
750 else
751 SystemConfigDir = std::string(CfgDir.begin(), CfgDir.end());
752 }
753 }
754 if (CLOptions->hasArg(options::OPT_config_user_dir_EQ)) {
755 SmallString<128> CfgDir;
756 CfgDir.append(
757 CLOptions->getLastArgValue(options::OPT_config_user_dir_EQ));
758 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000759 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000760 UserConfigDir.clear();
761 else
762 UserConfigDir = std::string(CfgDir.begin(), CfgDir.end());
763 }
764 }
765 }
766
767 // First try to find config file specified in command line.
768 if (CLOptions) {
769 std::vector<std::string> ConfigFiles =
770 CLOptions->getAllArgValues(options::OPT_config);
771 if (ConfigFiles.size() > 1) {
772 Diag(diag::err_drv_duplicate_config);
773 return true;
774 }
775
776 if (!ConfigFiles.empty()) {
777 CfgFileName = ConfigFiles.front();
778 assert(!CfgFileName.empty());
779
780 // If argument contains directory separator, treat it as a path to
781 // configuration file.
782 if (llvm::sys::path::has_parent_path(CfgFileName)) {
783 SmallString<128> CfgFilePath;
784 if (llvm::sys::path::is_relative(CfgFileName))
785 llvm::sys::fs::current_path(CfgFilePath);
786 llvm::sys::path::append(CfgFilePath, CfgFileName);
787 if (!llvm::sys::fs::is_regular_file(CfgFilePath)) {
788 Diag(diag::err_drv_config_file_not_exist) << CfgFilePath;
789 return true;
790 }
791 return readConfigFile(CfgFilePath);
792 }
793
794 FileSpecifiedExplicitly = true;
795 }
796 }
797
798 // If config file is not specified explicitly, try to deduce configuration
799 // from executable name. For instance, an executable 'armv7l-clang' will
800 // search for config file 'armv7l-clang.cfg'.
801 if (CfgFileName.empty() && !ClangNameParts.TargetPrefix.empty())
802 CfgFileName = ClangNameParts.TargetPrefix + '-' + ClangNameParts.ModeSuffix;
803
804 if (CfgFileName.empty())
805 return false;
806
807 // Determine architecture part of the file name, if it is present.
808 StringRef CfgFileArch = CfgFileName;
809 size_t ArchPrefixLen = CfgFileArch.find('-');
810 if (ArchPrefixLen == StringRef::npos)
811 ArchPrefixLen = CfgFileArch.size();
812 llvm::Triple CfgTriple;
813 CfgFileArch = CfgFileArch.take_front(ArchPrefixLen);
814 CfgTriple = llvm::Triple(llvm::Triple::normalize(CfgFileArch));
815 if (CfgTriple.getArch() == llvm::Triple::ArchType::UnknownArch)
816 ArchPrefixLen = 0;
817
818 if (!StringRef(CfgFileName).endswith(".cfg"))
819 CfgFileName += ".cfg";
820
821 // If config file starts with architecture name and command line options
822 // redefine architecture (with options like -m32 -LE etc), try finding new
823 // config file with that architecture.
824 SmallString<128> FixedConfigFile;
825 size_t FixedArchPrefixLen = 0;
826 if (ArchPrefixLen) {
827 // Get architecture name from config file name like 'i386.cfg' or
828 // 'armv7l-clang.cfg'.
829 // Check if command line options changes effective triple.
830 llvm::Triple EffectiveTriple = computeTargetTriple(*this,
831 CfgTriple.getTriple(), *CLOptions);
832 if (CfgTriple.getArch() != EffectiveTriple.getArch()) {
833 FixedConfigFile = EffectiveTriple.getArchName();
834 FixedArchPrefixLen = FixedConfigFile.size();
835 // Append the rest of original file name so that file name transforms
836 // like: i386-clang.cfg -> x86_64-clang.cfg.
837 if (ArchPrefixLen < CfgFileName.size())
838 FixedConfigFile += CfgFileName.substr(ArchPrefixLen);
839 }
840 }
841
842 // Prepare list of directories where config file is searched for.
843 SmallVector<std::string, 3> CfgFileSearchDirs;
844 CfgFileSearchDirs.push_back(UserConfigDir);
845 CfgFileSearchDirs.push_back(SystemConfigDir);
846 CfgFileSearchDirs.push_back(Dir);
847
848 // Try to find config file. First try file with corrected architecture.
849 llvm::SmallString<128> CfgFilePath;
850 if (!FixedConfigFile.empty()) {
851 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
852 return readConfigFile(CfgFilePath);
853 // If 'x86_64-clang.cfg' was not found, try 'x86_64.cfg'.
854 FixedConfigFile.resize(FixedArchPrefixLen);
855 FixedConfigFile.append(".cfg");
856 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
857 return readConfigFile(CfgFilePath);
858 }
859
860 // Then try original file name.
861 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
862 return readConfigFile(CfgFilePath);
863
864 // Finally try removing driver mode part: 'x86_64-clang.cfg' -> 'x86_64.cfg'.
865 if (!ClangNameParts.ModeSuffix.empty() &&
866 !ClangNameParts.TargetPrefix.empty()) {
867 CfgFileName.assign(ClangNameParts.TargetPrefix);
868 CfgFileName.append(".cfg");
869 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
870 return readConfigFile(CfgFilePath);
871 }
872
873 // Report error but only if config file was specified explicitly, by option
874 // --config. If it was deduced from executable name, it is not an error.
875 if (FileSpecifiedExplicitly) {
876 Diag(diag::err_drv_config_file_not_found) << CfgFileName;
877 for (const std::string &SearchDir : CfgFileSearchDirs)
878 if (!SearchDir.empty())
879 Diag(diag::note_drv_config_file_searched_in) << SearchDir;
880 return true;
881 }
882
883 return false;
884}
885
Chris Lattner54b16772011-07-23 17:14:25 +0000886Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000887 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
888
Eric Christopherf901e852011-08-17 22:59:59 +0000889 // FIXME: Handle environment options which affect driver behavior, somewhere
Bill Wendlingadbeb9f2012-03-12 21:24:57 +0000890 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
Chad Rosier82301162011-09-14 00:47:55 +0000891
David Majnemer85c25b42016-07-24 17:44:03 +0000892 if (Optional<std::string> CompilerPathValue =
893 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
894 StringRef CompilerPath = *CompilerPathValue;
Chad Rosier82301162011-09-14 00:47:55 +0000895 while (!CompilerPath.empty()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000896 std::pair<StringRef, StringRef> Split =
897 CompilerPath.split(llvm::sys::EnvPathSeparator);
Chad Rosier82301162011-09-14 00:47:55 +0000898 PrefixDirs.push_back(Split.first);
899 CompilerPath = Split.second;
900 }
901 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000902
Hans Wennborg70850d82013-07-18 20:29:38 +0000903 // We look for the driver mode option early, because the mode can affect
904 // how other options are parsed.
Zachary Turneraff19c32016-08-12 17:47:52 +0000905 ParseDriverMode(ClangExecutable, ArgList.slice(1));
Hans Wennborg70850d82013-07-18 20:29:38 +0000906
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000907 // FIXME: What are we going to do with -V and -b?
908
Serge Pavlov208ac652018-01-01 13:27:01 +0000909 // Arguments specified in command line.
910 bool ContainsError;
911 CLOptions = llvm::make_unique<InputArgList>(
912 ParseArgStrings(ArgList.slice(1), ContainsError));
913
914 // Try parsing configuration file.
915 if (!ContainsError)
916 ContainsError = loadConfigFile();
917 bool HasConfigFile = !ContainsError && (CfgOptions.get() != nullptr);
918
919 // All arguments, from both config file and command line.
920 InputArgList Args = std::move(HasConfigFile ? std::move(*CfgOptions)
921 : std::move(*CLOptions));
922 if (HasConfigFile)
923 for (auto *Opt : *CLOptions) {
Serge Pavlovf015a562018-04-26 06:28:47 +0000924 if (Opt->getOption().matches(options::OPT_config))
925 continue;
926 unsigned Index = Args.MakeIndex(Opt->getSpelling());
Serge Pavlov208ac652018-01-01 13:27:01 +0000927 const Arg *BaseArg = &Opt->getBaseArg();
928 if (BaseArg == Opt)
929 BaseArg = nullptr;
930 Arg *Copy = new llvm::opt::Arg(Opt->getOption(), Opt->getSpelling(),
Serge Pavlovf015a562018-04-26 06:28:47 +0000931 Index, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000932 Copy->getValues() = Opt->getValues();
933 if (Opt->isClaimed())
934 Copy->claim();
935 Args.append(Copy);
936 }
937
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000938 // FIXME: This stuff needs to go into the Compilation, not the driver.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000939 bool CCCPrintPhases;
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000940
Filipe Cabecinhas136f35e2015-07-18 06:35:24 +0000941 // Silence driver warnings if requested
942 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
943
Rafael Espindola59ae7992009-12-07 18:28:29 +0000944 // -no-canonical-prefixes is used very early in main.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000945 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
Rafael Espindola59ae7992009-12-07 18:28:29 +0000946
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000947 // Ignore -pipe.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000948 Args.ClaimAllArgs(options::OPT_pipe);
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000949
Daniel Dunbaracd69572009-12-04 21:55:23 +0000950 // Extract -ccc args.
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000951 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000952 // FIXME: We need to figure out where this behavior should live. Most of it
953 // should be outside in the client; the parts that aren't should have proper
954 // options, either by introducing new ones or by overloading gcc ones like -V
955 // or -b.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000956 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
David Blaikie69a1d8c2015-06-22 22:07:27 +0000957 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
958 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
Richard Smithbd55daf2012-11-01 04:30:05 +0000959 CCCGenericGCCName = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000960 CCCUsePCH =
961 Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
Bruno Cardoso Lopes52dfe712017-04-12 21:46:20 +0000962 GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
963 options::OPT_fno_crash_diagnostics,
964 !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
Petr Hosekdd38d932018-05-29 22:35:39 +0000965 // FIXME: TargetTriple is used by the target-prefixed calls to as/ld
Joerg Sonnenberger17d75512012-02-22 19:15:16 +0000966 // and getToolChain is const.
Hans Wennborg2e274592013-08-13 23:38:57 +0000967 if (IsCLMode()) {
Hans Wennborg73609a02014-03-28 01:19:04 +0000968 // clang-cl targets MSVC-style Win32.
Petr Hosekdd38d932018-05-29 22:35:39 +0000969 llvm::Triple T(TargetTriple);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +0000970 T.setOS(llvm::Triple::Win32);
Hans Wennborg0f0e8d62015-09-18 17:11:50 +0000971 T.setVendor(llvm::Triple::PC);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +0000972 T.setEnvironment(llvm::Triple::MSVC);
Oleg Ranevskyy80523182017-08-31 20:31:30 +0000973 T.setObjectFormat(llvm::Triple::COFF);
Petr Hosekdd38d932018-05-29 22:35:39 +0000974 TargetTriple = T.str();
Hans Wennborg2e274592013-08-13 23:38:57 +0000975 }
David Blaikie69a1d8c2015-06-22 22:07:27 +0000976 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +0000977 TargetTriple = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000978 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
Richard Smithbd55daf2012-11-01 04:30:05 +0000979 Dir = InstalledDir = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000980 for (const Arg *A : Args.filtered(options::OPT_B)) {
Benjamin Kramer1a648d12011-02-08 20:31:42 +0000981 A->claim();
Richard Smithbd55daf2012-11-01 04:30:05 +0000982 PrefixDirs.push_back(A->getValue(0));
Benjamin Kramer1a648d12011-02-08 20:31:42 +0000983 }
David Blaikie69a1d8c2015-06-22 22:07:27 +0000984 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
Richard Smithbd55daf2012-11-01 04:30:05 +0000985 SysRoot = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000986 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
Peter Collingbourne9d9e1fc2013-05-27 21:40:20 +0000987 DyldPrefix = A->getValue();
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000988
David Blaikie69a1d8c2015-06-22 22:07:27 +0000989 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
Bob Wilsona20a1da2013-03-23 05:17:59 +0000990 ResourceDir = A->getValue();
Jim Grosbach061dabf2013-03-12 20:17:58 +0000991
David Blaikie69a1d8c2015-06-22 22:07:27 +0000992 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +0000993 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
994 .Case("cwd", SaveTempsCwd)
995 .Case("obj", SaveTempsObj)
996 .Default(SaveTempsCwd);
997 }
998
Steven Wu1257cd82016-05-18 17:04:52 +0000999 setLTOMode(Args);
1000
Steven Wu844ab6a2016-11-16 06:06:44 +00001001 // Process -fembed-bitcode= flags.
1002 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
1003 StringRef Name = A->getValue();
1004 unsigned Model = llvm::StringSwitch<unsigned>(Name)
1005 .Case("off", EmbedNone)
1006 .Case("all", EmbedBitcode)
1007 .Case("bitcode", EmbedBitcode)
1008 .Case("marker", EmbedMarker)
1009 .Default(~0U);
1010 if (Model == ~0U) {
1011 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
1012 << Name;
1013 } else
1014 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
Steven Wu574b0f22016-03-01 01:07:58 +00001015 }
1016
David Blaikie69a1d8c2015-06-22 22:07:27 +00001017 std::unique_ptr<llvm::opt::InputArgList> UArgs =
1018 llvm::make_unique<InputArgList>(std::move(Args));
1019
Daniel Dunbar775d4062010-06-11 22:00:26 +00001020 // Perform the default argument translations.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001021 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
Daniel Dunbar775d4062010-06-11 22:00:26 +00001022
Chandler Carruthcb916192012-01-25 08:49:21 +00001023 // Owned by the host.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00001024 const ToolChain &TC = getToolChain(
Petr Hosekdd38d932018-05-29 22:35:39 +00001025 *UArgs, computeTargetTriple(*this, TargetTriple, *UArgs));
Chandler Carruthcb916192012-01-25 08:49:21 +00001026
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00001027 // The compilation takes ownership of Args.
Benjamin Kramer43c0f482017-06-30 13:21:27 +00001028 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs,
1029 ContainsError);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001030
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001031 if (!HandleImmediateArgs(*C))
1032 return C;
1033
Chad Rosierecdede82011-08-12 22:08:57 +00001034 // Construct the list of inputs.
1035 InputList Inputs;
Hans Wennborged1d0722013-08-13 21:32:29 +00001036 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
Chad Rosierecdede82011-08-12 22:08:57 +00001037
Samuel Antaoc1ffba52016-06-13 18:10:57 +00001038 // Populate the tool chains for the offloading devices, if any.
1039 CreateOffloadingDeviceToolChains(*C, Inputs);
Justin Lebar0e450a52016-03-30 23:30:25 +00001040
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001041 // Construct the list of abstract actions to perform for this compilation. On
Tim Northover157d9112014-01-16 08:48:16 +00001042 // MachO targets this uses the driver-driver and universal actions.
1043 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001044 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001045 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001046 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001047
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001048 if (CCCPrintPhases) {
Daniel Dunbareb843be2009-03-18 03:13:20 +00001049 PrintActions(*C);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001050 return C;
1051 }
1052
1053 BuildJobs(*C);
Daniel Dunbaradc91e62009-03-15 01:38:15 +00001054
1055 return C;
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001056}
1057
Justin Bognered9cbe02015-07-09 06:58:31 +00001058static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
1059 llvm::opt::ArgStringList ASL;
1060 for (const auto *A : Args)
1061 A->render(Args, ASL);
1062
1063 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
1064 if (I != ASL.begin())
1065 OS << ' ';
1066 Command::printArg(OS, *I, true);
1067 }
1068 OS << '\n';
1069}
1070
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001071bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
1072 SmallString<128> &CrashDiagDir) {
1073 using namespace llvm::sys;
1074 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
1075 "Only knows about .crash files on Darwin");
1076
1077 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
1078 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
1079 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
1080 path::home_directory(CrashDiagDir);
1081 if (CrashDiagDir.startswith("/var/root"))
1082 CrashDiagDir = "/";
1083 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
1084 int PID =
1085#if LLVM_ON_UNIX
1086 getpid();
1087#else
1088 0;
1089#endif
1090 std::error_code EC;
1091 fs::file_status FileStatus;
1092 TimePoint<> LastAccessTime;
1093 SmallString<128> CrashFilePath;
1094 // Lookup the .crash files and get the one generated by a subprocess spawned
1095 // by this driver invocation.
1096 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
1097 File != FileEnd && !EC; File.increment(EC)) {
1098 StringRef FileName = path::filename(File->path());
1099 if (!FileName.startswith(Name))
1100 continue;
1101 if (fs::status(File->path(), FileStatus))
1102 continue;
1103 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
1104 llvm::MemoryBuffer::getFile(File->path());
1105 if (!CrashFile)
1106 continue;
1107 // The first line should start with "Process:", otherwise this isn't a real
1108 // .crash file.
1109 StringRef Data = CrashFile.get()->getBuffer();
1110 if (!Data.startswith("Process:"))
1111 continue;
1112 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
1113 size_t ParentProcPos = Data.find("Parent Process:");
1114 if (ParentProcPos == StringRef::npos)
1115 continue;
1116 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
1117 if (LineEnd == StringRef::npos)
1118 continue;
1119 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
1120 int OpenBracket = -1, CloseBracket = -1;
1121 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
1122 if (ParentProcess[i] == '[')
1123 OpenBracket = i;
1124 if (ParentProcess[i] == ']')
1125 CloseBracket = i;
1126 }
1127 // Extract the parent process PID from the .crash file and check whether
1128 // it matches this driver invocation pid.
1129 int CrashPID;
1130 if (OpenBracket < 0 || CloseBracket < 0 ||
1131 ParentProcess.slice(OpenBracket + 1, CloseBracket)
1132 .getAsInteger(10, CrashPID) || CrashPID != PID) {
1133 continue;
1134 }
1135
1136 // Found a .crash file matching the driver pid. To avoid getting an older
1137 // and misleading crash file, continue looking for the most recent.
1138 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
1139 // multiple crashes poiting to the same parent process. Since the driver
1140 // does not collect pid information for the dispatched invocation there's
1141 // currently no way to distinguish among them.
1142 const auto FileAccessTime = FileStatus.getLastModificationTime();
1143 if (FileAccessTime > LastAccessTime) {
1144 CrashFilePath.assign(File->path());
1145 LastAccessTime = FileAccessTime;
1146 }
1147 }
1148
1149 // If found, copy it over to the location of other reproducer files.
1150 if (!CrashFilePath.empty()) {
1151 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
1152 if (EC)
1153 return false;
1154 return true;
1155 }
1156
1157 return false;
1158}
1159
Eric Christopherf901e852011-08-17 22:59:59 +00001160// When clang crashes, produce diagnostic information including the fully
1161// preprocessed source file(s). Request that the developer attach the
Chad Rosierbe10f982011-08-02 17:58:04 +00001162// diagnostic information to a bug report.
Alex Lorenz045c5142018-04-07 00:03:27 +00001163void Driver::generateCompilationDiagnostics(
1164 Compilation &C, const Command &FailingCommand,
1165 StringRef AdditionalInformation, CompilationDiagnosticReport *Report) {
Chad Rosier877c0a22012-02-22 00:30:39 +00001166 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
Chad Rosier62135492012-07-09 17:31:28 +00001167 return;
Chad Rosierbee5a1d2012-03-07 00:30:40 +00001168
Chad Rosierdbf46a12013-02-01 18:30:26 +00001169 // Don't try to generate diagnostics for link or dsymutil jobs.
Justin Bognere1a33d12014-10-20 21:02:05 +00001170 if (FailingCommand.getCreator().isLinkJob() ||
1171 FailingCommand.getCreator().isDsymutilJob())
Chad Rosier877c0a22012-02-22 00:30:39 +00001172 return;
1173
Chad Rosier8179f112012-06-19 17:51:34 +00001174 // Print the version of the compiler.
1175 PrintVersion(C, llvm::errs());
1176
Chad Rosierbe10f982011-08-02 17:58:04 +00001177 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001178 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
1179 "crash backtrace, preprocessed source, and associated run script.";
Chad Rosierbe10f982011-08-02 17:58:04 +00001180
1181 // Suppress driver output and emit preprocessor output to temp file.
Hans Wennborg70850d82013-07-18 20:29:38 +00001182 Mode = CPPMode;
Chad Rosierbe10f982011-08-02 17:58:04 +00001183 CCGenDiagnostics = true;
1184
Chad Rosiercdb008d2011-11-02 21:29:05 +00001185 // Save the original job command(s).
Justin Bogner25645152014-10-21 17:24:44 +00001186 Command Cmd = FailingCommand;
Chad Rosiercdb008d2011-11-02 21:29:05 +00001187
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001188 // Keep track of whether we produce any errors while trying to produce
1189 // preprocessed sources.
1190 DiagnosticErrorTrap Trap(Diags);
1191
1192 // Suppress tool output.
Chad Rosierbe10f982011-08-02 17:58:04 +00001193 C.initCompilationForDiagnostics();
Chad Rosierecdede82011-08-12 22:08:57 +00001194
1195 // Construct the list of inputs.
1196 InputList Inputs;
1197 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001198
Chad Rosier4f81fc22011-08-12 23:30:05 +00001199 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001200 bool IgnoreInput = false;
1201
1202 // Ignore input from stdin or any inputs that cannot be preprocessed.
Paul Robinsonf44157d2014-04-28 22:24:44 +00001203 // Check type first as not all linker inputs have a value.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001204 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
Paul Robinsonf44157d2014-04-28 22:24:44 +00001205 IgnoreInput = true;
1206 } else if (!strcmp(it->second->getValue(), "-")) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001207 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001208 << "Error generating preprocessed source(s) - "
1209 "ignoring input from stdin.";
Chad Rosierd57133d2011-08-18 00:22:25 +00001210 IgnoreInput = true;
Chad Rosierd57133d2011-08-18 00:22:25 +00001211 }
1212
1213 if (IgnoreInput) {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001214 it = Inputs.erase(it);
1215 ie = Inputs.end();
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001216 } else {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001217 ++it;
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001218 }
Chad Rosier4f81fc22011-08-12 23:30:05 +00001219 }
Chad Rosierd57133d2011-08-18 00:22:25 +00001220
Chad Rosierc5103c32013-01-29 23:57:10 +00001221 if (Inputs.empty()) {
1222 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001223 << "Error generating preprocessed source(s) - "
1224 "no preprocessable inputs.";
Chad Rosierc5103c32013-01-29 23:57:10 +00001225 return;
1226 }
1227
Chad Rosiere75ef402011-09-06 23:52:36 +00001228 // Don't attempt to generate preprocessed files if multiple -arch options are
Chad Rosier636d2832012-02-13 18:16:28 +00001229 // used, unless they're all duplicates.
1230 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001231 for (const Arg *A : C.getArgs()) {
Chad Rosiere75ef402011-09-06 23:52:36 +00001232 if (A->getOption().matches(options::OPT_arch)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001233 StringRef ArchName = A->getValue();
Chad Rosier636d2832012-02-13 18:16:28 +00001234 ArchNames.insert(ArchName);
Chad Rosiere75ef402011-09-06 23:52:36 +00001235 }
1236 }
Chad Rosier636d2832012-02-13 18:16:28 +00001237 if (ArchNames.size() > 1) {
1238 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001239 << "Error generating preprocessed source(s) - cannot generate "
1240 "preprocessed source with multiple -arch options.";
Chad Rosier636d2832012-02-13 18:16:28 +00001241 return;
1242 }
Chad Rosiere75ef402011-09-06 23:52:36 +00001243
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001244 // Construct the list of abstract actions to perform for this compilation. On
1245 // Darwin OSes this uses the driver-driver and builds universal actions.
Chandler Carruthcb916192012-01-25 08:49:21 +00001246 const ToolChain &TC = C.getDefaultToolChain();
Tim Northover157d9112014-01-16 08:48:16 +00001247 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001248 BuildUniversalActions(C, TC, Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001249 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001250 BuildActions(C, C.getArgs(), Inputs, C.getActions());
Chad Rosierbe10f982011-08-02 17:58:04 +00001251
1252 BuildJobs(C);
1253
1254 // If there were errors building the compilation, quit now.
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001255 if (Trap.hasErrorOccurred()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001256 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001257 << "Error generating preprocessed source(s).";
Chad Rosierbe10f982011-08-02 17:58:04 +00001258 return;
1259 }
1260
1261 // Generate preprocessed output.
Chad Rosierdd60e092013-01-29 20:15:05 +00001262 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
Justin Bogner0cd92482015-07-02 22:52:08 +00001263 C.ExecuteJobs(C.getJobs(), FailingCommands);
Chad Rosierbe10f982011-08-02 17:58:04 +00001264
Justin Bognerbc89b182014-10-20 21:20:27 +00001265 // If any of the preprocessing commands failed, clean up and exit.
1266 if (!FailingCommands.empty()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001267 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001268 << "Error generating preprocessed source(s).";
Justin Bognerbc89b182014-10-20 21:20:27 +00001269 return;
Chad Rosierbe10f982011-08-02 17:58:04 +00001270 }
Justin Bognerbc89b182014-10-20 21:20:27 +00001271
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001272 const ArgStringList &TempFiles = C.getTempFiles();
1273 if (TempFiles.empty()) {
1274 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001275 << "Error generating preprocessed source(s).";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001276 return;
1277 }
1278
Justin Bognerbc89b182014-10-20 21:20:27 +00001279 Diag(clang::diag::note_drv_command_failed_diag_msg)
1280 << "\n********************\n\n"
1281 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
1282 "Preprocessed source(s) and associated run script(s) are located at:";
Justin Bognerbc89b182014-10-20 21:20:27 +00001283
Justin Bogner659ecc32014-10-20 22:47:23 +00001284 SmallString<128> VFS;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001285 SmallString<128> ReproCrashFilename;
Justin Bogner659ecc32014-10-20 22:47:23 +00001286 for (const char *TempFile : TempFiles) {
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001287 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
Alex Lorenz045c5142018-04-07 00:03:27 +00001288 if (Report)
1289 Report->TemporaryFiles.push_back(TempFile);
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001290 if (ReproCrashFilename.empty()) {
1291 ReproCrashFilename = TempFile;
1292 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
1293 }
Justin Bogner659ecc32014-10-20 22:47:23 +00001294 if (StringRef(TempFile).endswith(".cache")) {
1295 // In some cases (modules) we'll dump extra data to help with reproducing
1296 // the crash into a directory next to the output.
1297 VFS = llvm::sys::path::filename(TempFile);
1298 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
1299 }
1300 }
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001301
1302 // Assume associated files are based off of the first temporary file.
Justin Bogner25645152014-10-21 17:24:44 +00001303 CrashReportInfo CrashInfo(TempFiles[0], VFS);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001304
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001305 llvm::SmallString<128> Script(CrashInfo.Filename);
1306 llvm::sys::path::replace_extension(Script, "sh");
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001307 std::error_code EC;
Zachary Turner1f67a3c2018-06-07 19:58:58 +00001308 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::CD_CreateNew);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001309 if (EC) {
1310 Diag(clang::diag::note_drv_command_failed_diag_msg)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001311 << "Error generating run script: " << Script << " " << EC.message();
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001312 } else {
Justin Bogner42220ed2015-03-12 00:14:35 +00001313 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
Justin Bognered9cbe02015-07-09 06:58:31 +00001314 << "# Driver args: ";
1315 printArgList(ScriptOS, C.getInputArgs());
1316 ScriptOS << "# Original command: ";
Justin Bogner42220ed2015-03-12 00:14:35 +00001317 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
Justin Bogner33bdbc62014-10-21 18:03:08 +00001318 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
Alex Lorenz045c5142018-04-07 00:03:27 +00001319 if (!AdditionalInformation.empty())
1320 ScriptOS << "\n# Additional information: " << AdditionalInformation
1321 << "\n";
1322 if (Report)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001323 Report->TemporaryFiles.push_back(Script.str());
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001324 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
Justin Bognerbc89b182014-10-20 21:20:27 +00001325 }
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001326
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001327 // On darwin, provide information about the .crash diagnostic report.
1328 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
1329 SmallString<128> CrashDiagDir;
1330 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
1331 Diag(clang::diag::note_drv_command_failed_diag_msg)
1332 << ReproCrashFilename.str();
1333 } else { // Suggest a directory for the user to look for .crash files.
1334 llvm::sys::path::append(CrashDiagDir, Name);
1335 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
1336 Diag(clang::diag::note_drv_command_failed_diag_msg)
1337 << "Crash backtrace is located in";
1338 Diag(clang::diag::note_drv_command_failed_diag_msg)
1339 << CrashDiagDir.str();
1340 Diag(clang::diag::note_drv_command_failed_diag_msg)
1341 << "(choose the .crash file that corresponds to your crash)";
1342 }
1343 }
1344
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001345 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1346 options::OPT_frewrite_map_file_EQ))
1347 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1348
Justin Bognerbc89b182014-10-20 21:20:27 +00001349 Diag(clang::diag::note_drv_command_failed_diag_msg)
1350 << "\n\n********************";
Chad Rosierbe10f982011-08-02 17:58:04 +00001351}
1352
Justin Bogner0cd92482015-07-02 22:52:08 +00001353void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
Oleg Ranevskyycd516372016-01-05 19:54:39 +00001354 // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001355 // if the tool does not support response files, there is a chance/ that things
1356 // will just work without a response file, so we silently just skip it.
Justin Bogner0cd92482015-07-02 22:52:08 +00001357 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
Oleg Ranevskyycd516372016-01-05 19:54:39 +00001358 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001359 return;
1360
1361 std::string TmpName = GetTemporaryPath("response", "txt");
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00001362 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001363}
1364
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001365int Driver::ExecuteCompilation(
1366 Compilation &C,
1367 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001368 // Just print if -### was present.
1369 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Hans Wennborgb212b342013-09-12 18:23:34 +00001370 C.getJobs().Print(llvm::errs(), "\n", true);
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001371 return 0;
1372 }
1373
1374 // If there were errors building the compilation, quit now.
Chad Rosierbe10f982011-08-02 17:58:04 +00001375 if (Diags.hasErrorOccurred())
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001376 return 1;
1377
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001378 // Set up response file names for each command, if necessary
Justin Bogner0cd92482015-07-02 22:52:08 +00001379 for (auto &Job : C.getJobs())
1380 setUpResponseFiles(C, Job);
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001381
Justin Bogner0cd92482015-07-02 22:52:08 +00001382 C.ExecuteJobs(C.getJobs(), FailingCommands);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001383
Daniel Dunbar07494792010-05-22 00:37:20 +00001384 // If the command succeeded, we are done.
Chad Rosierdd60e092013-01-29 20:15:05 +00001385 if (FailingCommands.empty())
1386 return 0;
Daniel Dunbar07494792010-05-22 00:37:20 +00001387
Chad Rosierdd60e092013-01-29 20:15:05 +00001388 // Otherwise, remove result files and print extra information about abnormal
1389 // failures.
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001390 for (const auto &CmdPair : FailingCommands) {
1391 int Res = CmdPair.first;
1392 const Command *FailingCommand = CmdPair.second;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001393
Chad Rosierdd60e092013-01-29 20:15:05 +00001394 // Remove result files if we're not saving temps.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001395 if (!isSaveTempsEnabled()) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001396 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1397 C.CleanupFileMap(C.getResultFiles(), JA, true);
1398
1399 // Failure result files are valid unless we crashed.
1400 if (Res < 0)
1401 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1402 }
1403
1404 // Print extra information about abnormal failures, if possible.
1405 //
1406 // This is ad-hoc, but we don't want to be excessively noisy. If the result
Justin Bogner5aaf2e72014-06-26 20:59:36 +00001407 // status was 1, assume the command failed normally. In particular, if it
Chad Rosierdd60e092013-01-29 20:15:05 +00001408 // was the compiler then assume it gave a reasonable error code. Failures
1409 // in other tools are less common, and they generally have worse
1410 // diagnostics, so always print the diagnostic there.
1411 const Tool &FailingTool = FailingCommand->getCreator();
1412
1413 if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
1414 // FIXME: See FIXME above regarding result code interpretation.
1415 if (Res < 0)
1416 Diag(clang::diag::err_drv_command_signalled)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001417 << FailingTool.getShortName();
Chad Rosierdd60e092013-01-29 20:15:05 +00001418 else
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001419 Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
1420 << Res;
Chad Rosierdd60e092013-01-29 20:15:05 +00001421 }
Peter Collingbourne119cfaa2011-11-21 00:01:05 +00001422 }
Chad Rosierdd60e092013-01-29 20:15:05 +00001423 return 0;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001424}
1425
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001426void Driver::PrintHelp(bool ShowHidden) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001427 unsigned IncludedFlagsBitmask;
1428 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001429 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001430 getIncludeExcludeOptionFlagMasks();
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001431
1432 ExcludedFlagsBitmask |= options::NoDriverOption;
1433 if (!ShowHidden)
1434 ExcludedFlagsBitmask |= HelpHidden;
1435
1436 getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
George Rimar5dbfa4e2017-07-26 09:10:17 +00001437 IncludedFlagsBitmask, ExcludedFlagsBitmask,
1438 /*ShowAllAliases=*/false);
Daniel Dunbar7c925282009-03-31 21:38:17 +00001439}
1440
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001441void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001442 // FIXME: The following handlers should use a callback mechanism, we don't
1443 // know what the client would like to do.
Ted Kremenek4c0df3d2010-01-23 02:11:34 +00001444 OS << getClangFullVersion() << '\n';
Daniel Dunbarb10248802009-03-26 16:09:13 +00001445 const ToolChain &TC = C.getDefaultToolChain();
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001446 OS << "Target: " << TC.getTripleString() << '\n';
Daniel Dunbar10978e42009-06-16 23:32:58 +00001447
1448 // Print the threading model.
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001449 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1450 // Don't print if the ToolChain would have barfed on it already
1451 if (TC.isThreadModelSupported(A->getValue()))
1452 OS << "Thread model: " << A->getValue();
1453 } else
1454 OS << "Thread model: " << TC.getThreadModel();
1455 OS << '\n';
Chandler Carruth9ade6a92015-08-05 17:07:33 +00001456
1457 // Print out the install directory.
1458 OS << "InstalledDir: " << InstalledDir << '\n';
Serge Pavlov208ac652018-01-01 13:27:01 +00001459
1460 // If configuration file was used, print its path.
1461 if (!ConfigFile.empty())
1462 OS << "Configuration file: " << ConfigFile << '\n';
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001463}
1464
Chris Lattner86ed5b02010-05-05 05:53:24 +00001465/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1466/// option.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001467static void PrintDiagnosticCategories(raw_ostream &OS) {
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001468 // Skip the empty category.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001469 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1470 ++i)
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001471 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
Chris Lattner86ed5b02010-05-05 05:53:24 +00001472}
1473
Yuka Takahashi41789e42018-03-05 08:54:20 +00001474void Driver::HandleAutocompletions(StringRef PassedFlags) const {
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001475 if (PassedFlags == "")
1476 return;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001477 // Print out all options that start with a given argument. This is used for
1478 // shell autocompletion.
1479 std::vector<std::string> SuggestedCompletions;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001480 std::vector<std::string> Flags;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001481
1482 unsigned short DisableFlags =
1483 options::NoDriverOption | options::Unsupported | options::Ignored;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001484
1485 // Parse PassedFlags by "," as all the command-line flags are passed to this
1486 // function separated by ","
1487 StringRef TargetFlags = PassedFlags;
1488 while (TargetFlags != "") {
1489 StringRef CurFlag;
1490 std::tie(CurFlag, TargetFlags) = TargetFlags.split(",");
1491 Flags.push_back(std::string(CurFlag));
Yuka Takahashi1a895202017-08-29 17:46:46 +00001492 }
1493
Yuka Takahashi41789e42018-03-05 08:54:20 +00001494 // We want to show cc1-only options only when clang is invoked with -cc1 or
1495 // -Xclang.
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001496 if (std::find(Flags.begin(), Flags.end(), "-Xclang") != Flags.end() ||
1497 std::find(Flags.begin(), Flags.end(), "-cc1") != Flags.end())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001498 DisableFlags &= ~options::NoDriverOption;
1499
1500 StringRef Cur;
1501 Cur = Flags.at(Flags.size() - 1);
1502 StringRef Prev;
1503 if (Flags.size() >= 2) {
1504 Prev = Flags.at(Flags.size() - 2);
1505 SuggestedCompletions = Opts->suggestValueCompletions(Prev, Cur);
1506 }
1507
1508 if (SuggestedCompletions.empty())
1509 SuggestedCompletions = Opts->suggestValueCompletions(Cur, "");
1510
1511 if (SuggestedCompletions.empty()) {
Yuka Takahashi1a895202017-08-29 17:46:46 +00001512 // If the flag is in the form of "--autocomplete=-foo",
1513 // we were requested to print out all option names that start with "-foo".
1514 // For example, "--autocomplete=-fsyn" is expanded to "-fsyntax-only".
Yuka Takahashi41789e42018-03-05 08:54:20 +00001515 SuggestedCompletions = Opts->findByPrefix(Cur, DisableFlags);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001516
1517 // We have to query the -W flags manually as they're not in the OptTable.
1518 // TODO: Find a good way to add them to OptTable instead and them remove
1519 // this code.
1520 for (StringRef S : DiagnosticIDs::getDiagnosticFlags())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001521 if (S.startswith(Cur))
Yuka Takahashi1a895202017-08-29 17:46:46 +00001522 SuggestedCompletions.push_back(S);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001523 }
1524
1525 // Sort the autocomplete candidates so that shells print them out in a
1526 // deterministic order. We could sort in any way, but we chose
1527 // case-insensitive sorting for consistency with the -help option
1528 // which prints out options in the case-insensitive alphabetical order.
Fangrui Song55fab262018-09-26 22:16:28 +00001529 llvm::sort(SuggestedCompletions, [](StringRef A, StringRef B) {
1530 if (int X = A.compare_lower(B))
1531 return X < 0;
1532 return A.compare(B) > 0;
1533 });
Yuka Takahashi1a895202017-08-29 17:46:46 +00001534
1535 llvm::outs() << llvm::join(SuggestedCompletions, "\n") << '\n';
1536}
1537
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001538bool Driver::HandleImmediateArgs(const Compilation &C) {
Daniel Dunbar18974bd2010-06-11 22:00:19 +00001539 // The order these options are handled in gcc is all over the place, but we
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001540 // don't expect inconsistencies w.r.t. that to matter in practice.
Daniel Dunbar7c925282009-03-31 21:38:17 +00001541
Daniel Dunbar1b09e042010-09-17 02:47:28 +00001542 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1543 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1544 return false;
1545 }
1546
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001547 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
Daniel Dunbare26e5002011-01-12 00:43:47 +00001548 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1549 // return an answer which matches our definition of __VERSION__.
1550 //
1551 // If we want to return a more correct answer some day, then we should
1552 // introduce a non-pedantically GCC compatible mode to Clang in which we
1553 // provide sensible definitions for -dumpversion, __VERSION__, etc.
1554 llvm::outs() << "4.2.1\n";
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001555 return false;
1556 }
Daniel Dunbarfb3d7472010-06-14 21:23:12 +00001557
Chris Lattner86ed5b02010-05-05 05:53:24 +00001558 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1559 PrintDiagnosticCategories(llvm::outs());
1560 return false;
1561 }
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001562
James Molloya3c85b82012-05-01 14:57:16 +00001563 if (C.getArgs().hasArg(options::OPT_help) ||
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001564 C.getArgs().hasArg(options::OPT__help_hidden)) {
1565 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
Daniel Dunbar7c925282009-03-31 21:38:17 +00001566 return false;
1567 }
1568
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001569 if (C.getArgs().hasArg(options::OPT__version)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001570 // Follow gcc behavior and use stdout for --version and stderr for -v.
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001571 PrintVersion(C, llvm::outs());
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001572 return false;
1573 }
1574
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001575 if (C.getArgs().hasArg(options::OPT_v) ||
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001576 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001577 PrintVersion(C, llvm::errs());
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001578 SuppressMissingInputWarning = true;
1579 }
1580
Serge Pavlov208ac652018-01-01 13:27:01 +00001581 if (C.getArgs().hasArg(options::OPT_v)) {
1582 if (!SystemConfigDir.empty())
1583 llvm::errs() << "System configuration file directory: "
1584 << SystemConfigDir << "\n";
1585 if (!UserConfigDir.empty())
1586 llvm::errs() << "User configuration file directory: "
1587 << UserConfigDir << "\n";
1588 }
1589
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001590 const ToolChain &TC = C.getDefaultToolChain();
Chandler Carruth0ae39aa2013-07-30 17:57:09 +00001591
1592 if (C.getArgs().hasArg(options::OPT_v))
1593 TC.printVerboseInfo(llvm::errs());
1594
Meador Inge51208a32017-04-04 21:46:50 +00001595 if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
Meador Ingea9113952017-04-05 22:27:20 +00001596 llvm::outs() << ResourceDir << '\n';
Meador Inge51208a32017-04-04 21:46:50 +00001597 return false;
1598 }
1599
Daniel Dunbard972e222009-03-20 04:37:21 +00001600 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1601 llvm::outs() << "programs: =";
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001602 bool separator = false;
1603 for (const std::string &Path : TC.getProgramPaths()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001604 if (separator)
1605 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001606 llvm::outs() << Path;
1607 separator = true;
Daniel Dunbard972e222009-03-20 04:37:21 +00001608 }
1609 llvm::outs() << "\n";
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001610 llvm::outs() << "libraries: =" << ResourceDir;
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001611
Sebastian Pop980920a2012-04-16 04:16:43 +00001612 StringRef sysroot = C.getSysRoot();
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001613
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001614 for (const std::string &Path : TC.getFilePaths()) {
1615 // Always print a separator. ResourceDir was the first item shown.
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001616 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001617 // Interpretation of leading '=' is needed only for NetBSD.
1618 if (Path[0] == '=')
Douglas Katzman26eabf62015-06-24 15:10:30 +00001619 llvm::outs() << sysroot << Path.substr(1);
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001620 else
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001621 llvm::outs() << Path;
Daniel Dunbard972e222009-03-20 04:37:21 +00001622 }
1623 llvm::outs() << "\n";
Daniel Dunbar7c925282009-03-31 21:38:17 +00001624 return false;
Daniel Dunbard972e222009-03-20 04:37:21 +00001625 }
1626
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001627 // FIXME: The following handlers should use a callback mechanism, we don't
1628 // know what the client would like to do.
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001629 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001630 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001631 return false;
1632 }
1633
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001634 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
Saleem Abdulrasoole5f3cf82018-05-01 18:40:42 +00001635 StringRef ProgName = A->getValue();
1636
1637 // Null program name cannot have a path.
1638 if (! ProgName.empty())
1639 llvm::outs() << GetProgramPath(ProgName, TC);
1640
1641 llvm::outs() << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001642 return false;
1643 }
1644
Yuka Takahashic8068db2017-05-23 18:39:08 +00001645 if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
Yuka Takahashiba5d4af2017-06-20 16:31:31 +00001646 StringRef PassedFlags = A->getValue();
Yuka Takahashi41789e42018-03-05 08:54:20 +00001647 HandleAutocompletions(PassedFlags);
Yuka Takahashic8068db2017-05-23 18:39:08 +00001648 return false;
1649 }
1650
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001651 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
Michal Gorny7cfe4802016-10-10 12:23:40 +00001652 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
Leo Li23bb21c2017-08-24 01:51:51 +00001653 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1654 RegisterEffectiveTriple TripleRAII(TC, Triple);
Michal Gorny7cfe4802016-10-10 12:23:40 +00001655 switch (RLT) {
1656 case ToolChain::RLT_CompilerRT:
1657 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1658 break;
1659 case ToolChain::RLT_Libgcc:
1660 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1661 break;
1662 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001663 return false;
1664 }
1665
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001666 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001667 for (const Multilib &Multilib : TC.getMultilibs())
1668 llvm::outs() << Multilib << "\n";
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001669 return false;
1670 }
1671
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001672 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
Christian Bruel6ccc4a72018-09-06 14:03:44 +00001673 const Multilib &Multilib = TC.getMultilib();
1674 if (Multilib.gccSuffix().empty())
1675 llvm::outs() << ".\n";
1676 else {
1677 StringRef Suffix(Multilib.gccSuffix());
1678 assert(Suffix.front() == '/');
1679 llvm::outs() << Suffix.substr(1) << "\n";
Jonathan Roelofs3fa96d82014-02-12 01:36:51 +00001680 }
Jonathan Roelofs0e7ec602014-02-12 01:29:25 +00001681 return false;
1682 }
Petr Hosekbc86a992018-08-16 00:22:03 +00001683
1684 if (C.getArgs().hasArg(options::OPT_print_target_triple)) {
1685 llvm::outs() << TC.getTripleString() << "\n";
1686 return false;
1687 }
1688
1689 if (C.getArgs().hasArg(options::OPT_print_effective_triple)) {
1690 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1691 llvm::outs() << Triple.getTriple() << "\n";
1692 return false;
1693 }
1694
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001695 return true;
1696}
1697
Douglas Katzmanfd528672015-06-11 15:05:22 +00001698// Display an action graph human-readably. Action A is the "sink" node
1699// and latest-occuring action. Traversal is in pre-order, visiting the
1700// inputs to each action before printing the action itself.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001701static unsigned PrintActions1(const Compilation &C, Action *A,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001702 std::map<Action *, unsigned> &Ids) {
Douglas Katzmanfd528672015-06-11 15:05:22 +00001703 if (Ids.count(A)) // A was already visited.
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001704 return Ids[A];
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001705
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001706 std::string str;
1707 llvm::raw_string_ostream os(str);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001708
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001709 os << Action::getClassName(A->getKind()) << ", ";
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001710 if (InputAction *IA = dyn_cast<InputAction>(A)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001711 os << "\"" << IA->getInputArg().getValue() << "\"";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001712 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001713 os << '"' << BIA->getArchName() << '"' << ", {"
Nico Weber5a459f82016-02-23 19:30:43 +00001714 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
Samuel Antaod06239d2016-07-15 23:13:27 +00001715 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1716 bool IsFirst = true;
1717 OA->doOnEachDependence(
1718 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1719 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1720 // sm_35 this will generate:
1721 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1722 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1723 if (!IsFirst)
1724 os << ", ";
1725 os << '"';
1726 if (TC)
1727 os << A->getOffloadingKindPrefix();
1728 else
1729 os << "host";
1730 os << " (";
1731 os << TC->getTriple().normalize();
1732
1733 if (BoundArch)
1734 os << ":" << BoundArch;
1735 os << ")";
1736 os << '"';
1737 os << " {" << PrintActions1(C, A, Ids) << "}";
1738 IsFirst = false;
1739 });
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001740 } else {
Samuel Antaod06239d2016-07-15 23:13:27 +00001741 const ActionList *AL = &A->getInputs();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00001742
Artem Belevich23256752015-09-22 17:23:09 +00001743 if (AL->size()) {
1744 const char *Prefix = "{";
1745 for (Action *PreRequisite : *AL) {
1746 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1747 Prefix = ", ";
1748 }
1749 os << "}";
1750 } else
1751 os << "{}";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001752 }
1753
Samuel Antaod06239d2016-07-15 23:13:27 +00001754 // Append offload info for all options other than the offloading action
1755 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1756 std::string offload_str;
1757 llvm::raw_string_ostream offload_os(offload_str);
1758 if (!isa<OffloadAction>(A)) {
1759 auto S = A->getOffloadingKindPrefix();
1760 if (!S.empty()) {
1761 offload_os << ", (" << S;
1762 if (A->getOffloadingArch())
1763 offload_os << ", " << A->getOffloadingArch();
1764 offload_os << ")";
1765 }
1766 }
1767
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001768 unsigned Id = Ids.size();
1769 Ids[A] = Id;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001770 llvm::errs() << Id << ": " << os.str() << ", "
Samuel Antaod06239d2016-07-15 23:13:27 +00001771 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001772
1773 return Id;
1774}
1775
Douglas Katzmanfd528672015-06-11 15:05:22 +00001776// Print the action graphs in a compilation C.
1777// For example "clang -c file1.c file2.c" is composed of two subgraphs.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001778void Driver::PrintActions(const Compilation &C) const {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001779 std::map<Action *, unsigned> Ids;
1780 for (Action *A : C.getActions())
1781 PrintActions1(C, A, Ids);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001782}
1783
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001784/// Check whether the given input tree contains any compilation or
Joerg Sonnenberger5fe4a7d2011-05-06 14:05:11 +00001785/// assembly actions.
1786static bool ContainsCompileOrAssembleAction(const Action *A) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001787 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
Bob Wilson23a55f12014-12-21 07:00:00 +00001788 isa<AssembleJobAction>(A))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001789 return true;
1790
Nico Weber5a459f82016-02-23 19:30:43 +00001791 for (const Action *Input : A->inputs())
Nico Weberfb80f962015-09-19 21:36:51 +00001792 if (ContainsCompileOrAssembleAction(Input))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001793 return true;
1794
1795 return false;
1796}
1797
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001798void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1799 const InputList &BAInputs) const {
1800 DerivedArgList &Args = C.getArgs();
1801 ActionList &Actions = C.getActions();
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001802 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1803 // Collect the list of architectures. Duplicates are allowed, but should only
1804 // be handled once (in the order seen).
Daniel Dunbare5dc4822009-03-13 20:33:35 +00001805 llvm::StringSet<> ArchNames;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001806 SmallVector<const char *, 4> Archs;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001807 for (Arg *A : Args) {
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001808 if (A->getOption().matches(options::OPT_arch)) {
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001809 // Validate the option here; we don't save the type here because its
1810 // particular spelling may participate in other driver choices.
1811 llvm::Triple::ArchType Arch =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001812 tools::darwin::getArchTypeForMachOArchName(A->getValue());
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001813 if (Arch == llvm::Triple::UnknownArch) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001814 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001815 continue;
1816 }
1817
Daniel Dunbar2da02722009-03-19 07:55:12 +00001818 A->claim();
David Blaikie61b86d42014-11-19 02:56:13 +00001819 if (ArchNames.insert(A->getValue()).second)
Richard Smithbd55daf2012-11-01 04:30:05 +00001820 Archs.push_back(A->getValue());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001821 }
1822 }
1823
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001824 // When there is no explicit arch for this platform, make sure we still bind
1825 // the architecture (to the default) so that -Xarch_ is handled correctly.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001826 if (!Archs.size())
Daniel Dunbarc3bd9f52012-11-08 03:38:26 +00001827 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001828
Daniel Dunbarf479c122009-03-12 18:40:18 +00001829 ActionList SingleActions;
Justin Lebar0f3474c2016-02-11 02:00:50 +00001830 BuildActions(C, Args, BAInputs, SingleActions);
Daniel Dunbarf479c122009-03-12 18:40:18 +00001831
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001832 // Add in arch bindings for every top level action, as well as lipo and
1833 // dsymutil steps if needed.
Nico Weberfb80f962015-09-19 21:36:51 +00001834 for (Action* Act : SingleActions) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001835 // Make sure we can lipo this kind of output. If not (and it is an actual
1836 // output) then we disallow, since we can't create an output file with the
1837 // right name without overwriting it. We could remove this oddity by just
1838 // changing the output names to include the arch, which would also fix
Daniel Dunbarf479c122009-03-12 18:40:18 +00001839 // -save-temps. Compatibility wins for now.
1840
Daniel Dunbare2ca3bd2009-03-13 17:46:02 +00001841 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
Daniel Dunbarf479c122009-03-12 18:40:18 +00001842 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001843 << types::getTypeName(Act->getType());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001844
1845 ActionList Inputs;
Justin Lebar41094612016-01-11 23:07:27 +00001846 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1847 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001848
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001849 // Lipo if necessary, we do it this way because we need to set the arch flag
1850 // so that -Xarch_ gets overwritten.
Daniel Dunbarf479c122009-03-12 18:40:18 +00001851 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1852 Actions.append(Inputs.begin(), Inputs.end());
1853 else
Justin Lebar41094612016-01-11 23:07:27 +00001854 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001855
Eric Christopher65c05fa2012-02-06 19:43:51 +00001856 // Handle debug info queries.
1857 Arg *A = Args.getLastArg(options::OPT_g_Group);
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001858 if (A && !A->getOption().matches(options::OPT_g0) &&
1859 !A->getOption().matches(options::OPT_gstabs) &&
1860 ContainsCompileOrAssembleAction(Actions.back())) {
Chad Rosier62135492012-07-09 17:31:28 +00001861
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001862 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1863 // have a compile input. We need to run 'dsymutil' ourselves in such cases
Eric Christopher776c26f2013-01-28 17:39:03 +00001864 // because the debug info will refer to a temporary object file which
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001865 // will be removed at the end of the compilation process.
1866 if (Act->getType() == types::TY_Image) {
1867 ActionList Inputs;
1868 Inputs.push_back(Actions.back());
1869 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001870 Actions.push_back(
1871 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001872 }
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001873
Ben Langmuir9b9a8d32014-02-06 18:53:25 +00001874 // Verify the debug info output.
Alp Tokere9d2bfc2014-01-17 02:06:23 +00001875 if (Args.hasArg(options::OPT_verify_debug_info)) {
Justin Lebar41094612016-01-11 23:07:27 +00001876 Action* LastAction = Actions.back();
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001877 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001878 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1879 LastAction, types::TY_Nothing));
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001880 }
1881 }
Daniel Dunbarf479c122009-03-12 18:40:18 +00001882 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001883}
1884
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001885/// Check that the file referenced by Value exists. If it doesn't,
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001886/// issue a diagnostic and return false.
Alp Toker8c8a8752013-12-03 06:53:35 +00001887static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001888 StringRef Value, types::ID Ty) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001889 if (!D.getCheckInputsExist())
1890 return true;
1891
1892 // stdin always exists.
1893 if (Value == "-")
1894 return true;
1895
1896 SmallString<64> Path(Value);
1897 if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
Yaron Keren92e1b622015-03-18 10:17:07 +00001898 if (!llvm::sys::path::is_absolute(Path)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001899 SmallString<64> Directory(WorkDir->getValue());
1900 llvm::sys::path::append(Directory, Value);
1901 Path.assign(Directory);
1902 }
1903 }
1904
1905 if (llvm::sys::fs::exists(Twine(Path)))
1906 return true;
1907
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001908 if (D.IsCLMode()) {
1909 if (!llvm::sys::path::is_absolute(Twine(Path)) &&
1910 llvm::sys::Process::FindInEnvPath("LIB", Value))
1911 return true;
1912
1913 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
1914 // Arguments to the /link flag might cause the linker to search for object
1915 // and library files in paths we don't know about. Don't error in such
1916 // cases.
1917 return true;
1918 }
1919 }
Hans Wennborg23d26a32014-06-18 17:21:50 +00001920
Yaron Keren92e1b622015-03-18 10:17:07 +00001921 D.Diag(clang::diag::err_drv_no_such_file) << Path;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001922 return false;
1923}
1924
Chad Rosierecdede82011-08-12 22:08:57 +00001925// Construct a the list of inputs and their types.
Hans Wennborg55362852014-05-02 22:55:30 +00001926void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
Chad Rosierecdede82011-08-12 22:08:57 +00001927 InputList &Inputs) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001928 // Track the current user specified (-x) input. We also explicitly track the
1929 // argument used to set the type; we only want to claim the type when we
1930 // actually use it, so we warn about unused -x arguments.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001931 types::ID InputType = types::TY_Nothing;
Craig Topper92fc2df2014-05-17 16:56:41 +00001932 Arg *InputTypeArg = nullptr;
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001933
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001934 // The last /TC or /TP option sets the input type to C or C++ globally.
Ehsan Akhgaric249abb2014-09-12 21:44:24 +00001935 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1936 options::OPT__SLASH_TP)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001937 InputTypeArg = TCTP;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001938 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001939 ? types::TY_C
1940 : types::TY_CXX;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001941
Richard Smith0aef3052017-02-18 01:14:43 +00001942 Arg *Previous = nullptr;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001943 bool ShowNote = false;
Richard Smith0aef3052017-02-18 01:14:43 +00001944 for (Arg *A : Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
1945 if (Previous) {
1946 Diag(clang::diag::warn_drv_overriding_flag_option)
1947 << Previous->getSpelling() << A->getSpelling();
1948 ShowNote = true;
1949 }
1950 Previous = A;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001951 }
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001952 if (ShowNote)
1953 Diag(clang::diag::note_drv_t_option_is_global);
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001954
1955 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1956 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1957 }
1958
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001959 for (Arg *A : Args) {
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00001960 if (A->getOption().getKind() == Option::InputClass) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001961 const char *Value = A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001962 types::ID Ty = types::TY_INVALID;
1963
1964 // Infer the input type if necessary.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001965 if (InputType == types::TY_Nothing) {
1966 // If there was an explicit arg for this, claim it.
1967 if (InputTypeArg)
1968 InputTypeArg->claim();
1969
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001970 // stdin must be handled specially.
1971 if (memcmp(Value, "-", 2) == 0) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001972 // If running with -E, treat as a C input (this changes the builtin
1973 // macros, for example). This may be overridden by -ObjC below.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001974 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001975 // Otherwise emit an error but still use a valid type to avoid
1976 // spurious errors (e.g., no inputs).
Hans Wennborg70850d82013-07-18 20:29:38 +00001977 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
Hans Wennborgcfdd8b52014-01-29 01:04:40 +00001978 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1979 : clang::diag::err_drv_unknown_stdin_type);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001980 Ty = types::TY_C;
1981 } else {
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001982 // Otherwise lookup by extension.
1983 // Fallback is C if invoked as C preprocessor or Object otherwise.
1984 // We use a host hook here because Darwin at least has its own
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001985 // idea of what .s is.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001986 if (const char *Ext = strrchr(Value, '.'))
Daniel Dunbarcc7df6c2010-08-02 05:43:56 +00001987 Ty = TC.LookupTypeForExtension(Ext + 1);
Daniel Dunbarea9f0322009-03-20 23:39:23 +00001988
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001989 if (Ty == types::TY_INVALID) {
Hans Wennborg70850d82013-07-18 20:29:38 +00001990 if (CCCIsCPP())
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001991 Ty = types::TY_C;
1992 else
1993 Ty = types::TY_Object;
1994 }
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001995
1996 // If the driver is invoked as C++ compiler (like clang++ or c++) it
1997 // should autodetect some input files as C++ for g++ compatibility.
Hans Wennborg70850d82013-07-18 20:29:38 +00001998 if (CCCIsCXX()) {
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001999 types::ID OldTy = Ty;
2000 Ty = types::lookupCXXTypeForCType(Ty);
2001
2002 if (Ty != OldTy)
2003 Diag(clang::diag::warn_drv_treating_input_as_cxx)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002004 << getTypeName(OldTy) << getTypeName(Ty);
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002005 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002006 }
2007
Daniel Dunbar82b22102009-05-18 21:47:54 +00002008 // -ObjC and -ObjC++ override the default language, but only for "source
2009 // files". We just treat everything that isn't a linker input as a
2010 // source file.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002011 //
Daniel Dunbar82b22102009-05-18 21:47:54 +00002012 // FIXME: Clean this up if we move the phase sequence into the type.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002013 if (Ty != types::TY_Object) {
2014 if (Args.hasArg(options::OPT_ObjC))
2015 Ty = types::TY_ObjC;
2016 else if (Args.hasArg(options::OPT_ObjCXX))
2017 Ty = types::TY_ObjCXX;
2018 }
2019 } else {
2020 assert(InputTypeArg && "InputType set w/o InputTypeArg");
Ehsan Akhgari7e954ea2014-09-12 18:15:10 +00002021 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
2022 // If emulating cl.exe, make sure that /TC and /TP don't affect input
2023 // object files.
2024 const char *Ext = strrchr(Value, '.');
2025 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
2026 Ty = types::TY_Object;
2027 }
2028 if (Ty == types::TY_INVALID) {
2029 Ty = InputType;
2030 InputTypeArg->claim();
2031 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002032 }
2033
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002034 if (DiagnoseInputExistence(*this, Args, Value, Ty))
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002035 Inputs.push_back(std::make_pair(Ty, A));
2036
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002037 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
2038 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002039 if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002040 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002041 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
2042 }
2043 A->claim();
2044 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
2045 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002046 if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002047 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002048 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
2049 }
2050 A->claim();
Michael J. Spencer66e2b202012-10-19 22:37:06 +00002051 } else if (A->getOption().hasFlag(options::LinkerInput)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002052 // Just treat as object type, we could make a special type for this if
2053 // necessary.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002054 Inputs.push_back(std::make_pair(types::TY_Object, A));
2055
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00002056 } else if (A->getOption().matches(options::OPT_x)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002057 InputTypeArg = A;
Richard Smithbd55daf2012-11-01 04:30:05 +00002058 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
Chad Rosier706c2352012-04-07 00:01:31 +00002059 A->claim();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002060
2061 // Follow gcc behavior and treat as linker input for invalid -x
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002062 // options. Its not clear why we shouldn't just revert to unknown; but
Michael J. Spencer1a4fe8c2010-12-17 21:22:33 +00002063 // this isn't very important, we might as well be bug compatible.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002064 if (!InputType) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002065 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002066 InputType = types::TY_Object;
2067 }
Hans Wennborg091f1b62017-01-27 17:09:41 +00002068 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
2069 assert(A->getNumValues() == 1 && "The /U option has one value.");
2070 StringRef Val = A->getValue(0);
2071 if (Val.find_first_of("/\\") != StringRef::npos) {
2072 // Warn about e.g. "/Users/me/myfile.c".
2073 Diag(diag::warn_slash_u_filename) << Val;
2074 Diag(diag::note_use_dashdash);
2075 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002076 }
2077 }
Hans Wennborg70850d82013-07-18 20:29:38 +00002078 if (CCCIsCPP() && Inputs.empty()) {
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002079 // If called as standalone preprocessor, stdin is processed
2080 // if no other input is present.
David Blaikie0aaa7622017-01-13 17:34:15 +00002081 Arg *A = MakeInputArg(Args, *Opts, "-");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002082 Inputs.push_back(std::make_pair(types::TY_C, A));
2083 }
Chad Rosierecdede82011-08-12 22:08:57 +00002084}
2085
Samuel Antao64e965e2016-09-30 15:34:19 +00002086namespace {
2087/// Provides a convenient interface for different programming models to generate
2088/// the required device actions.
2089class OffloadingActionBuilder final {
2090 /// Flag used to trace errors in the builder.
2091 bool IsValid = false;
2092
2093 /// The compilation that is using this builder.
2094 Compilation &C;
2095
Samuel Antao64e965e2016-09-30 15:34:19 +00002096 /// Map between an input argument and the offload kinds used to process it.
2097 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
2098
2099 /// Builder interface. It doesn't build anything or keep any state.
2100 class DeviceActionBuilder {
2101 public:
2102 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
2103
2104 enum ActionBuilderReturnCode {
2105 // The builder acted successfully on the current action.
2106 ABRT_Success,
2107 // The builder didn't have to act on the current action.
2108 ABRT_Inactive,
2109 // The builder was successful and requested the host action to not be
2110 // generated.
2111 ABRT_Ignore_Host,
2112 };
2113
2114 protected:
2115 /// Compilation associated with this builder.
2116 Compilation &C;
2117
2118 /// Tool chains associated with this builder. The same programming
2119 /// model may have associated one or more tool chains.
2120 SmallVector<const ToolChain *, 2> ToolChains;
2121
2122 /// The derived arguments associated with this builder.
2123 DerivedArgList &Args;
2124
2125 /// The inputs associated with this builder.
2126 const Driver::InputList &Inputs;
2127
2128 /// The associated offload kind.
2129 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
2130
2131 public:
2132 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
2133 const Driver::InputList &Inputs,
2134 Action::OffloadKind AssociatedOffloadKind)
2135 : C(C), Args(Args), Inputs(Inputs),
2136 AssociatedOffloadKind(AssociatedOffloadKind) {}
2137 virtual ~DeviceActionBuilder() {}
2138
2139 /// Fill up the array \a DA with all the device dependences that should be
2140 /// added to the provided host action \a HostAction. By default it is
2141 /// inactive.
2142 virtual ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002143 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2144 phases::ID CurPhase, phases::ID FinalPhase,
2145 PhasesTy &Phases) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002146 return ABRT_Inactive;
2147 }
2148
2149 /// Update the state to include the provided host action \a HostAction as a
2150 /// dependency of the current device action. By default it is inactive.
2151 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
2152 return ABRT_Inactive;
2153 }
2154
2155 /// Append top level actions generated by the builder. Return true if errors
2156 /// were found.
2157 virtual void appendTopLevelActions(ActionList &AL) {}
2158
2159 /// Append linker actions generated by the builder. Return true if errors
2160 /// were found.
2161 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
2162
2163 /// Initialize the builder. Return true if any initialization errors are
2164 /// found.
2165 virtual bool initialize() { return false; }
2166
Samuel Antao69d6f312016-10-27 17:50:43 +00002167 /// Return true if the builder can use bundling/unbundling.
2168 virtual bool canUseBundlerUnbundler() const { return false; }
2169
Samuel Antao64e965e2016-09-30 15:34:19 +00002170 /// Return true if this builder is valid. We have a valid builder if we have
2171 /// associated device tool chains.
2172 bool isValid() { return !ToolChains.empty(); }
2173
2174 /// Return the associated offload kind.
2175 Action::OffloadKind getAssociatedOffloadKind() {
2176 return AssociatedOffloadKind;
2177 }
2178 };
2179
Yaxun Liu3af038b2018-05-30 00:49:10 +00002180 /// Base class for CUDA/HIP action builder. It injects device code in
2181 /// the host backend action.
2182 class CudaActionBuilderBase : public DeviceActionBuilder {
2183 protected:
Samuel Antao64e965e2016-09-30 15:34:19 +00002184 /// Flags to signal if the user requested host-only or device-only
2185 /// compilation.
2186 bool CompileHostOnly = false;
2187 bool CompileDeviceOnly = false;
2188
2189 /// List of GPU architectures to use in this compilation.
2190 SmallVector<CudaArch, 4> GpuArchList;
2191
2192 /// The CUDA actions for the current input.
2193 ActionList CudaDeviceActions;
2194
2195 /// The CUDA fat binary if it was generated for the current input.
2196 Action *CudaFatBinary = nullptr;
2197
2198 /// Flag that is set to true if this builder acted on the current input.
2199 bool IsActive = false;
Yaxun Liu3af038b2018-05-30 00:49:10 +00002200 public:
2201 CudaActionBuilderBase(Compilation &C, DerivedArgList &Args,
2202 const Driver::InputList &Inputs,
2203 Action::OffloadKind OFKind)
2204 : DeviceActionBuilder(C, Args, Inputs, OFKind) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002205
Yaxun Liu3af038b2018-05-30 00:49:10 +00002206 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2207 // While generating code for CUDA, we only depend on the host input action
2208 // to trigger the creation of all the CUDA device actions.
2209
2210 // If we are dealing with an input action, replicate it for each GPU
2211 // architecture. If we are in host-only mode we return 'success' so that
2212 // the host uses the CUDA offload kind.
2213 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2214 assert(!GpuArchList.empty() &&
2215 "We should have at least one GPU architecture.");
2216
2217 // If the host input is not CUDA or HIP, we don't need to bother about
2218 // this input.
2219 if (IA->getType() != types::TY_CUDA &&
2220 IA->getType() != types::TY_HIP) {
2221 // The builder will ignore this input.
2222 IsActive = false;
2223 return ABRT_Inactive;
2224 }
2225
2226 // Set the flag to true, so that the builder acts on the current input.
2227 IsActive = true;
2228
2229 if (CompileHostOnly)
2230 return ABRT_Success;
2231
2232 // Replicate inputs for each GPU architecture.
2233 auto Ty = IA->getType() == types::TY_HIP ? types::TY_HIP_DEVICE
2234 : types::TY_CUDA_DEVICE;
2235 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2236 CudaDeviceActions.push_back(
2237 C.MakeAction<InputAction>(IA->getInputArg(), Ty));
2238 }
2239
2240 return ABRT_Success;
2241 }
2242
2243 // If this is an unbundling action use it as is for each CUDA toolchain.
2244 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2245 CudaDeviceActions.clear();
2246 for (auto Arch : GpuArchList) {
2247 CudaDeviceActions.push_back(UA);
2248 UA->registerDependentActionInfo(ToolChains[0], CudaArchToString(Arch),
2249 AssociatedOffloadKind);
2250 }
2251 return ABRT_Success;
2252 }
2253
2254 return IsActive ? ABRT_Success : ABRT_Inactive;
2255 }
2256
2257 void appendTopLevelActions(ActionList &AL) override {
2258 // Utility to append actions to the top level list.
2259 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
2260 OffloadAction::DeviceDependences Dep;
2261 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
2262 AssociatedOffloadKind);
2263 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2264 };
2265
2266 // If we have a fat binary, add it to the list.
2267 if (CudaFatBinary) {
2268 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
2269 CudaDeviceActions.clear();
2270 CudaFatBinary = nullptr;
2271 return;
2272 }
2273
2274 if (CudaDeviceActions.empty())
2275 return;
2276
2277 // If we have CUDA actions at this point, that's because we have a have
2278 // partial compilation, so we should have an action for each GPU
2279 // architecture.
2280 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2281 "Expecting one action per GPU architecture.");
2282 assert(ToolChains.size() == 1 &&
2283 "Expecting to have a sing CUDA toolchain.");
2284 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
2285 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
2286
2287 CudaDeviceActions.clear();
2288 }
2289
2290 bool initialize() override {
2291 assert(AssociatedOffloadKind == Action::OFK_Cuda ||
2292 AssociatedOffloadKind == Action::OFK_HIP);
2293
2294 // We don't need to support CUDA.
2295 if (AssociatedOffloadKind == Action::OFK_Cuda &&
2296 !C.hasOffloadToolChain<Action::OFK_Cuda>())
2297 return false;
2298
2299 // We don't need to support HIP.
2300 if (AssociatedOffloadKind == Action::OFK_HIP &&
2301 !C.hasOffloadToolChain<Action::OFK_HIP>())
2302 return false;
2303
2304 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
2305 assert(HostTC && "No toolchain for host compilation.");
2306 if (HostTC->getTriple().isNVPTX() ||
2307 HostTC->getTriple().getArch() == llvm::Triple::amdgcn) {
2308 // We do not support targeting NVPTX/AMDGCN for host compilation. Throw
2309 // an error and abort pipeline construction early so we don't trip
2310 // asserts that assume device-side compilation.
2311 C.getDriver().Diag(diag::err_drv_cuda_host_arch)
2312 << HostTC->getTriple().getArchName();
2313 return true;
2314 }
2315
2316 ToolChains.push_back(
2317 AssociatedOffloadKind == Action::OFK_Cuda
2318 ? C.getSingleOffloadToolChain<Action::OFK_Cuda>()
2319 : C.getSingleOffloadToolChain<Action::OFK_HIP>());
2320
2321 Arg *PartialCompilationArg = Args.getLastArg(
2322 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
2323 options::OPT_cuda_compile_host_device);
2324 CompileHostOnly = PartialCompilationArg &&
2325 PartialCompilationArg->getOption().matches(
2326 options::OPT_cuda_host_only);
2327 CompileDeviceOnly = PartialCompilationArg &&
2328 PartialCompilationArg->getOption().matches(
2329 options::OPT_cuda_device_only);
2330
2331 // Collect all cuda_gpu_arch parameters, removing duplicates.
2332 std::set<CudaArch> GpuArchs;
2333 bool Error = false;
2334 for (Arg *A : Args) {
2335 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
2336 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
2337 continue;
2338 A->claim();
2339
2340 const StringRef ArchStr = A->getValue();
2341 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
2342 ArchStr == "all") {
2343 GpuArchs.clear();
2344 continue;
2345 }
2346 CudaArch Arch = StringToCudaArch(ArchStr);
2347 if (Arch == CudaArch::UNKNOWN) {
2348 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
2349 Error = true;
2350 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
2351 GpuArchs.insert(Arch);
2352 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
2353 GpuArchs.erase(Arch);
2354 else
2355 llvm_unreachable("Unexpected option.");
2356 }
2357
2358 // Collect list of GPUs remaining in the set.
2359 for (CudaArch Arch : GpuArchs)
2360 GpuArchList.push_back(Arch);
2361
2362 // Default to sm_20 which is the lowest common denominator for
2363 // supported GPUs. sm_20 code should work correctly, if
2364 // suboptimally, on all newer GPUs.
2365 if (GpuArchList.empty())
2366 GpuArchList.push_back(CudaArch::SM_20);
2367
2368 return Error;
2369 }
2370 };
2371
2372 /// \brief CUDA action builder. It injects device code in the host backend
2373 /// action.
2374 class CudaActionBuilder final : public CudaActionBuilderBase {
Samuel Antao64e965e2016-09-30 15:34:19 +00002375 public:
2376 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
2377 const Driver::InputList &Inputs)
Yaxun Liu3af038b2018-05-30 00:49:10 +00002378 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_Cuda) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002379
2380 ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002381 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2382 phases::ID CurPhase, phases::ID FinalPhase,
2383 PhasesTy &Phases) override {
Samuel Antao64e965e2016-09-30 15:34:19 +00002384 if (!IsActive)
2385 return ABRT_Inactive;
2386
2387 // If we don't have more CUDA actions, we don't have any dependences to
2388 // create for the host.
2389 if (CudaDeviceActions.empty())
2390 return ABRT_Success;
2391
2392 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2393 "Expecting one action per GPU architecture.");
2394 assert(!CompileHostOnly &&
2395 "Not expecting CUDA actions in host-only compilation.");
2396
2397 // If we are generating code for the device or we are in a backend phase,
2398 // we attempt to generate the fat binary. We compile each arch to ptx and
2399 // assemble to cubin, then feed the cubin *and* the ptx into a device
2400 // "link" action, which uses fatbinary to combine these cubins into one
2401 // fatbin. The fatbin is then an input to the host action if not in
2402 // device-only mode.
2403 if (CompileDeviceOnly || CurPhase == phases::Backend) {
2404 ActionList DeviceActions;
2405 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2406 // Produce the device action from the current phase up to the assemble
2407 // phase.
2408 for (auto Ph : Phases) {
2409 // Skip the phases that were already dealt with.
2410 if (Ph < CurPhase)
2411 continue;
2412 // We have to be consistent with the host final phase.
2413 if (Ph > FinalPhase)
2414 break;
2415
2416 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
Artem Belevichecb178b2018-03-21 22:22:59 +00002417 C, Args, Ph, CudaDeviceActions[I], Action::OFK_Cuda);
Samuel Antao64e965e2016-09-30 15:34:19 +00002418
2419 if (Ph == phases::Assemble)
2420 break;
2421 }
2422
2423 // If we didn't reach the assemble phase, we can't generate the fat
2424 // binary. We don't need to generate the fat binary if we are not in
2425 // device-only mode.
2426 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
2427 CompileDeviceOnly)
2428 continue;
2429
2430 Action *AssembleAction = CudaDeviceActions[I];
2431 assert(AssembleAction->getType() == types::TY_Object);
2432 assert(AssembleAction->getInputs().size() == 1);
2433
2434 Action *BackendAction = AssembleAction->getInputs()[0];
2435 assert(BackendAction->getType() == types::TY_PP_Asm);
2436
2437 for (auto &A : {AssembleAction, BackendAction}) {
2438 OffloadAction::DeviceDependences DDep;
2439 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
2440 Action::OFK_Cuda);
2441 DeviceActions.push_back(
2442 C.MakeAction<OffloadAction>(DDep, A->getType()));
2443 }
2444 }
2445
2446 // We generate the fat binary if we have device input actions.
2447 if (!DeviceActions.empty()) {
2448 CudaFatBinary =
2449 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
2450
2451 if (!CompileDeviceOnly) {
2452 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2453 Action::OFK_Cuda);
2454 // Clear the fat binary, it is already a dependence to an host
2455 // action.
2456 CudaFatBinary = nullptr;
2457 }
2458
2459 // Remove the CUDA actions as they are already connected to an host
2460 // action or fat binary.
2461 CudaDeviceActions.clear();
2462 }
2463
2464 // We avoid creating host action in device-only mode.
2465 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Samuel Antao5b1a89a2016-10-27 00:53:34 +00002466 } else if (CurPhase > phases::Backend) {
2467 // If we are past the backend phase and still have a device action, we
2468 // don't have to do anything as this action is already a device
2469 // top-level action.
2470 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002471 }
2472
2473 assert(CurPhase < phases::Backend && "Generating single CUDA "
2474 "instructions should only occur "
2475 "before the backend phase!");
2476
2477 // By default, we produce an action for each device arch.
2478 for (Action *&A : CudaDeviceActions)
2479 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2480
2481 return ABRT_Success;
2482 }
Yaxun Liu3af038b2018-05-30 00:49:10 +00002483 };
2484 /// \brief HIP action builder. It injects device code in the host backend
2485 /// action.
2486 class HIPActionBuilder final : public CudaActionBuilderBase {
2487 /// The linker inputs obtained for each device arch.
2488 SmallVector<ActionList, 8> DeviceLinkerInputs;
Yaxun Liu97670892018-10-02 17:48:54 +00002489 bool Relocatable;
Samuel Antao64e965e2016-09-30 15:34:19 +00002490
Yaxun Liu3af038b2018-05-30 00:49:10 +00002491 public:
2492 HIPActionBuilder(Compilation &C, DerivedArgList &Args,
2493 const Driver::InputList &Inputs)
Yaxun Liu97670892018-10-02 17:48:54 +00002494 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_HIP),
2495 Relocatable(false) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002496
Yaxun Liu3af038b2018-05-30 00:49:10 +00002497 bool canUseBundlerUnbundler() const override { return true; }
Samuel Antao64e965e2016-09-30 15:34:19 +00002498
Yaxun Liu3af038b2018-05-30 00:49:10 +00002499 ActionBuilderReturnCode
2500 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2501 phases::ID CurPhase, phases::ID FinalPhase,
2502 PhasesTy &Phases) override {
2503 // amdgcn does not support linking of object files, therefore we skip
Yaxun Liu97670892018-10-02 17:48:54 +00002504 // backend and assemble phases to output LLVM IR. Except for generating
2505 // non-relocatable device coee, where we generate fat binary for device
2506 // code and pass to host in Backend phase.
2507 if (CudaDeviceActions.empty() ||
2508 (CurPhase == phases::Backend && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002509 CurPhase == phases::Assemble)
2510 return ABRT_Success;
2511
Yaxun Liu97670892018-10-02 17:48:54 +00002512 assert(((CurPhase == phases::Link && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002513 CudaDeviceActions.size() == GpuArchList.size()) &&
2514 "Expecting one action per GPU architecture.");
2515 assert(!CompileHostOnly &&
2516 "Not expecting CUDA actions in host-only compilation.");
2517
Yaxun Liu97670892018-10-02 17:48:54 +00002518 if (!Relocatable && CurPhase == phases::Backend) {
2519 // If we are in backend phase, we attempt to generate the fat binary.
2520 // We compile each arch to IR and use a link action to generate code
2521 // object containing ISA. Then we use a special "link" action to create
2522 // a fat binary containing all the code objects for different GPU's.
2523 // The fat binary is then an input to the host action.
2524 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2525 // Create a link action to link device IR with device library
2526 // and generate ISA.
2527 ActionList AL;
2528 AL.push_back(CudaDeviceActions[I]);
2529 CudaDeviceActions[I] =
2530 C.MakeAction<LinkJobAction>(AL, types::TY_Image);
2531
2532 // OffloadingActionBuilder propagates device arch until an offload
2533 // action. Since the next action for creating fatbin does
2534 // not have device arch, whereas the above link action and its input
2535 // have device arch, an offload action is needed to stop the null
2536 // device arch of the next action being propagated to the above link
2537 // action.
2538 OffloadAction::DeviceDependences DDep;
2539 DDep.add(*CudaDeviceActions[I], *ToolChains.front(),
2540 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2541 CudaDeviceActions[I] = C.MakeAction<OffloadAction>(
2542 DDep, CudaDeviceActions[I]->getType());
2543 }
2544 // Create HIP fat binary with a special "link" action.
2545 CudaFatBinary =
2546 C.MakeAction<LinkJobAction>(CudaDeviceActions,
2547 types::TY_HIP_FATBIN);
2548
2549 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2550 AssociatedOffloadKind);
2551 // Clear the fat binary, it is already a dependence to an host
2552 // action.
2553 CudaFatBinary = nullptr;
2554
2555 // Remove the CUDA actions as they are already connected to an host
2556 // action or fat binary.
2557 CudaDeviceActions.clear();
2558
2559 return ABRT_Success;
2560 } else if (CurPhase == phases::Link) {
2561 // Save CudaDeviceActions to DeviceLinkerInputs for each GPU subarch.
2562 // This happens to each device action originated from each input file.
2563 // Later on, device actions in DeviceLinkerInputs are used to create
2564 // device link actions in appendLinkDependences and the created device
2565 // link actions are passed to the offload action as device dependence.
Yaxun Liu3af038b2018-05-30 00:49:10 +00002566 DeviceLinkerInputs.resize(CudaDeviceActions.size());
2567 auto LI = DeviceLinkerInputs.begin();
2568 for (auto *A : CudaDeviceActions) {
2569 LI->push_back(A);
2570 ++LI;
Samuel Antao64e965e2016-09-30 15:34:19 +00002571 }
2572
Yaxun Liu3af038b2018-05-30 00:49:10 +00002573 // We will pass the device action as a host dependence, so we don't
2574 // need to do anything else with them.
2575 CudaDeviceActions.clear();
Samuel Antao64e965e2016-09-30 15:34:19 +00002576 return ABRT_Success;
2577 }
2578
Yaxun Liu3af038b2018-05-30 00:49:10 +00002579 // By default, we produce an action for each device arch.
2580 for (Action *&A : CudaDeviceActions)
2581 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A,
2582 AssociatedOffloadKind);
2583
2584 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002585 }
2586
Yaxun Liu3af038b2018-05-30 00:49:10 +00002587 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2588 // Append a new link action for each device.
2589 unsigned I = 0;
2590 for (auto &LI : DeviceLinkerInputs) {
2591 auto *DeviceLinkAction =
2592 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2593 DA.add(*DeviceLinkAction, *ToolChains[0],
2594 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2595 ++I;
Samuel Antao64e965e2016-09-30 15:34:19 +00002596 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002597 }
Yaxun Liu97670892018-10-02 17:48:54 +00002598
2599 bool initialize() override {
2600 Relocatable = Args.hasFlag(options::OPT_fgpu_rdc,
2601 options::OPT_fno_gpu_rdc, /*Default=*/false);
2602
2603 return CudaActionBuilderBase::initialize();
2604 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002605 };
2606
Samuel Antao28c4f182016-10-27 17:08:03 +00002607 /// OpenMP action builder. The host bitcode is passed to the device frontend
2608 /// and all the device linked images are passed to the host link phase.
2609 class OpenMPActionBuilder final : public DeviceActionBuilder {
2610 /// The OpenMP actions for the current input.
2611 ActionList OpenMPDeviceActions;
2612
2613 /// The linker inputs obtained for each toolchain.
2614 SmallVector<ActionList, 8> DeviceLinkerInputs;
2615
2616 public:
2617 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2618 const Driver::InputList &Inputs)
2619 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2620
2621 ActionBuilderReturnCode
2622 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2623 phases::ID CurPhase, phases::ID FinalPhase,
2624 PhasesTy &Phases) override {
Alexey Bataeva5178f52018-09-28 16:17:59 +00002625 if (OpenMPDeviceActions.empty())
2626 return ABRT_Inactive;
Samuel Antao28c4f182016-10-27 17:08:03 +00002627
2628 // We should always have an action for each input.
2629 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2630 "Number of OpenMP actions and toolchains do not match.");
2631
2632 // The host only depends on device action in the linking phase, when all
2633 // the device images have to be embedded in the host image.
2634 if (CurPhase == phases::Link) {
2635 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2636 "Toolchains and linker inputs sizes do not match.");
2637 auto LI = DeviceLinkerInputs.begin();
2638 for (auto *A : OpenMPDeviceActions) {
2639 LI->push_back(A);
2640 ++LI;
2641 }
2642
2643 // We passed the device action as a host dependence, so we don't need to
2644 // do anything else with them.
2645 OpenMPDeviceActions.clear();
2646 return ABRT_Success;
2647 }
2648
2649 // By default, we produce an action for each device arch.
2650 for (Action *&A : OpenMPDeviceActions)
2651 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2652
2653 return ABRT_Success;
2654 }
2655
2656 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2657
2658 // If this is an input action replicate it for each OpenMP toolchain.
2659 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2660 OpenMPDeviceActions.clear();
2661 for (unsigned I = 0; I < ToolChains.size(); ++I)
2662 OpenMPDeviceActions.push_back(
2663 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2664 return ABRT_Success;
2665 }
2666
Samuel Antaofab4f372016-10-27 18:00:51 +00002667 // If this is an unbundling action use it as is for each OpenMP toolchain.
2668 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2669 OpenMPDeviceActions.clear();
Alexey Bataeva5178f52018-09-28 16:17:59 +00002670 auto *IA = cast<InputAction>(UA->getInputs().back());
2671 std::string FileName = IA->getInputArg().getAsString(Args);
2672 // Check if the type of the file is the same as the action. Do not
2673 // unbundle it if it is not. Do not unbundle .so files, for example,
2674 // which are not object files.
2675 if (IA->getType() == types::TY_Object &&
2676 (!llvm::sys::path::has_extension(FileName) ||
2677 types::lookupTypeForExtension(
2678 llvm::sys::path::extension(FileName).drop_front()) !=
2679 types::TY_Object))
2680 return ABRT_Inactive;
Samuel Antaofab4f372016-10-27 18:00:51 +00002681 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2682 OpenMPDeviceActions.push_back(UA);
2683 UA->registerDependentActionInfo(
2684 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2685 }
2686 return ABRT_Success;
2687 }
2688
Samuel Antao28c4f182016-10-27 17:08:03 +00002689 // When generating code for OpenMP we use the host compile phase result as
2690 // a dependence to the device compile phase so that it can learn what
2691 // declarations should be emitted. However, this is not the only use for
2692 // the host action, so we prevent it from being collapsed.
2693 if (isa<CompileJobAction>(HostAction)) {
2694 HostAction->setCannotBeCollapsedWithNextDependentAction();
2695 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2696 "Toolchains and device action sizes do not match.");
2697 OffloadAction::HostDependence HDep(
2698 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2699 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2700 auto TC = ToolChains.begin();
2701 for (Action *&A : OpenMPDeviceActions) {
2702 assert(isa<CompileJobAction>(A));
2703 OffloadAction::DeviceDependences DDep;
2704 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2705 A = C.MakeAction<OffloadAction>(HDep, DDep);
2706 ++TC;
2707 }
2708 }
2709 return ABRT_Success;
2710 }
2711
Samuel Antao69d6f312016-10-27 17:50:43 +00002712 void appendTopLevelActions(ActionList &AL) override {
2713 if (OpenMPDeviceActions.empty())
2714 return;
2715
2716 // We should always have an action for each input.
2717 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2718 "Number of OpenMP actions and toolchains do not match.");
2719
2720 // Append all device actions followed by the proper offload action.
2721 auto TI = ToolChains.begin();
2722 for (auto *A : OpenMPDeviceActions) {
2723 OffloadAction::DeviceDependences Dep;
2724 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2725 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2726 ++TI;
2727 }
2728 // We no longer need the action stored in this builder.
2729 OpenMPDeviceActions.clear();
2730 }
2731
Samuel Antao28c4f182016-10-27 17:08:03 +00002732 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2733 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2734 "Toolchains and linker inputs sizes do not match.");
2735
2736 // Append a new link action for each device.
2737 auto TC = ToolChains.begin();
2738 for (auto &LI : DeviceLinkerInputs) {
2739 auto *DeviceLinkAction =
2740 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2741 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2742 Action::OFK_OpenMP);
2743 ++TC;
2744 }
2745 }
2746
2747 bool initialize() override {
2748 // Get the OpenMP toolchains. If we don't get any, the action builder will
2749 // know there is nothing to do related to OpenMP offloading.
2750 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2751 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2752 ++TI)
2753 ToolChains.push_back(TI->second);
2754
2755 DeviceLinkerInputs.resize(ToolChains.size());
2756 return false;
2757 }
Samuel Antao69d6f312016-10-27 17:50:43 +00002758
2759 bool canUseBundlerUnbundler() const override {
2760 // OpenMP should use bundled files whenever possible.
2761 return true;
2762 }
Samuel Antao28c4f182016-10-27 17:08:03 +00002763 };
2764
2765 ///
2766 /// TODO: Add the implementation for other specialized builders here.
2767 ///
Samuel Antao64e965e2016-09-30 15:34:19 +00002768
2769 /// Specialized builders being used by this offloading action builder.
2770 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2771
Samuel Antao69d6f312016-10-27 17:50:43 +00002772 /// Flag set to true if all valid builders allow file bundling/unbundling.
2773 bool CanUseBundler;
2774
Samuel Antao64e965e2016-09-30 15:34:19 +00002775public:
2776 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2777 const Driver::InputList &Inputs)
Samuel Antao10e905c2016-10-27 01:08:58 +00002778 : C(C) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002779 // Create a specialized builder for each device toolchain.
2780
2781 IsValid = true;
2782
2783 // Create a specialized builder for CUDA.
2784 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2785
Yaxun Liu3af038b2018-05-30 00:49:10 +00002786 // Create a specialized builder for HIP.
2787 SpecializedBuilders.push_back(new HIPActionBuilder(C, Args, Inputs));
2788
Samuel Antao28c4f182016-10-27 17:08:03 +00002789 // Create a specialized builder for OpenMP.
2790 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2791
Samuel Antao64e965e2016-09-30 15:34:19 +00002792 //
2793 // TODO: Build other specialized builders here.
2794 //
2795
Samuel Antao69d6f312016-10-27 17:50:43 +00002796 // Initialize all the builders, keeping track of errors. If all valid
2797 // builders agree that we can use bundling, set the flag to true.
2798 unsigned ValidBuilders = 0u;
2799 unsigned ValidBuildersSupportingBundling = 0u;
2800 for (auto *SB : SpecializedBuilders) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002801 IsValid = IsValid && !SB->initialize();
Samuel Antao69d6f312016-10-27 17:50:43 +00002802
2803 // Update the counters if the builder is valid.
2804 if (SB->isValid()) {
2805 ++ValidBuilders;
2806 if (SB->canUseBundlerUnbundler())
2807 ++ValidBuildersSupportingBundling;
2808 }
2809 }
2810 CanUseBundler =
2811 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
Artem Belevichf981e30b2016-08-02 22:37:47 +00002812 }
Justin Lebardc3c5042016-04-19 02:27:07 +00002813
Samuel Antao64e965e2016-09-30 15:34:19 +00002814 ~OffloadingActionBuilder() {
2815 for (auto *SB : SpecializedBuilders)
2816 delete SB;
Samuel Antaod06239d2016-07-15 23:13:27 +00002817 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002818
Samuel Antao64e965e2016-09-30 15:34:19 +00002819 /// Generate an action that adds device dependences (if any) to a host action.
2820 /// If no device dependence actions exist, just return the host action \a
2821 /// HostAction. If an error is found or if no builder requires the host action
2822 /// to be generated, return nullptr.
2823 Action *
2824 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2825 phases::ID CurPhase, phases::ID FinalPhase,
2826 DeviceActionBuilder::PhasesTy &Phases) {
2827 if (!IsValid)
2828 return nullptr;
Justin Lebar7bf77982016-01-11 23:27:13 +00002829
Samuel Antao64e965e2016-09-30 15:34:19 +00002830 if (SpecializedBuilders.empty())
2831 return HostAction;
2832
2833 assert(HostAction && "Invalid host action!");
2834
2835 OffloadAction::DeviceDependences DDeps;
2836 // Check if all the programming models agree we should not emit the host
2837 // action. Also, keep track of the offloading kinds employed.
2838 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2839 unsigned InactiveBuilders = 0u;
2840 unsigned IgnoringBuilders = 0u;
2841 for (auto *SB : SpecializedBuilders) {
2842 if (!SB->isValid()) {
2843 ++InactiveBuilders;
2844 continue;
2845 }
2846
Samuel Antao28c4f182016-10-27 17:08:03 +00002847 auto RetCode =
2848 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
Samuel Antao64e965e2016-09-30 15:34:19 +00002849
2850 // If the builder explicitly says the host action should be ignored,
2851 // we need to increment the variable that tracks the builders that request
2852 // the host object to be ignored.
2853 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2854 ++IgnoringBuilders;
2855
2856 // Unless the builder was inactive for this action, we have to record the
2857 // offload kind because the host will have to use it.
2858 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2859 OffloadKind |= SB->getAssociatedOffloadKind();
2860 }
2861
2862 // If all builders agree that the host object should be ignored, just return
2863 // nullptr.
2864 if (IgnoringBuilders &&
2865 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2866 return nullptr;
2867
2868 if (DDeps.getActions().empty())
2869 return HostAction;
2870
2871 // We have dependences we need to bundle together. We use an offload action
2872 // for that.
2873 OffloadAction::HostDependence HDep(
2874 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2875 /*BoundArch=*/nullptr, DDeps);
2876 return C.MakeAction<OffloadAction>(HDep, DDeps);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002877 }
2878
Samuel Antao64e965e2016-09-30 15:34:19 +00002879 /// Generate an action that adds a host dependence to a device action. The
2880 /// results will be kept in this action builder. Return true if an error was
2881 /// found.
Samuel Antaofab4f372016-10-27 18:00:51 +00002882 bool addHostDependenceToDeviceActions(Action *&HostAction,
Samuel Antao64e965e2016-09-30 15:34:19 +00002883 const Arg *InputArg) {
2884 if (!IsValid)
2885 return true;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002886
Samuel Antaofab4f372016-10-27 18:00:51 +00002887 // If we are supporting bundling/unbundling and the current action is an
2888 // input action of non-source file, we replace the host action by the
2889 // unbundling action. The bundler tool has the logic to detect if an input
2890 // is a bundle or not and if the input is not a bundle it assumes it is a
2891 // host file. Therefore it is safe to create an unbundling action even if
2892 // the input is not a bundle.
2893 if (CanUseBundler && isa<InputAction>(HostAction) &&
2894 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
2895 !types::isSrcFile(HostAction->getType())) {
2896 auto UnbundlingHostAction =
2897 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
2898 UnbundlingHostAction->registerDependentActionInfo(
2899 C.getSingleOffloadToolChain<Action::OFK_Host>(),
Yaxun Liuf37b50a2018-07-24 01:03:44 +00002900 /*BoundArch=*/StringRef(), Action::OFK_Host);
Samuel Antaofab4f372016-10-27 18:00:51 +00002901 HostAction = UnbundlingHostAction;
2902 }
2903
Samuel Antao64e965e2016-09-30 15:34:19 +00002904 assert(HostAction && "Invalid host action!");
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002905
Samuel Antao64e965e2016-09-30 15:34:19 +00002906 // Register the offload kinds that are used.
2907 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2908 for (auto *SB : SpecializedBuilders) {
2909 if (!SB->isValid())
2910 continue;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002911
Samuel Antao64e965e2016-09-30 15:34:19 +00002912 auto RetCode = SB->addDeviceDepences(HostAction);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002913
Samuel Antao64e965e2016-09-30 15:34:19 +00002914 // Host dependences for device actions are not compatible with that same
2915 // action being ignored.
2916 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
2917 "Host dependence not expected to be ignored.!");
Samuel Antaod06239d2016-07-15 23:13:27 +00002918
Samuel Antao64e965e2016-09-30 15:34:19 +00002919 // Unless the builder was inactive for this action, we have to record the
2920 // offload kind because the host will have to use it.
2921 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2922 OffloadKind |= SB->getAssociatedOffloadKind();
2923 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002924
Alexey Bataeva5178f52018-09-28 16:17:59 +00002925 // Do not use unbundler if the Host does not depend on device action.
2926 if (OffloadKind == Action::OFK_None && CanUseBundler)
2927 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction))
2928 HostAction = UA->getInputs().back();
2929
Samuel Antao64e965e2016-09-30 15:34:19 +00002930 return false;
2931 }
2932
Samuel Antao69d6f312016-10-27 17:50:43 +00002933 /// Add the offloading top level actions to the provided action list. This
2934 /// function can replace the host action by a bundling action if the
2935 /// programming models allow it.
Samuel Antao64e965e2016-09-30 15:34:19 +00002936 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
2937 const Arg *InputArg) {
Samuel Antao69d6f312016-10-27 17:50:43 +00002938 // Get the device actions to be appended.
2939 ActionList OffloadAL;
Samuel Antao64e965e2016-09-30 15:34:19 +00002940 for (auto *SB : SpecializedBuilders) {
2941 if (!SB->isValid())
2942 continue;
Samuel Antao69d6f312016-10-27 17:50:43 +00002943 SB->appendTopLevelActions(OffloadAL);
Samuel Antao64e965e2016-09-30 15:34:19 +00002944 }
2945
Samuel Antao69d6f312016-10-27 17:50:43 +00002946 // If we can use the bundler, replace the host action by the bundling one in
2947 // the resulting list. Otherwise, just append the device actions.
2948 if (CanUseBundler && !OffloadAL.empty()) {
2949 // Add the host action to the list in order to create the bundling action.
2950 OffloadAL.push_back(HostAction);
2951
2952 // We expect that the host action was just appended to the action list
2953 // before this method was called.
2954 assert(HostAction == AL.back() && "Host action not in the list??");
2955 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
2956 AL.back() = HostAction;
2957 } else
2958 AL.append(OffloadAL.begin(), OffloadAL.end());
2959
Samuel Antao64e965e2016-09-30 15:34:19 +00002960 // Propagate to the current host action (if any) the offload information
2961 // associated with the current input.
2962 if (HostAction)
2963 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
2964 /*BoundArch=*/nullptr);
Samuel Antao64e965e2016-09-30 15:34:19 +00002965 return false;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002966 }
Artem Belevich5bde4e02015-07-20 20:02:54 +00002967
Samuel Antao64e965e2016-09-30 15:34:19 +00002968 /// Processes the host linker action. This currently consists of replacing it
2969 /// with an offload action if there are device link objects and propagate to
2970 /// the host action all the offload kinds used in the current compilation. The
2971 /// resulting action is returned.
2972 Action *processHostLinkAction(Action *HostAction) {
2973 // Add all the dependences from the device linking actions.
2974 OffloadAction::DeviceDependences DDeps;
2975 for (auto *SB : SpecializedBuilders) {
2976 if (!SB->isValid())
2977 continue;
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002978
Samuel Antao64e965e2016-09-30 15:34:19 +00002979 SB->appendLinkDependences(DDeps);
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002980 }
Samuel Antaod06239d2016-07-15 23:13:27 +00002981
Samuel Antao64e965e2016-09-30 15:34:19 +00002982 // Calculate all the offload kinds used in the current compilation.
2983 unsigned ActiveOffloadKinds = 0u;
2984 for (auto &I : InputArgToOffloadKindMap)
2985 ActiveOffloadKinds |= I.second;
2986
2987 // If we don't have device dependencies, we don't have to create an offload
2988 // action.
2989 if (DDeps.getActions().empty()) {
2990 // Propagate all the active kinds to host action. Given that it is a link
2991 // action it is assumed to depend on all actions generated so far.
2992 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
2993 /*BoundArch=*/nullptr);
2994 return HostAction;
2995 }
2996
2997 // Create the offload action with all dependences. When an offload action
2998 // is created the kinds are propagated to the host action, so we don't have
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002999 // to do that explicitly here.
Samuel Antao64e965e2016-09-30 15:34:19 +00003000 OffloadAction::HostDependence HDep(
3001 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
3002 /*BoundArch*/ nullptr, ActiveOffloadKinds);
3003 return C.MakeAction<OffloadAction>(HDep, DDeps);
3004 }
3005};
3006} // anonymous namespace.
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003007
Justin Lebar0f3474c2016-02-11 02:00:50 +00003008void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
3009 const InputList &Inputs, ActionList &Actions) const {
Chad Rosierecdede82011-08-12 22:08:57 +00003010 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00003011
Daniel Dunbar34c41872009-03-13 00:17:48 +00003012 if (!SuppressMissingInputWarning && Inputs.empty()) {
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003013 Diag(clang::diag::err_drv_no_input_files);
3014 return;
3015 }
3016
Chad Rosier7742b5d2011-07-27 23:36:45 +00003017 Arg *FinalPhaseArg;
3018 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003019
Bob Haarmanaaf51912017-02-27 19:40:19 +00003020 if (FinalPhase == phases::Link) {
3021 if (Args.hasArg(options::OPT_emit_llvm))
3022 Diag(clang::diag::err_drv_emit_llvm_link);
3023 if (IsCLMode() && LTOMode != LTOK_None &&
3024 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
3025 Diag(clang::diag::err_drv_lto_without_lld);
Rafael Espindolae8025642013-08-25 14:27:09 +00003026 }
3027
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003028 // Reject -Z* at the top level, these options should never have been exposed
3029 // by gcc.
Daniel Dunbardd765242009-03-26 16:12:09 +00003030 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
Daniel Dunbar0e759942009-03-20 06:14:23 +00003031 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003032
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003033 // Diagnose misuse of /Fo.
3034 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003035 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003036 if (Inputs.size() > 1 && !V.empty() &&
3037 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003038 // Check whether /Fo tries to name an output file for multiple inputs.
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003039 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003040 << A->getSpelling() << V;
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003041 Args.eraseArg(options::OPT__SLASH_Fo);
3042 }
3043 }
3044
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003045 // Diagnose misuse of /Fa.
3046 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
3047 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003048 if (Inputs.size() > 1 && !V.empty() &&
3049 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003050 // Check whether /Fa tries to name an asm file for multiple inputs.
3051 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003052 << A->getSpelling() << V;
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003053 Args.eraseArg(options::OPT__SLASH_Fa);
3054 }
3055 }
3056
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00003057 // Diagnose misuse of /o.
3058 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
3059 if (A->getValue()[0] == '\0') {
3060 // It has to have a value.
3061 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
3062 Args.eraseArg(options::OPT__SLASH_o);
3063 }
3064 }
3065
Mike Rice58df1af2018-09-11 17:10:44 +00003066 // Ignore /Yc/Yu if both /Yc and /Yu passed but with different filenames.
Nico Weber2ca4be92016-03-01 23:16:44 +00003067 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
3068 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
Nico Weber2ca4be92016-03-01 23:16:44 +00003069 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
3070 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
3071 Args.eraseArg(options::OPT__SLASH_Yc);
3072 Args.eraseArg(options::OPT__SLASH_Yu);
3073 YcArg = YuArg = nullptr;
3074 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003075 if (YcArg && Inputs.size() > 1) {
3076 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
3077 Args.eraseArg(options::OPT__SLASH_Yc);
3078 YcArg = nullptr;
3079 }
Erich Keaneeaca3882018-08-17 13:43:39 +00003080 if (FinalPhase == phases::Preprocess || Args.hasArg(options::OPT__SLASH_Y_)) {
3081 // If only preprocessing or /Y- is used, all pch handling is disabled.
3082 // Rather than check for it everywhere, just remove clang-cl pch-related
3083 // flags here.
Nico Weber2ca4be92016-03-01 23:16:44 +00003084 Args.eraseArg(options::OPT__SLASH_Fp);
3085 Args.eraseArg(options::OPT__SLASH_Yc);
3086 Args.eraseArg(options::OPT__SLASH_Yu);
3087 YcArg = YuArg = nullptr;
3088 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003089
Samuel Antao64e965e2016-09-30 15:34:19 +00003090 // Builder to be used to build offloading actions.
3091 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
Samuel Antaod06239d2016-07-15 23:13:27 +00003092
Daniel Dunbar65229332009-03-13 11:38:42 +00003093 // Construct the actions to perform.
Richard Smithcd35eff2018-09-15 01:21:16 +00003094 HeaderModulePrecompileJobAction *HeaderModuleAction = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003095 ActionList LinkerInputs;
Alp Toker965f8822013-11-27 05:22:15 +00003096
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003097 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
Artem Belevich5bde4e02015-07-20 20:02:54 +00003098 for (auto &I : Inputs) {
3099 types::ID InputType = I.first;
3100 const Arg *InputArg = I.second;
Daniel Dunbar65229332009-03-13 11:38:42 +00003101
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003102 PL.clear();
3103 types::getCompilationPhases(InputType, PL);
Daniel Dunbar65229332009-03-13 11:38:42 +00003104
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003105 // If the first step comes after the final phase we are doing as part of
3106 // this compilation, warn the user about it.
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003107 phases::ID InitialPhase = PL[0];
Daniel Dunbar65229332009-03-13 11:38:42 +00003108 if (InitialPhase > FinalPhase) {
Martin Storsjo665c7a42018-05-04 06:05:58 +00003109 if (InputArg->isClaimed())
3110 continue;
3111
Daniel Dunbaradc5c7c2009-03-19 07:57:08 +00003112 // Claim here to avoid the more general unused warning.
3113 InputArg->claim();
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003114
Daniel Dunbar2db3e732011-04-20 15:44:48 +00003115 // Suppress all unused style warnings with -Qunused-arguments
3116 if (Args.hasArg(options::OPT_Qunused_arguments))
3117 continue;
3118
Richard Smith403f76e2012-08-06 04:09:06 +00003119 // Special case when final phase determined by binary name, rather than
3120 // by a command-line argument with a corresponding Arg.
Hans Wennborg70850d82013-07-18 20:29:38 +00003121 if (CCCIsCPP())
Richard Smith403f76e2012-08-06 04:09:06 +00003122 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003123 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003124 // Special case '-E' warning on a previously preprocessed file to make
3125 // more sense.
Richard Smith403f76e2012-08-06 04:09:06 +00003126 else if (InitialPhase == phases::Compile &&
3127 FinalPhase == phases::Preprocess &&
3128 getPreprocessedType(InputType) == types::TY_INVALID)
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003129 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003130 << InputArg->getAsString(Args) << !!FinalPhaseArg
3131 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003132 else
3133 Diag(clang::diag::warn_drv_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003134 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
3135 << !!FinalPhaseArg
3136 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar65229332009-03-13 11:38:42 +00003137 continue;
3138 }
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003139
Nico Weberad2d8f32016-04-21 19:59:10 +00003140 if (YcArg) {
3141 // Add a separate precompile phase for the compile phase.
3142 if (FinalPhase >= phases::Compile) {
Richard Smith8cd452d2016-08-30 18:55:16 +00003143 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003144 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
Richard Smith8cd452d2016-08-30 18:55:16 +00003145 types::getCompilationPhases(HeaderType, PCHPL);
Nico Weberad2d8f32016-04-21 19:59:10 +00003146 // Build the pipeline for the pch file.
Richard Smith8cd452d2016-08-30 18:55:16 +00003147 Action *ClangClPch =
Erich Keane76675de2018-07-05 17:22:13 +00003148 C.MakeAction<InputAction>(*InputArg, HeaderType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003149 for (phases::ID Phase : PCHPL)
3150 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
3151 assert(ClangClPch);
3152 Actions.push_back(ClangClPch);
3153 // The driver currently exits after the first failed command. This
3154 // relies on that behavior, to make sure if the pch generation fails,
3155 // the main compilation won't run.
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00003156 // FIXME: If the main compilation fails, the PCH generation should
3157 // probably not be considered successful either.
Nico Weberad2d8f32016-04-21 19:59:10 +00003158 }
3159 }
3160
Daniel Dunbar65229332009-03-13 11:38:42 +00003161 // Build the pipeline for this file.
Justin Lebar41094612016-01-11 23:07:27 +00003162 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
Samuel Antao64e965e2016-09-30 15:34:19 +00003163
3164 // Use the current host action in any of the offloading actions, if
3165 // required.
3166 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3167 break;
3168
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003169 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
3170 i != e; ++i) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003171 phases::ID Phase = *i;
Daniel Dunbar65229332009-03-13 11:38:42 +00003172
3173 // We are done if this step is past what the user requested.
3174 if (Phase > FinalPhase)
3175 break;
3176
Samuel Antao64e965e2016-09-30 15:34:19 +00003177 // Add any offload action the host action depends on.
3178 Current = OffloadBuilder.addDeviceDependencesToHostAction(
3179 Current, InputArg, Phase, FinalPhase, PL);
3180 if (!Current)
3181 break;
3182
Daniel Dunbar65229332009-03-13 11:38:42 +00003183 // Queue linker inputs.
3184 if (Phase == phases::Link) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003185 assert((i + 1) == e && "linking must be final compilation step.");
Justin Lebar41094612016-01-11 23:07:27 +00003186 LinkerInputs.push_back(Current);
3187 Current = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003188 break;
3189 }
3190
Richard Smithcd35eff2018-09-15 01:21:16 +00003191 // Each precompiled header file after a module file action is a module
3192 // header of that same module file, rather than being compiled to a
3193 // separate PCH.
3194 if (Phase == phases::Precompile && HeaderModuleAction &&
3195 getPrecompiledType(InputType) == types::TY_PCH) {
3196 HeaderModuleAction->addModuleHeaderInput(Current);
3197 Current = nullptr;
3198 break;
3199 }
3200
3201 // FIXME: Should we include any prior module file outputs as inputs of
3202 // later actions in the same command line?
3203
Samuel Antao64e965e2016-09-30 15:34:19 +00003204 // Otherwise construct the appropriate action.
Richard Smithcd35eff2018-09-15 01:21:16 +00003205 Action *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003206
3207 // We didn't create a new action, so we will just move to the next phase.
3208 if (NewCurrent == Current)
Daniel Dunbar13864952009-03-24 20:17:30 +00003209 continue;
3210
Richard Smithcd35eff2018-09-15 01:21:16 +00003211 if (auto *HMA = dyn_cast<HeaderModulePrecompileJobAction>(NewCurrent))
3212 HeaderModuleAction = HMA;
3213
Samuel Antao64e965e2016-09-30 15:34:19 +00003214 Current = NewCurrent;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003215
Samuel Antao64e965e2016-09-30 15:34:19 +00003216 // Use the current host action in any of the offloading actions, if
3217 // required.
3218 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3219 break;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003220
Daniel Dunbar65229332009-03-13 11:38:42 +00003221 if (Current->getType() == types::TY_Nothing)
3222 break;
3223 }
3224
Samuel Antao64e965e2016-09-30 15:34:19 +00003225 // If we ended with something, add to the output list.
3226 if (Current)
Justin Lebar41094612016-01-11 23:07:27 +00003227 Actions.push_back(Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003228
3229 // Add any top level actions generated for offloading.
3230 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003231 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003232
Samuel Antao64e965e2016-09-30 15:34:19 +00003233 // Add a link action if necessary.
Samuel Antaod06239d2016-07-15 23:13:27 +00003234 if (!LinkerInputs.empty()) {
Samuel Antao64e965e2016-09-30 15:34:19 +00003235 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
3236 LA = OffloadBuilder.processHostLinkAction(LA);
3237 Actions.push_back(LA);
Samuel Antaod06239d2016-07-15 23:13:27 +00003238 }
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003239
3240 // If we are linking, claim any options which are obviously only used for
3241 // compilation.
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003242 if (FinalPhase == phases::Link && PL.size() == 1) {
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003243 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003244 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
3245 }
3246
3247 // Claim ignored clang-cl options.
3248 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
Artem Belevichbaae0932015-07-28 21:01:30 +00003249
Justin Lebardc3c5042016-04-19 02:27:07 +00003250 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
3251 // to non-CUDA compilations and should not trigger warnings there.
Artem Belevichbaae0932015-07-28 21:01:30 +00003252 Args.ClaimAllArgs(options::OPT_cuda_host_only);
Justin Lebardc3c5042016-04-19 02:27:07 +00003253 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
Daniel Dunbar65229332009-03-13 11:38:42 +00003254}
3255
Artem Belevichecb178b2018-03-21 22:22:59 +00003256Action *Driver::ConstructPhaseAction(
3257 Compilation &C, const ArgList &Args, phases::ID Phase, Action *Input,
3258 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003259 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
Samuel Antao64e965e2016-09-30 15:34:19 +00003260
3261 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
3262 // encode this in the steps because the intermediate type depends on
3263 // arguments. Just special case here.
3264 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
3265 return Input;
3266
Daniel Dunbar65229332009-03-13 11:38:42 +00003267 // Build the appropriate action.
3268 switch (Phase) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003269 case phases::Link:
3270 llvm_unreachable("link action invalid here.");
Daniel Dunbar65229332009-03-13 11:38:42 +00003271 case phases::Preprocess: {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003272 types::ID OutputTy;
3273 // -{M, MM} alter the output type.
Daniel Dunbar86aed7d2010-12-08 21:33:40 +00003274 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003275 OutputTy = types::TY_Dependencies;
3276 } else {
David Blaikie5d577a22012-06-29 22:03:56 +00003277 OutputTy = Input->getType();
3278 if (!Args.hasFlag(options::OPT_frewrite_includes,
Justin Bognerce8245b2014-06-24 08:01:01 +00003279 options::OPT_fno_rewrite_includes, false) &&
Richard Smith86a3ef52017-06-09 21:24:02 +00003280 !Args.hasFlag(options::OPT_frewrite_imports,
3281 options::OPT_fno_rewrite_imports, false) &&
Justin Bognerce8245b2014-06-24 08:01:01 +00003282 !CCGenDiagnostics)
David Blaikie5d577a22012-06-29 22:03:56 +00003283 OutputTy = types::getPreprocessedType(OutputTy);
Daniel Dunbard67a3222009-03-30 06:36:42 +00003284 assert(OutputTy != types::TY_INVALID &&
3285 "Cannot preprocess this input type!");
3286 }
Justin Lebar41094612016-01-11 23:07:27 +00003287 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
Daniel Dunbar65229332009-03-13 11:38:42 +00003288 }
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003289 case phases::Precompile: {
Richard Smithdd4ad3d2016-08-30 19:06:26 +00003290 types::ID OutputTy = getPrecompiledType(Input->getType());
3291 assert(OutputTy != types::TY_INVALID &&
3292 "Cannot precompile this input type!");
Richard Smithcd35eff2018-09-15 01:21:16 +00003293
3294 // If we're given a module name, precompile header file inputs as a
3295 // module, not as a precompiled header.
3296 const char *ModName = nullptr;
3297 if (OutputTy == types::TY_PCH) {
3298 if (Arg *A = Args.getLastArg(options::OPT_fmodule_name_EQ))
3299 ModName = A->getValue();
3300 if (ModName)
3301 OutputTy = types::TY_ModuleFile;
3302 }
3303
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003304 if (Args.hasArg(options::OPT_fsyntax_only)) {
3305 // Syntax checks should not emit a PCH file
3306 OutputTy = types::TY_Nothing;
3307 }
Richard Smithcd35eff2018-09-15 01:21:16 +00003308
3309 if (ModName)
3310 return C.MakeAction<HeaderModulePrecompileJobAction>(Input, OutputTy,
3311 ModName);
Justin Lebar41094612016-01-11 23:07:27 +00003312 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003313 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003314 case phases::Compile: {
David Blaikie486f4402014-08-29 07:25:23 +00003315 if (Args.hasArg(options::OPT_fsyntax_only))
Justin Lebar41094612016-01-11 23:07:27 +00003316 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
David Blaikie486f4402014-08-29 07:25:23 +00003317 if (Args.hasArg(options::OPT_rewrite_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003318 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003319 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003320 return C.MakeAction<CompileJobAction>(Input,
3321 types::TY_RewrittenLegacyObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003322 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
Justin Lebar41094612016-01-11 23:07:27 +00003323 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
David Blaikie486f4402014-08-29 07:25:23 +00003324 if (Args.hasArg(options::OPT__migrate))
Justin Lebar41094612016-01-11 23:07:27 +00003325 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
David Blaikie486f4402014-08-29 07:25:23 +00003326 if (Args.hasArg(options::OPT_emit_ast))
Justin Lebar41094612016-01-11 23:07:27 +00003327 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
David Blaikie486f4402014-08-29 07:25:23 +00003328 if (Args.hasArg(options::OPT_module_file_info))
Justin Lebar41094612016-01-11 23:07:27 +00003329 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
David Blaikie486f4402014-08-29 07:25:23 +00003330 if (Args.hasArg(options::OPT_verify_pch))
Justin Lebar41094612016-01-11 23:07:27 +00003331 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
3332 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
Bob Wilson23a55f12014-12-21 07:00:00 +00003333 }
3334 case phases::Backend: {
Artem Belevichecb178b2018-03-21 22:22:59 +00003335 if (isUsingLTO() && TargetDeviceOffloadKind == Action::OFK_None) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003336 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003337 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003338 return C.MakeAction<BackendJobAction>(Input, Output);
David Blaikie486f4402014-08-29 07:25:23 +00003339 }
3340 if (Args.hasArg(options::OPT_emit_llvm)) {
Shuxin Yang4b3c7ff2013-08-23 21:34:57 +00003341 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003342 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003343 return C.MakeAction<BackendJobAction>(Input, Output);
Daniel Dunbar65229332009-03-13 11:38:42 +00003344 }
Justin Lebar41094612016-01-11 23:07:27 +00003345 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
Daniel Dunbar65229332009-03-13 11:38:42 +00003346 }
3347 case phases::Assemble:
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003348 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
Daniel Dunbar65229332009-03-13 11:38:42 +00003349 }
3350
David Blaikie83d382b2011-09-23 05:06:16 +00003351 llvm_unreachable("invalid phase in ConstructPhaseAction");
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003352}
3353
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00003354void Driver::BuildJobs(Compilation &C) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003355 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003356
3357 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3358
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003359 // It is an error to provide a -o option if we are making multiple output
3360 // files.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003361 if (FinalOutput) {
3362 unsigned NumOutputs = 0;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003363 for (const Action *A : C.getActions())
3364 if (A->getType() != types::TY_Nothing)
Daniel Dunbare75d8342009-03-16 06:56:51 +00003365 ++NumOutputs;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003366
Daniel Dunbare75d8342009-03-16 06:56:51 +00003367 if (NumOutputs > 1) {
3368 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
Craig Topper92fc2df2014-05-17 16:56:41 +00003369 FinalOutput = nullptr;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003370 }
3371 }
3372
Chad Rosier35767232013-04-30 22:01:21 +00003373 // Collect the list of architectures.
3374 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003375 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
3376 for (const Arg *A : C.getArgs())
Chad Rosier35767232013-04-30 22:01:21 +00003377 if (A->getOption().matches(options::OPT_arch))
3378 ArchNames.insert(A->getValue());
Chad Rosier35767232013-04-30 22:01:21 +00003379
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003380 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
3381 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003382 for (Action *A : C.getActions()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003383 // If we are linking an image for multiple archs then the linker wants
3384 // -arch_multiple and -final_output <final image name>. Unfortunately, this
3385 // doesn't fit in cleanly because we have to pass this information down.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003386 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003387 // FIXME: This is a hack; find a cleaner way to integrate this into the
3388 // process.
Craig Topper92fc2df2014-05-17 16:56:41 +00003389 const char *LinkingOutput = nullptr;
Daniel Dunbardd765242009-03-26 16:12:09 +00003390 if (isa<LipoJobAction>(A)) {
Daniel Dunbare75d8342009-03-16 06:56:51 +00003391 if (FinalOutput)
Richard Smithbd55daf2012-11-01 04:30:05 +00003392 LinkingOutput = FinalOutput->getValue();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003393 else
Hans Wennborga7707222015-01-09 17:38:53 +00003394 LinkingOutput = getDefaultImageName();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003395 }
3396
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003397 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003398 /*BoundArch*/ StringRef(),
Daniel Dunbare75d8342009-03-16 06:56:51 +00003399 /*AtTopLevel*/ true,
Chad Rosier35767232013-04-30 22:01:21 +00003400 /*MultipleArchs*/ ArchNames.size() > 1,
Samuel Antaod06239d2016-07-15 23:13:27 +00003401 /*LinkingOutput*/ LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003402 /*TargetDeviceOffloadKind*/ Action::OFK_None);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003403 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003404
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003405 // If the user passed -Qunused-arguments or there were errors, don't warn
3406 // about any unused arguments.
Argyrios Kyrtzidis31448a42010-11-18 21:47:07 +00003407 if (Diags.hasErrorOccurred() ||
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003408 C.getArgs().hasArg(options::OPT_Qunused_arguments))
Daniel Dunbard175d972009-03-18 18:03:46 +00003409 return;
3410
Daniel Dunbar58399ae2009-03-29 22:24:54 +00003411 // Claim -### here.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003412 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003413
Nico Weber47bf5052016-04-25 21:15:49 +00003414 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003415 (void)C.getArgs().hasArg(options::OPT_driver_mode);
Nico Weber47bf5052016-04-25 21:15:49 +00003416 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
Hans Wennborg70850d82013-07-18 20:29:38 +00003417
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003418 for (Arg *A : C.getArgs()) {
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003419 // FIXME: It would be nice to be able to send the argument to the
David Blaikie9c902b52011-09-25 23:23:43 +00003420 // DiagnosticsEngine, so that extra values, position, and so on could be
3421 // printed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003422 if (!A->isClaimed()) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +00003423 if (A->getOption().hasFlag(options::NoArgumentUnused))
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003424 continue;
3425
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003426 // Suppress the warning automatically if this is just a flag, and it is an
3427 // instance of an argument we already claimed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003428 const Option &Opt = A->getOption();
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00003429 if (Opt.getKind() == Option::FlagClass) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003430 bool DuplicateClaimed = false;
3431
Sean Silva14facf32015-06-09 01:57:17 +00003432 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
3433 if (AA->isClaimed()) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003434 DuplicateClaimed = true;
3435 break;
3436 }
3437 }
3438
3439 if (DuplicateClaimed)
3440 continue;
3441 }
3442
Ehsan Akhgarid8518332016-01-25 21:14:52 +00003443 // In clang-cl, don't mention unknown arguments here since they have
3444 // already been warned about.
3445 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
3446 Diag(clang::diag::warn_drv_unused_argument)
3447 << A->getAsString(C.getArgs());
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003448 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003449 }
Daniel Dunbar95e6b192009-03-13 22:12:33 +00003450}
Daniel Dunbarc4343942010-02-03 03:07:56 +00003451
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003452namespace {
3453/// Utility class to control the collapse of dependent actions and select the
3454/// tools accordingly.
3455class ToolSelector final {
3456 /// The tool chain this selector refers to.
3457 const ToolChain &TC;
Daniel Dunbarf9ff3502010-05-14 02:03:00 +00003458
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003459 /// The compilation this selector refers to.
3460 const Compilation &C;
Samuel Antaod06239d2016-07-15 23:13:27 +00003461
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003462 /// The base action this selector refers to.
3463 const JobAction *BaseAction;
Samuel Antaod06239d2016-07-15 23:13:27 +00003464
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003465 /// Set to true if the current toolchain refers to host actions.
3466 bool IsHostSelector;
Samuel Antaod06239d2016-07-15 23:13:27 +00003467
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003468 /// Set to true if save-temps and embed-bitcode functionalities are active.
3469 bool SaveTemps;
3470 bool EmbedBitcode;
3471
3472 /// Get previous dependent action or null if that does not exist. If
3473 /// \a CanBeCollapsed is false, that action must be legal to collapse or
3474 /// null will be returned.
3475 const JobAction *getPrevDependentAction(const ActionList &Inputs,
3476 ActionList &SavedOffloadAction,
3477 bool CanBeCollapsed = true) {
3478 // An option can be collapsed only if it has a single input.
3479 if (Inputs.size() != 1)
Craig Topper92fc2df2014-05-17 16:56:41 +00003480 return nullptr;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003481
3482 Action *CurAction = *Inputs.begin();
3483 if (CanBeCollapsed &&
3484 !CurAction->isCollapsingWithNextDependentActionLegal())
3485 return nullptr;
3486
3487 // If the input action is an offload action. Look through it and save any
3488 // offload action that can be dropped in the event of a collapse.
3489 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
3490 // If the dependent action is a device action, we will attempt to collapse
3491 // only with other device actions. Otherwise, we would do the same but
3492 // with host actions only.
3493 if (!IsHostSelector) {
3494 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
3495 CurAction =
3496 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
3497 if (CanBeCollapsed &&
3498 !CurAction->isCollapsingWithNextDependentActionLegal())
3499 return nullptr;
3500 SavedOffloadAction.push_back(OA);
3501 return dyn_cast<JobAction>(CurAction);
3502 }
3503 } else if (OA->hasHostDependence()) {
3504 CurAction = OA->getHostDependence();
3505 if (CanBeCollapsed &&
3506 !CurAction->isCollapsingWithNextDependentActionLegal())
3507 return nullptr;
3508 SavedOffloadAction.push_back(OA);
3509 return dyn_cast<JobAction>(CurAction);
3510 }
3511 return nullptr;
3512 }
3513
3514 return dyn_cast<JobAction>(CurAction);
3515 }
3516
3517 /// Return true if an assemble action can be collapsed.
3518 bool canCollapseAssembleAction() const {
3519 return TC.useIntegratedAs() && !SaveTemps &&
3520 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
3521 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
3522 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
3523 }
3524
3525 /// Return true if a preprocessor action can be collapsed.
3526 bool canCollapsePreprocessorAction() const {
3527 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
3528 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
3529 !C.getArgs().hasArg(options::OPT_rewrite_objc);
3530 }
3531
3532 /// Struct that relates an action with the offload actions that would be
3533 /// collapsed with it.
3534 struct JobActionInfo final {
3535 /// The action this info refers to.
3536 const JobAction *JA = nullptr;
3537 /// The offload actions we need to take care off if this action is
3538 /// collapsed.
3539 ActionList SavedOffloadAction;
3540 };
3541
3542 /// Append collapsed offload actions from the give nnumber of elements in the
3543 /// action info array.
3544 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
3545 ArrayRef<JobActionInfo> &ActionInfo,
3546 unsigned ElementNum) {
3547 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
3548 for (unsigned I = 0; I < ElementNum; ++I)
3549 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
3550 ActionInfo[I].SavedOffloadAction.end());
3551 }
3552
3553 /// Functions that attempt to perform the combining. They detect if that is
3554 /// legal, and if so they update the inputs \a Inputs and the offload action
3555 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
3556 /// the combined action is returned. If the combining is not legal or if the
3557 /// tool does not exist, null is returned.
3558 /// Currently three kinds of collapsing are supported:
3559 /// - Assemble + Backend + Compile;
3560 /// - Assemble + Backend ;
3561 /// - Backend + Compile.
3562 const Tool *
3563 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003564 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003565 ActionList &CollapsedOffloadAction) {
3566 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
3567 return nullptr;
3568 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3569 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3570 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
3571 if (!AJ || !BJ || !CJ)
3572 return nullptr;
3573
3574 // Get compiler tool.
3575 const Tool *T = TC.SelectTool(*CJ);
3576 if (!T)
3577 return nullptr;
3578
Steven Wu574b0f22016-03-01 01:07:58 +00003579 // When using -fembed-bitcode, it is required to have the same tool (clang)
3580 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
3581 if (EmbedBitcode) {
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003582 const Tool *BT = TC.SelectTool(*BJ);
3583 if (BT == T)
3584 return nullptr;
Steven Wu574b0f22016-03-01 01:07:58 +00003585 }
Bob Wilson23a55f12014-12-21 07:00:00 +00003586
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003587 if (!T->hasIntegratedAssembler())
Bob Wilson23a55f12014-12-21 07:00:00 +00003588 return nullptr;
Samuel Antaod06239d2016-07-15 23:13:27 +00003589
Richard Smithcd35eff2018-09-15 01:21:16 +00003590 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003591 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3592 /*NumElements=*/3);
3593 return T;
3594 }
3595 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003596 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003597 ActionList &CollapsedOffloadAction) {
3598 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
3599 return nullptr;
3600 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3601 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3602 if (!AJ || !BJ)
3603 return nullptr;
3604
3605 // Retrieve the compile job, backend action must always be preceded by one.
3606 ActionList CompileJobOffloadActions;
3607 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
3608 /*CanBeCollapsed=*/false);
3609 if (!AJ || !BJ || !CJ)
3610 return nullptr;
3611
3612 assert(isa<CompileJobAction>(CJ) &&
3613 "Expecting compile job preceding backend job.");
3614
3615 // Get compiler tool.
3616 const Tool *T = TC.SelectTool(*CJ);
3617 if (!T)
3618 return nullptr;
3619
3620 if (!T->hasIntegratedAssembler())
3621 return nullptr;
3622
Richard Smithcd35eff2018-09-15 01:21:16 +00003623 Inputs = BJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003624 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3625 /*NumElements=*/2);
3626 return T;
3627 }
3628 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003629 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003630 ActionList &CollapsedOffloadAction) {
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003631 if (ActionInfo.size() < 2)
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003632 return nullptr;
3633 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3634 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3635 if (!BJ || !CJ)
3636 return nullptr;
3637
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003638 // Check if the initial input (to the compile job or its predessor if one
3639 // exists) is LLVM bitcode. In that case, no preprocessor step is required
3640 // and we can still collapse the compile and backend jobs when we have
3641 // -save-temps. I.e. there is no need for a separate compile job just to
3642 // emit unoptimized bitcode.
3643 bool InputIsBitcode = true;
3644 for (size_t i = 1; i < ActionInfo.size(); i++)
3645 if (ActionInfo[i].JA->getType() != types::TY_LLVM_BC &&
3646 ActionInfo[i].JA->getType() != types::TY_LTO_BC) {
3647 InputIsBitcode = false;
3648 break;
3649 }
3650 if (!InputIsBitcode && !canCollapsePreprocessorAction())
3651 return nullptr;
3652
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003653 // Get compiler tool.
3654 const Tool *T = TC.SelectTool(*CJ);
3655 if (!T)
3656 return nullptr;
3657
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003658 if (T->canEmitIR() && ((SaveTemps && !InputIsBitcode) || EmbedBitcode))
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003659 return nullptr;
3660
Richard Smithcd35eff2018-09-15 01:21:16 +00003661 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003662 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3663 /*NumElements=*/2);
3664 return T;
3665 }
3666
3667 /// Updates the inputs if the obtained tool supports combining with
3668 /// preprocessor action, and the current input is indeed a preprocessor
3669 /// action. If combining results in the collapse of offloading actions, those
3670 /// are appended to \a CollapsedOffloadAction.
Richard Smithcd35eff2018-09-15 01:21:16 +00003671 void combineWithPreprocessor(const Tool *T, ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003672 ActionList &CollapsedOffloadAction) {
3673 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3674 return;
3675
3676 // Attempt to get a preprocessor action dependence.
3677 ActionList PreprocessJobOffloadActions;
Richard Smithcd35eff2018-09-15 01:21:16 +00003678 ActionList NewInputs;
3679 for (Action *A : Inputs) {
3680 auto *PJ = getPrevDependentAction({A}, PreprocessJobOffloadActions);
3681 if (!PJ || !isa<PreprocessJobAction>(PJ)) {
3682 NewInputs.push_back(A);
3683 continue;
3684 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003685
Richard Smithcd35eff2018-09-15 01:21:16 +00003686 // This is legal to combine. Append any offload action we found and add the
3687 // current input to preprocessor inputs.
3688 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3689 PreprocessJobOffloadActions.end());
3690 NewInputs.append(PJ->input_begin(), PJ->input_end());
3691 }
3692 Inputs = NewInputs;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003693 }
3694
3695public:
3696 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3697 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3698 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3699 EmbedBitcode(EmbedBitcode) {
3700 assert(BaseAction && "Invalid base action.");
3701 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3702 }
3703
3704 /// Check if a chain of actions can be combined and return the tool that can
3705 /// handle the combination of actions. The pointer to the current inputs \a
3706 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3707 /// connected to collapsed actions are updated accordingly. The latter enables
3708 /// the caller of the selector to process them afterwards instead of just
3709 /// dropping them. If no suitable tool is found, null will be returned.
Richard Smithcd35eff2018-09-15 01:21:16 +00003710 const Tool *getTool(ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003711 ActionList &CollapsedOffloadAction) {
3712 //
3713 // Get the largest chain of actions that we could combine.
3714 //
3715
3716 SmallVector<JobActionInfo, 5> ActionChain(1);
3717 ActionChain.back().JA = BaseAction;
3718 while (ActionChain.back().JA) {
3719 const Action *CurAction = ActionChain.back().JA;
3720
3721 // Grow the chain by one element.
3722 ActionChain.resize(ActionChain.size() + 1);
3723 JobActionInfo &AI = ActionChain.back();
3724
3725 // Attempt to fill it with the
3726 AI.JA =
3727 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
Daniel Dunbarc4343942010-02-03 03:07:56 +00003728 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003729
3730 // Pop the last action info as it could not be filled.
3731 ActionChain.pop_back();
3732
3733 //
3734 // Attempt to combine actions. If all combining attempts failed, just return
3735 // the tool of the provided action. At the end we attempt to combine the
3736 // action with any preprocessor action it may depend on.
3737 //
3738
3739 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3740 CollapsedOffloadAction);
3741 if (!T)
3742 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3743 if (!T)
3744 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3745 if (!T) {
Richard Smithcd35eff2018-09-15 01:21:16 +00003746 Inputs = BaseAction->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003747 T = TC.SelectTool(*BaseAction);
3748 }
3749
3750 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3751 return T;
Daniel Dunbarc4343942010-02-03 03:07:56 +00003752 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003753};
Daniel Dunbarc4343942010-02-03 03:07:56 +00003754}
3755
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003756/// Return a string that uniquely identifies the result of a job. The bound arch
3757/// is not necessarily represented in the toolchain's triple -- for example,
3758/// armv7 and armv7s both map to the same triple -- so we need both in our map.
3759/// Also, we need to add the offloading device kind, as the same tool chain can
3760/// be used for host and device for some programming models, e.g. OpenMP.
3761static std::string GetTriplePlusArchString(const ToolChain *TC,
3762 StringRef BoundArch,
3763 Action::OffloadKind OffloadKind) {
Justin Lebar55c83322016-01-16 03:30:08 +00003764 std::string TriplePlusArch = TC->getTriple().normalize();
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003765 if (!BoundArch.empty()) {
Justin Lebar55c83322016-01-16 03:30:08 +00003766 TriplePlusArch += "-";
3767 TriplePlusArch += BoundArch;
3768 }
Samuel Antao59efaed2016-10-27 17:31:22 +00003769 TriplePlusArch += "-";
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003770 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3771 return TriplePlusArch;
3772}
3773
3774InputInfo Driver::BuildJobsForAction(
3775 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3776 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3777 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3778 Action::OffloadKind TargetDeviceOffloadKind) const {
3779 std::pair<const Action *, std::string> ActionTC = {
3780 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003781 auto CachedResult = CachedResults.find(ActionTC);
3782 if (CachedResult != CachedResults.end()) {
3783 return CachedResult->second;
3784 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003785 InputInfo Result = BuildJobsForActionNoCache(
3786 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003787 CachedResults, TargetDeviceOffloadKind);
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003788 CachedResults[ActionTC] = Result;
3789 return Result;
3790}
3791
3792InputInfo Driver::BuildJobsForActionNoCache(
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003793 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003794 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
Samuel Antaod06239d2016-07-15 23:13:27 +00003795 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003796 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003797 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbarc4acf9d2009-03-18 23:18:19 +00003798
Samuel Antaod06239d2016-07-15 23:13:27 +00003799 InputInfoList OffloadDependencesInputInfo;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003800 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
Samuel Antaod06239d2016-07-15 23:13:27 +00003801 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
Alex Lorenz4003a982017-08-08 11:22:21 +00003802 // The 'Darwin' toolchain is initialized only when its arguments are
3803 // computed. Get the default arguments for OFK_None to ensure that
3804 // initialization is performed before processing the offload action.
3805 // FIXME: Remove when darwin's toolchain is initialized during construction.
3806 C.getArgsForToolChain(TC, BoundArch, Action::OFK_None);
3807
Samuel Antaod06239d2016-07-15 23:13:27 +00003808 // The offload action is expected to be used in four different situations.
3809 //
3810 // a) Set a toolchain/architecture/kind for a host action:
3811 // Host Action 1 -> OffloadAction -> Host Action 2
3812 //
3813 // b) Set a toolchain/architecture/kind for a device action;
3814 // Device Action 1 -> OffloadAction -> Device Action 2
3815 //
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003816 // c) Specify a device dependence to a host action;
Samuel Antaod06239d2016-07-15 23:13:27 +00003817 // Device Action 1 _
3818 // \
3819 // Host Action 1 ---> OffloadAction -> Host Action 2
3820 //
3821 // d) Specify a host dependence to a device action.
3822 // Host Action 1 _
3823 // \
3824 // Device Action 1 ---> OffloadAction -> Device Action 2
3825 //
3826 // For a) and b), we just return the job generated for the dependence. For
3827 // c) and d) we override the current action with the host/device dependence
3828 // if the current toolchain is host/device and set the offload dependences
3829 // info with the jobs obtained from the device/host dependence(s).
3830
3831 // If there is a single device option, just generate the job for it.
3832 if (OA->hasSingleDeviceDependence()) {
3833 InputInfo DevA;
3834 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3835 const char *DepBoundArch) {
3836 DevA =
3837 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3838 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003839 CachedResults, DepA->getOffloadingDeviceKind());
Samuel Antaod06239d2016-07-15 23:13:27 +00003840 });
3841 return DevA;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003842 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003843
3844 // If 'Action 2' is host, we generate jobs for the device dependences and
3845 // override the current action with the host dependence. Otherwise, we
3846 // generate the host dependences and override the action with the device
3847 // dependence. The dependences can't therefore be a top-level action.
3848 OA->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003849 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003850 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3851 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3852 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3853 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003854 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003855 });
3856
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003857 A = BuildingForOffloadDevice
Samuel Antaod06239d2016-07-15 23:13:27 +00003858 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3859 : OA->getHostDependence();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003860 }
3861
Daniel Dunbare75d8342009-03-16 06:56:51 +00003862 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003863 // FIXME: It would be nice to not claim this here; maybe the old scheme of
3864 // just using Args was better?
Daniel Dunbar5cdf3e02009-03-19 07:29:38 +00003865 const Arg &Input = IA->getInputArg();
3866 Input.claim();
Daniel Dunbar35cbfeb2010-06-09 22:31:08 +00003867 if (Input.getOption().matches(options::OPT_INPUT)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00003868 const char *Name = Input.getValue();
Justin Lebard98cea82016-01-11 23:15:21 +00003869 return InputInfo(A, Name, /* BaseInput = */ Name);
Douglas Katzman678d0cb2015-06-16 18:01:24 +00003870 }
Justin Lebard98cea82016-01-11 23:15:21 +00003871 return InputInfo(A, &Input, /* BaseInput = */ "");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003872 }
3873
3874 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003875 const ToolChain *TC;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003876 StringRef ArchName = BAA->getArchName();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003877
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003878 if (!ArchName.empty())
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003879 TC = &getToolChain(C.getArgs(),
Petr Hosekdd38d932018-05-29 22:35:39 +00003880 computeTargetTriple(*this, TargetTriple,
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003881 C.getArgs(), ArchName));
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003882 else
3883 TC = &C.getDefaultToolChain();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003884
Nico Weber5a459f82016-02-23 19:30:43 +00003885 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00003886 MultipleArchs, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003887 TargetDeviceOffloadKind);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003888 }
3889
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003890
Richard Smithcd35eff2018-09-15 01:21:16 +00003891 ActionList Inputs = A->getInputs();
Daniel Dunbarc4343942010-02-03 03:07:56 +00003892
3893 const JobAction *JA = cast<JobAction>(A);
Samuel Antaod06239d2016-07-15 23:13:27 +00003894 ActionList CollapsedOffloadActions;
3895
Mehdi Amini6683e222017-01-24 18:12:25 +00003896 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
3897 embedBitcodeInObject() && !isUsingLTO());
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003898 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
3899
Rafael Espindola79764462013-03-24 15:06:53 +00003900 if (!T)
Justin Lebar9eaa4892016-01-11 23:09:32 +00003901 return InputInfo();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003902
Samuel Antaod06239d2016-07-15 23:13:27 +00003903 // If we've collapsed action list that contained OffloadAction we
3904 // need to build jobs for host/device-side inputs it may have held.
3905 for (const auto *OA : CollapsedOffloadActions)
3906 cast<OffloadAction>(OA)->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003907 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003908 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3909 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
Artem Belevichbee2f412016-08-22 18:50:34 +00003910 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
Samuel Antaod06239d2016-07-15 23:13:27 +00003911 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003912 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003913 });
Artem Belevichf8144ab2015-08-27 18:10:41 +00003914
Daniel Dunbare75d8342009-03-16 06:56:51 +00003915 // Only use pipes when there is exactly one input.
Daniel Dunbar1a093d22009-03-18 06:00:36 +00003916 InputInfoList InputInfos;
Richard Smithcd35eff2018-09-15 01:21:16 +00003917 for (const Action *Input : Inputs) {
Eric Christopher14668dd2013-02-18 00:38:25 +00003918 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
3919 // shouldn't get temporary output names.
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003920 // FIXME: Clean this up.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003921 bool SubJobAtTopLevel =
3922 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
Samuel Antaod06239d2016-07-15 23:13:27 +00003923 InputInfos.push_back(BuildJobsForAction(
3924 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003925 CachedResults, A->getOffloadingDeviceKind()));
Daniel Dunbare75d8342009-03-16 06:56:51 +00003926 }
3927
Daniel Dunbare75d8342009-03-16 06:56:51 +00003928 // Always use the first input as the base input.
3929 const char *BaseInput = InputInfos[0].getBaseInput();
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003930
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003931 // ... except dsymutil actions, which use their actual input as the base
3932 // input.
3933 if (JA->getType() == types::TY_dSYM)
3934 BaseInput = InputInfos[0].getFilename();
3935
Richard Smithcd35eff2018-09-15 01:21:16 +00003936 // ... and in header module compilations, which use the module name.
3937 if (auto *ModuleJA = dyn_cast<HeaderModulePrecompileJobAction>(JA))
3938 BaseInput = ModuleJA->getModuleName();
3939
Samuel Antaod06239d2016-07-15 23:13:27 +00003940 // Append outputs of offload device jobs to the input list
3941 if (!OffloadDependencesInputInfo.empty())
3942 InputInfos.append(OffloadDependencesInputInfo.begin(),
3943 OffloadDependencesInputInfo.end());
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003944
Vedant Kumar18286cf2016-07-27 23:02:20 +00003945 // Set the effective triple of the toolchain for the duration of this job.
3946 llvm::Triple EffectiveTriple;
3947 const ToolChain &ToolTC = T->getToolChain();
Samuel Antao31fef982016-10-27 17:39:44 +00003948 const ArgList &Args =
3949 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
Vedant Kumar18286cf2016-07-27 23:02:20 +00003950 if (InputInfos.size() != 1) {
3951 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
3952 } else {
3953 // Pass along the input type if it can be unambiguously determined.
3954 EffectiveTriple = llvm::Triple(
3955 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
3956 }
3957 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
3958
Daniel Dunbard00272f2010-08-02 02:38:15 +00003959 // Determine the place to write output to, if any.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003960 InputInfo Result;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003961 InputInfoList UnbundlingResults;
3962 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
3963 // If we have an unbundling job, we need to create results for all the
3964 // outputs. We also update the results cache so that other actions using
3965 // this unbundling action can get the right results.
3966 for (auto &UI : UA->getDependentActionsInfo()) {
3967 assert(UI.DependentOffloadKind != Action::OFK_None &&
3968 "Unbundling with no offloading??");
3969
3970 // Unbundling actions are never at the top level. When we generate the
3971 // offloading prefix, we also do that for the host file because the
3972 // unbundling action does not change the type of the output which can
3973 // cause a overwrite.
3974 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3975 UI.DependentOffloadKind,
3976 UI.DependentToolChain->getTriple().normalize(),
3977 /*CreatePrefixForHost=*/true);
3978 auto CurI = InputInfo(
Yaxun Liu609f7522018-05-11 19:02:18 +00003979 UA,
3980 GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
3981 /*AtTopLevel=*/false,
3982 MultipleArchs ||
3983 UI.DependentOffloadKind == Action::OFK_HIP,
3984 OffloadingPrefix),
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003985 BaseInput);
3986 // Save the unbundling result.
3987 UnbundlingResults.push_back(CurI);
3988
3989 // Get the unique string identifier for this dependence and cache the
3990 // result.
Yaxun Liu470b8332018-06-06 19:44:10 +00003991 StringRef Arch;
3992 if (TargetDeviceOffloadKind == Action::OFK_HIP) {
3993 if (UI.DependentOffloadKind == Action::OFK_Host)
Yaxun Liuf37b50a2018-07-24 01:03:44 +00003994 Arch = StringRef();
Yaxun Liu470b8332018-06-06 19:44:10 +00003995 else
3996 Arch = UI.DependentBoundArch;
3997 } else
3998 Arch = BoundArch;
3999
4000 CachedResults[{A, GetTriplePlusArchString(UI.DependentToolChain, Arch,
4001 UI.DependentOffloadKind)}] =
4002 CurI;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004003 }
4004
4005 // Now that we have all the results generated, select the one that should be
4006 // returned for the current depending action.
4007 std::pair<const Action *, std::string> ActionTC = {
4008 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
4009 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
4010 "Result does not exist??");
4011 Result = CachedResults[ActionTC];
4012 } else if (JA->getType() == types::TY_Nothing)
Justin Lebard98cea82016-01-11 23:15:21 +00004013 Result = InputInfo(A, BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004014 else {
4015 // We only have to generate a prefix for the host if this is not a top-level
4016 // action.
4017 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4018 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
4019 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
4020 !AtTopLevel);
Justin Lebard98cea82016-01-11 23:15:21 +00004021 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
Samuel Antaod06239d2016-07-15 23:13:27 +00004022 AtTopLevel, MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004023 OffloadingPrefix),
Justin Lebard98cea82016-01-11 23:15:21 +00004024 BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004025 }
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004026
Chad Rosierbe10f982011-08-02 17:58:04 +00004027 if (CCCPrintBindings && !CCGenDiagnostics) {
Rafael Espindola79764462013-03-24 15:06:53 +00004028 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
4029 << " - \"" << T->getName() << "\", inputs: [";
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004030 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
4031 llvm::errs() << InputInfos[i].getAsString();
4032 if (i + 1 != e)
4033 llvm::errs() << ", ";
4034 }
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004035 if (UnbundlingResults.empty())
4036 llvm::errs() << "], output: " << Result.getAsString() << "\n";
4037 else {
4038 llvm::errs() << "], outputs: [";
4039 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
4040 llvm::errs() << UnbundlingResults[i].getAsString();
4041 if (i + 1 != e)
4042 llvm::errs() << ", ";
4043 }
4044 llvm::errs() << "] \n";
4045 }
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004046 } else {
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004047 if (UnbundlingResults.empty())
4048 T->ConstructJob(
4049 C, *JA, Result, InputInfos,
4050 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4051 LinkingOutput);
4052 else
Samuel Antao7108bf32016-11-03 15:41:50 +00004053 T->ConstructJobMultipleOutputs(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004054 C, *JA, UnbundlingResults, InputInfos,
4055 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4056 LinkingOutput);
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004057 }
Justin Lebar9eaa4892016-01-11 23:09:32 +00004058 return Result;
Daniel Dunbare75d8342009-03-16 06:56:51 +00004059}
4060
Hans Wennborga7707222015-01-09 17:38:53 +00004061const char *Driver::getDefaultImageName() const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004062 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Hans Wennborga7707222015-01-09 17:38:53 +00004063 return Target.isOSWindows() ? "a.exe" : "a.out";
4064}
4065
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004066/// Create output filename based on ArgValue, which could either be a
Hans Wennborg2c21f742013-10-17 16:16:23 +00004067/// full filename, filename without extension, or a directory. If ArgValue
4068/// does not provide a filename, then use BaseName, and use the extension
4069/// suitable for FileType.
Hans Wennborg207fcf02013-08-12 21:56:42 +00004070static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004071 StringRef BaseName,
4072 types::ID FileType) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004073 SmallString<128> Filename = ArgValue;
Justin Bogner5aaf2e72014-06-26 20:59:36 +00004074
Hans Wennborgf1a74252013-09-10 20:18:04 +00004075 if (ArgValue.empty()) {
4076 // If the argument is empty, output to BaseName in the current dir.
4077 Filename = BaseName;
4078 } else if (llvm::sys::path::is_separator(Filename.back())) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004079 // If the argument is a directory, output to BaseName in that dir.
4080 llvm::sys::path::append(Filename, BaseName);
4081 }
4082
4083 if (!llvm::sys::path::has_extension(ArgValue)) {
4084 // If the argument didn't provide an extension, then set it.
4085 const char *Extension = types::getTypeTempSuffix(FileType, true);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004086
4087 if (FileType == types::TY_Image &&
4088 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
4089 // The output file is a dll.
4090 Extension = "dll";
4091 }
4092
Hans Wennborg207fcf02013-08-12 21:56:42 +00004093 llvm::sys::path::replace_extension(Filename, Extension);
4094 }
4095
4096 return Args.MakeArgString(Filename.c_str());
4097}
4098
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004099const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004100 const char *BaseInput,
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004101 StringRef BoundArch, bool AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00004102 bool MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004103 StringRef OffloadingPrefix) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00004104 llvm::PrettyStackTraceString CrashInfo("Computing output path");
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004105 // Output to a user requested destination?
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004106 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004107 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
Chad Rosier633dcdc2013-01-24 19:14:47 +00004108 return C.addResultFile(FinalOutput->getValue(), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004109 }
4110
Hans Wennborge0053472013-12-20 18:40:46 +00004111 // For /P, preprocess to file named after BaseInput.
4112 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
4113 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
4114 StringRef BaseName = llvm::sys::path::filename(BaseInput);
Hans Wennborg04c764f2014-06-17 00:19:12 +00004115 StringRef NameArg;
Greg Bedwell065f70a2015-06-09 10:24:06 +00004116 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
Hans Wennborg04c764f2014-06-17 00:19:12 +00004117 NameArg = A->getValue();
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004118 return C.addResultFile(
4119 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
4120 &JA);
Hans Wennborge0053472013-12-20 18:40:46 +00004121 }
4122
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004123 // Default to writing to stdout?
David Blaikiebc023c92018-06-14 23:09:06 +00004124 if (AtTopLevel && !CCGenDiagnostics && isa<PreprocessJobAction>(JA))
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004125 return "-";
4126
Hans Wennborg2c21f742013-10-17 16:16:23 +00004127 // Is this the assembly listing for /FA?
4128 if (JA.getType() == types::TY_PP_Asm &&
4129 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
4130 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
4131 // Use /Fa and the input filename to determine the asm file name.
4132 StringRef BaseName = llvm::sys::path::filename(BaseInput);
4133 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004134 return C.addResultFile(
4135 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
4136 &JA);
Hans Wennborg2c21f742013-10-17 16:16:23 +00004137 }
4138
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004139 // Output to a temporary file?
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004140 if ((!AtTopLevel && !isSaveTempsEnabled() &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004141 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
Chad Rosierbe10f982011-08-02 17:58:04 +00004142 CCGenDiagnostics) {
Chad Rosier97c37372011-08-26 22:27:02 +00004143 StringRef Name = llvm::sys::path::filename(BaseInput);
4144 std::pair<StringRef, StringRef> Split = Name.split('.');
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004145 SmallString<128> TmpName;
4146 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
4147 Arg *A = C.getArgs().getLastArg(options::OPT_fcrash_diagnostics_dir);
4148 if (CCGenDiagnostics && A) {
4149 SmallString<128> CrashDirectory(A->getValue());
4150 llvm::sys::path::append(CrashDirectory, Split.first);
4151 const char *Middle = Suffix ? "-%%%%%%." : "-%%%%%%";
4152 std::error_code EC =
4153 llvm::sys::fs::createUniqueFile(CrashDirectory + Middle + Suffix, TmpName);
4154 if (EC) {
4155 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4156 return "";
4157 }
4158 } else {
4159 TmpName = GetTemporaryPath(Split.first, Suffix);
4160 }
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004161 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004162 }
4163
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004164 SmallString<128> BasePath(BaseInput);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004165 StringRef BaseName;
Daniel Dunbar67fea712011-03-25 18:16:51 +00004166
4167 // Dsymutil actions should use the full path.
Eric Christopher551ef452011-08-23 17:56:55 +00004168 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
Daniel Dunbar67fea712011-03-25 18:16:51 +00004169 BaseName = BasePath;
4170 else
4171 BaseName = llvm::sys::path::filename(BasePath);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004172
4173 // Determine what the derived output name should be.
4174 const char *NamedOutput;
Hans Wennborg2b89a262013-08-06 22:11:28 +00004175
Hans Wennborg625fba82016-10-04 21:01:04 +00004176 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004177 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
4178 // The /Fo or /o flag decides the object filename.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004179 StringRef Val =
4180 C.getArgs()
4181 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
4182 ->getValue();
4183 NamedOutput =
4184 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
Hans Wennborg207fcf02013-08-12 21:56:42 +00004185 } else if (JA.getType() == types::TY_Image &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004186 C.getArgs().hasArg(options::OPT__SLASH_Fe,
4187 options::OPT__SLASH_o)) {
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004188 // The /Fe or /o flag names the linked file.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004189 StringRef Val =
4190 C.getArgs()
4191 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
4192 ->getValue();
4193 NamedOutput =
4194 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004195 } else if (JA.getType() == types::TY_Image) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004196 if (IsCLMode()) {
4197 // clang-cl uses BaseName for the executable name.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004198 NamedOutput =
4199 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
Samuel Antao59efaed2016-10-27 17:31:22 +00004200 } else {
Hans Wennborga7707222015-01-09 17:38:53 +00004201 SmallString<128> Output(getDefaultImageName());
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004202 Output += OffloadingPrefix;
Samuel Antao59efaed2016-10-27 17:31:22 +00004203 if (MultipleArchs && !BoundArch.empty()) {
4204 Output += "-";
4205 Output.append(BoundArch);
4206 }
Chad Rosier35767232013-04-30 22:01:21 +00004207 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
Nico Weber2ca4be92016-03-01 23:16:44 +00004208 }
4209 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004210 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004211 } else {
Hans Wennborg0a096a02013-09-05 17:05:56 +00004212 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004213 assert(Suffix && "All types used for output should have a suffix.");
4214
4215 std::string::size_type End = std::string::npos;
4216 if (!types::appendSuffixForType(JA.getType()))
4217 End = BaseName.rfind('.');
Chad Rosier35767232013-04-30 22:01:21 +00004218 SmallString<128> Suffixed(BaseName.substr(0, End));
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004219 Suffixed += OffloadingPrefix;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004220 if (MultipleArchs && !BoundArch.empty()) {
Chad Rosier35767232013-04-30 22:01:21 +00004221 Suffixed += "-";
4222 Suffixed.append(BoundArch);
4223 }
Bob Wilson23a55f12014-12-21 07:00:00 +00004224 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
4225 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
4226 // optimized bitcode output.
4227 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
4228 JA.getType() == types::TY_LLVM_BC)
4229 Suffixed += ".tmp";
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004230 Suffixed += '.';
4231 Suffixed += Suffix;
4232 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
4233 }
4234
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004235 // Prepend object file path if -save-temps=obj
4236 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
4237 JA.getType() != types::TY_PCH) {
4238 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
4239 SmallString<128> TempPath(FinalOutput->getValue());
4240 llvm::sys::path::remove_filename(TempPath);
4241 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
4242 llvm::sys::path::append(TempPath, OutputFileName);
4243 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
4244 }
4245
Chad Rosier62135492012-07-09 17:31:28 +00004246 // If we're saving temps and the temp file conflicts with the input file,
Chad Rosier5b58af02012-04-20 20:05:08 +00004247 // then avoid overwriting input file.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004248 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
Chad Rosier5b58af02012-04-20 20:05:08 +00004249 bool SameFile = false;
4250 SmallString<256> Result;
4251 llvm::sys::fs::current_path(Result);
4252 llvm::sys::path::append(Result, BaseName);
4253 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
4254 // Must share the same path to conflict.
4255 if (SameFile) {
4256 StringRef Name = llvm::sys::path::filename(BaseInput);
4257 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004258 std::string TmpName = GetTemporaryPath(
4259 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004260 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Chad Rosier5b58af02012-04-20 20:05:08 +00004261 }
Chad Rosierf8412cd2011-07-15 21:54:29 +00004262 }
4263
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004264 // As an annoying special case, PCH generation doesn't strip the pathname.
Nico Weber8ab92192016-03-02 23:29:29 +00004265 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
Michael J. Spencere1696752010-12-18 00:19:12 +00004266 llvm::sys::path::remove_filename(BasePath);
4267 if (BasePath.empty())
Daniel Dunbare6c83192009-03-18 09:58:30 +00004268 BasePath = NamedOutput;
4269 else
Michael J. Spencere1696752010-12-18 00:19:12 +00004270 llvm::sys::path::append(BasePath, NamedOutput);
Chad Rosier633dcdc2013-01-24 19:14:47 +00004271 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004272 } else {
Chad Rosier633dcdc2013-01-24 19:14:47 +00004273 return C.addResultFile(NamedOutput, &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004274 }
4275}
4276
Mehdi Amini12011172016-10-06 05:11:48 +00004277std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
Petr Hosek8f2499f2018-09-12 03:26:10 +00004278 // Seach for Name in a list of paths.
4279 auto SearchPaths = [&](const llvm::SmallVectorImpl<std::string> &P)
4280 -> llvm::Optional<std::string> {
4281 // Respect a limited subset of the '-Bprefix' functionality in GCC by
4282 // attempting to use this prefix when looking for file paths.
4283 for (const auto &Dir : P) {
4284 if (Dir.empty())
4285 continue;
4286 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
4287 llvm::sys::path::append(P, Name);
4288 if (llvm::sys::fs::exists(Twine(P)))
Simon Pilgrim4588fc82018-09-13 10:10:18 +00004289 return P.str().str();
Petr Hosek8f2499f2018-09-12 03:26:10 +00004290 }
4291 return None;
4292 };
4293
4294 if (auto P = SearchPaths(PrefixDirs))
4295 return *P;
Chandler Carruth84559242010-03-22 01:52:07 +00004296
Petr Hosek916a4672017-08-10 04:16:38 +00004297 SmallString<128> R(ResourceDir);
4298 llvm::sys::path::append(R, Name);
4299 if (llvm::sys::fs::exists(Twine(R)))
4300 return R.str();
4301
4302 SmallString<128> P(TC.getCompilerRTPath());
Rafael Espindola609a6642013-06-24 18:33:43 +00004303 llvm::sys::path::append(P, Name);
4304 if (llvm::sys::fs::exists(Twine(P)))
Peter Collingbournefa9771f2011-09-06 02:08:31 +00004305 return P.str();
4306
Petr Hosek8f2499f2018-09-12 03:26:10 +00004307 if (auto P = SearchPaths(TC.getLibraryPaths()))
4308 return *P;
4309
4310 if (auto P = SearchPaths(TC.getFilePaths()))
4311 return *P;
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004312
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004313 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004314}
4315
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004316void Driver::generatePrefixedToolNames(
Mehdi Amini12011172016-10-06 05:11:48 +00004317 StringRef Tool, const ToolChain &TC,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004318 SmallVectorImpl<std::string> &Names) const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004319 // FIXME: Needs a better variable than TargetTriple
4320 Names.emplace_back((TargetTriple + "-" + Tool).str());
Benjamin Kramer3204b152015-05-29 19:42:19 +00004321 Names.emplace_back(Tool);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004322
4323 // Allow the discovery of tools prefixed with LLVM's default target triple.
Petr Hosekdd38d932018-05-29 22:35:39 +00004324 std::string DefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
4325 if (DefaultTargetTriple != TargetTriple)
4326 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004327}
4328
Benjamin Kramer7111b912014-11-04 20:26:01 +00004329static bool ScanDirForExecutable(SmallString<128> &Dir,
4330 ArrayRef<std::string> Names) {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004331 for (const auto &Name : Names) {
4332 llvm::sys::path::append(Dir, Name);
4333 if (llvm::sys::fs::can_execute(Twine(Dir)))
4334 return true;
4335 llvm::sys::path::remove_filename(Dir);
4336 }
4337 return false;
4338}
4339
Mehdi Amini12011172016-10-06 05:11:48 +00004340std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004341 SmallVector<std::string, 2> TargetSpecificExecutables;
4342 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
4343
Chandler Carruth84559242010-03-22 01:52:07 +00004344 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00004345 // attempting to use this prefix when looking for program paths.
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004346 for (const auto &PrefixDir : PrefixDirs) {
4347 if (llvm::sys::fs::is_directory(PrefixDir)) {
4348 SmallString<128> P(PrefixDir);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004349 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004350 return P.str();
Simon Atanasyana47ba292012-10-31 14:39:28 +00004351 } else {
Mehdi Amini12011172016-10-06 05:11:48 +00004352 SmallString<128> P((PrefixDir + Name).str());
Rafael Espindola609a6642013-06-24 18:33:43 +00004353 if (llvm::sys::fs::can_execute(Twine(P)))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004354 return P.str();
Simon Atanasyan86bdab72012-10-31 12:01:53 +00004355 }
Chandler Carruth84559242010-03-22 01:52:07 +00004356 }
4357
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004358 const ToolChain::path_list &List = TC.getProgramPaths();
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004359 for (const auto &Path : List) {
4360 SmallString<128> P(Path);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004361 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004362 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004363 }
4364
Daniel Dunbar76ce7412009-03-23 16:15:50 +00004365 // If all else failed, search the path.
Michael J. Spencerb011d482014-11-07 21:30:32 +00004366 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
4367 if (llvm::ErrorOr<std::string> P =
4368 llvm::sys::findProgramByName(TargetSpecificExecutable))
Michael J. Spencer04162ea2014-11-04 01:30:55 +00004369 return *P;
Daniel Dunbar6f668772009-03-18 21:34:08 +00004370
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004371 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004372}
4373
Mehdi Amini12011172016-10-06 05:11:48 +00004374std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
Rafael Espindola37d229d2013-06-25 04:26:55 +00004375 SmallString<128> Path;
Rafael Espindolac0809172014-06-12 14:02:15 +00004376 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
Rafael Espindola37d229d2013-06-25 04:26:55 +00004377 if (EC) {
4378 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004379 return "";
4380 }
4381
Rafael Espindola37d229d2013-06-25 04:26:55 +00004382 return Path.str();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004383}
4384
Nico Weber2ca4be92016-03-01 23:16:44 +00004385std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
4386 SmallString<128> Output;
4387 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
4388 // FIXME: If anybody needs it, implement this obscure rule:
4389 // "If you specify a directory without a file name, the default file name
4390 // is VCx0.pch., where x is the major version of Visual C++ in use."
4391 Output = FpArg->getValue();
4392
4393 // "If you do not specify an extension as part of the path name, an
4394 // extension of .pch is assumed. "
4395 if (!llvm::sys::path::has_extension(Output))
4396 Output += ".pch";
4397 } else {
Mike Rice58df1af2018-09-11 17:10:44 +00004398 if (Arg *YcArg = C.getArgs().getLastArg(options::OPT__SLASH_Yc))
4399 Output = YcArg->getValue();
4400 if (Output.empty())
4401 Output = BaseName;
Nico Weber2ca4be92016-03-01 23:16:44 +00004402 llvm::sys::path::replace_extension(Output, ".pch");
4403 }
4404 return Output.str();
4405}
4406
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004407const ToolChain &Driver::getToolChain(const ArgList &Args,
Artem Belevich959e0542015-07-10 19:47:55 +00004408 const llvm::Triple &Target) const {
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004409
David Blaikie6ad71012017-01-13 18:53:43 +00004410 auto &TC = ToolChains[Target.str()];
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004411 if (!TC) {
4412 switch (Target.getOS()) {
Reid Kleckner330fb172016-05-11 16:19:05 +00004413 case llvm::Triple::Haiku:
David Blaikie6ad71012017-01-13 18:53:43 +00004414 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
Reid Kleckner330fb172016-05-11 16:19:05 +00004415 break;
Ed Schouten4dabea22017-06-25 08:29:09 +00004416 case llvm::Triple::Ananas:
4417 TC = llvm::make_unique<toolchains::Ananas>(*this, Target, Args);
4418 break;
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004419 case llvm::Triple::CloudABI:
David Blaikie6ad71012017-01-13 18:53:43 +00004420 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004421 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004422 case llvm::Triple::Darwin:
4423 case llvm::Triple::MacOSX:
4424 case llvm::Triple::IOS:
Tim Northover6f3ff222015-10-30 16:30:27 +00004425 case llvm::Triple::TvOS:
4426 case llvm::Triple::WatchOS:
David Blaikie6ad71012017-01-13 18:53:43 +00004427 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004428 break;
4429 case llvm::Triple::DragonFly:
David Blaikie6ad71012017-01-13 18:53:43 +00004430 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004431 break;
4432 case llvm::Triple::OpenBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004433 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004434 break;
4435 case llvm::Triple::NetBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004436 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004437 break;
4438 case llvm::Triple::FreeBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004439 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004440 break;
4441 case llvm::Triple::Minix:
David Blaikie6ad71012017-01-13 18:53:43 +00004442 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004443 break;
4444 case llvm::Triple::Linux:
Andrey Turetskiy4798eb62016-06-16 10:36:09 +00004445 case llvm::Triple::ELFIAMCU:
Chandler Carruthcf705b22012-01-25 21:03:58 +00004446 if (Target.getArch() == llvm::Triple::hexagon)
David Blaikie6ad71012017-01-13 18:53:43 +00004447 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4448 Args);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004449 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
4450 !Target.hasEnvironment())
David Blaikie6ad71012017-01-13 18:53:43 +00004451 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
4452 Args);
Chandler Carruthcf705b22012-01-25 21:03:58 +00004453 else
David Blaikie6ad71012017-01-13 18:53:43 +00004454 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004455 break;
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004456 case llvm::Triple::NaCl:
David Blaikie6ad71012017-01-13 18:53:43 +00004457 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004458 break;
Petr Hosek62e1d232016-10-06 06:08:09 +00004459 case llvm::Triple::Fuchsia:
David Blaikie6ad71012017-01-13 18:53:43 +00004460 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
Petr Hosek62e1d232016-10-06 06:08:09 +00004461 break;
David Chisnallf571cde2012-02-15 13:39:01 +00004462 case llvm::Triple::Solaris:
David Blaikie6ad71012017-01-13 18:53:43 +00004463 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
David Chisnallf571cde2012-02-15 13:39:01 +00004464 break;
Tom Stellard8fa33092015-07-18 01:49:05 +00004465 case llvm::Triple::AMDHSA:
David Blaikie6ad71012017-01-13 18:53:43 +00004466 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
Tom Stellard8fa33092015-07-18 01:49:05 +00004467 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004468 case llvm::Triple::Win32:
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004469 switch (Target.getEnvironment()) {
4470 default:
4471 if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004472 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004473 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004474 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004475 else
David Blaikie6ad71012017-01-13 18:53:43 +00004476 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004477 break;
4478 case llvm::Triple::GNU:
David Blaikie6ad71012017-01-13 18:53:43 +00004479 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004480 break;
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004481 case llvm::Triple::Itanium:
David Blaikie6ad71012017-01-13 18:53:43 +00004482 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
4483 Args);
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004484 break;
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004485 case llvm::Triple::MSVC:
4486 case llvm::Triple::UnknownEnvironment:
Dave Leef96bedf2017-11-06 21:18:05 +00004487 if (Args.getLastArgValue(options::OPT_fuse_ld_EQ)
4488 .startswith_lower("bfd"))
4489 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(
4490 *this, Target, Args);
4491 else
4492 TC =
4493 llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004494 break;
4495 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004496 break;
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004497 case llvm::Triple::PS4:
David Blaikie6ad71012017-01-13 18:53:43 +00004498 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004499 break;
David L Kreitzerd397ea42016-10-14 20:44:33 +00004500 case llvm::Triple::Contiki:
David Blaikie6ad71012017-01-13 18:53:43 +00004501 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
David L Kreitzerd397ea42016-10-14 20:44:33 +00004502 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004503 default:
Douglas Katzman9f5e70e2015-05-26 18:01:33 +00004504 // Of these targets, Hexagon is the only one that might have
4505 // an OS of Linux, in which case it got handled above already.
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004506 switch (Target.getArch()) {
4507 case llvm::Triple::tce:
David Blaikie6ad71012017-01-13 18:53:43 +00004508 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004509 break;
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004510 case llvm::Triple::tcele:
David Blaikie6ad71012017-01-13 18:53:43 +00004511 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004512 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004513 case llvm::Triple::hexagon:
David Blaikie6ad71012017-01-13 18:53:43 +00004514 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4515 Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004516 break;
Jacques Pienaard964cc22016-03-28 21:02:54 +00004517 case llvm::Triple::lanai:
David Blaikie6ad71012017-01-13 18:53:43 +00004518 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
Jacques Pienaard964cc22016-03-28 21:02:54 +00004519 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004520 case llvm::Triple::xcore:
David Blaikie6ad71012017-01-13 18:53:43 +00004521 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004522 break;
Dan Gohmanc2853072015-09-03 22:51:53 +00004523 case llvm::Triple::wasm32:
4524 case llvm::Triple::wasm64:
David Blaikie6ad71012017-01-13 18:53:43 +00004525 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
Dan Gohmanc2853072015-09-03 22:51:53 +00004526 break;
Dylan McKay924fa3a2017-01-05 05:20:27 +00004527 case llvm::Triple::avr:
David Blaikie6ad71012017-01-13 18:53:43 +00004528 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
Dylan McKay924fa3a2017-01-05 05:20:27 +00004529 break;
David Bolvanskyf4be2532018-07-31 14:21:46 +00004530 case llvm::Triple::riscv32:
4531 case llvm::Triple::riscv64:
4532 TC = llvm::make_unique<toolchains::RISCVToolChain>(*this, Target, Args);
4533 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004534 default:
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004535 if (Target.getVendor() == llvm::Triple::Myriad)
David Blaikie6ad71012017-01-13 18:53:43 +00004536 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
4537 Args);
Jonathan Roelofs901c7762017-05-25 15:42:13 +00004538 else if (toolchains::BareMetal::handlesTarget(Target))
4539 TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004540 else if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004541 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004542 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004543 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004544 else
David Blaikie6ad71012017-01-13 18:53:43 +00004545 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004546 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004547 }
4548 }
Justin Lebar66c4fd72016-11-18 00:41:22 +00004549
4550 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
4551 // compiles always need two toolchains, the CUDA toolchain and the host
4552 // toolchain. So the only valid way to create a CUDA toolchain is via
4553 // CreateOffloadingDeviceToolChains.
4554
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004555 return *TC;
Daniel Dunbar4dff6a42009-03-10 23:41:59 +00004556}
Daniel Dunbar8fa879d2009-03-24 18:57:02 +00004557
Rafael Espindola2f69d402013-03-18 15:33:26 +00004558bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
Douglas Katzman00249092015-06-12 15:45:21 +00004559 // Say "no" if there is not exactly one input of a type clang understands.
Nico Weber5a459f82016-02-23 19:30:43 +00004560 if (JA.size() != 1 ||
4561 !types::isAcceptedByClang((*JA.input_begin())->getType()))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004562 return false;
4563
Douglas Katzman00249092015-06-12 15:45:21 +00004564 // And say "no" if this is not a kind of action clang understands.
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004565 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
Bob Wilson23a55f12014-12-21 07:00:00 +00004566 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004567 return false;
4568
4569 return true;
4570}
4571
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004572/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
4573/// grouped values as integers. Numbers which are not provided are set to 0.
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004574///
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004575/// \return True if the entire string was parsed (9.2), or all groups were
4576/// parsed (10.3.5extrastuff).
Mehdi Amini12011172016-10-06 05:11:48 +00004577bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
4578 unsigned &Micro, bool &HadExtra) {
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004579 HadExtra = false;
4580
4581 Major = Minor = Micro = 0;
Mehdi Amini12011172016-10-06 05:11:48 +00004582 if (Str.empty())
Bob Wilson433cb312015-04-07 01:03:35 +00004583 return false;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004584
Mehdi Amini12011172016-10-06 05:11:48 +00004585 if (Str.consumeInteger(10, Major))
4586 return false;
4587 if (Str.empty())
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004588 return true;
Mehdi Amini12011172016-10-06 05:11:48 +00004589 if (Str[0] != '.')
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004590 return false;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004591
Mehdi Amini12011172016-10-06 05:11:48 +00004592 Str = Str.drop_front(1);
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004593
Mehdi Amini12011172016-10-06 05:11:48 +00004594 if (Str.consumeInteger(10, Minor))
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004595 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004596 if (Str.empty())
4597 return true;
4598 if (Str[0] != '.')
4599 return false;
4600 Str = Str.drop_front(1);
4601
4602 if (Str.consumeInteger(10, Micro))
4603 return false;
4604 if (!Str.empty())
4605 HadExtra = true;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004606 return true;
4607}
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004608
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004609/// Parse digits from a string \p Str and fulfill \p Digits with
4610/// the parsed numbers. This method assumes that the max number of
4611/// digits to look for is equal to Digits.size().
4612///
4613/// \return True if the entire string was parsed and there are
4614/// no extra characters remaining at the end.
Mehdi Amini12011172016-10-06 05:11:48 +00004615bool Driver::GetReleaseVersion(StringRef Str,
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004616 MutableArrayRef<unsigned> Digits) {
Mehdi Amini12011172016-10-06 05:11:48 +00004617 if (Str.empty())
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004618 return false;
4619
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004620 unsigned CurDigit = 0;
4621 while (CurDigit < Digits.size()) {
Mehdi Amini12011172016-10-06 05:11:48 +00004622 unsigned Digit;
4623 if (Str.consumeInteger(10, Digit))
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004624 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004625 Digits[CurDigit] = Digit;
4626 if (Str.empty())
4627 return true;
4628 if (Str[0] != '.')
4629 return false;
4630 Str = Str.drop_front(1);
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004631 CurDigit++;
4632 }
4633
4634 // More digits than requested, bail out...
4635 return false;
4636}
4637
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004638std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
4639 unsigned IncludedFlagsBitmask = 0;
Rafael Espindolacc707bc2013-09-25 15:54:41 +00004640 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004641
4642 if (Mode == CLMode) {
Hans Wennborg19076102013-07-31 20:51:53 +00004643 // Include CL and Core options.
4644 IncludedFlagsBitmask |= options::CLOption;
4645 IncludedFlagsBitmask |= options::CoreOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004646 } else {
4647 ExcludedFlagsBitmask |= options::CLOption;
4648 }
4649
4650 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
4651}
Benjamin Kramerab88f622014-03-25 18:02:07 +00004652
Douglas Katzmanf08fadf2015-06-04 14:40:44 +00004653bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
Benjamin Kramerab88f622014-03-25 18:02:07 +00004654 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
4655}