blob: e84c7558e7486b2314a681d6c9f3b1af262cf993 [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"
David Bolvanskyf4be2532018-07-31 14:21:46 +000040#include "ToolChains/RISCV.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
Artem Belevich959e0542015-07-10 19:47:55 +0000484 return Target;
485}
486
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000487// Parse the LTO options and record the type of LTO compilation
Teresa Johnson945bc502015-10-15 20:35:53 +0000488// based on which -f(no-)?lto(=.*)? option occurs last.
489void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
490 LTOMode = LTOK_None;
491 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
492 options::OPT_fno_lto, false))
493 return;
494
495 StringRef LTOName("full");
496
497 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
Teresa Johnson6ef80dc2015-11-02 18:03:12 +0000498 if (A)
499 LTOName = A->getValue();
Teresa Johnson945bc502015-10-15 20:35:53 +0000500
501 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
502 .Case("full", LTOK_Full)
503 .Case("thin", LTOK_Thin)
504 .Default(LTOK_Unknown);
505
506 if (LTOMode == LTOK_Unknown) {
507 assert(A);
508 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
509 << A->getValue();
510 }
511}
512
Samuel Antao39f9da22016-10-27 16:38:05 +0000513/// Compute the desired OpenMP runtime from the flags provided.
514Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
515 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
516
517 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
518 if (A)
519 RuntimeName = A->getValue();
520
521 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
522 .Case("libomp", OMPRT_OMP)
523 .Case("libgomp", OMPRT_GOMP)
524 .Case("libiomp5", OMPRT_IOMP5)
525 .Default(OMPRT_Unknown);
526
527 if (RT == OMPRT_Unknown) {
528 if (A)
529 Diag(diag::err_drv_unsupported_option_argument)
530 << A->getOption().getName() << A->getValue();
531 else
532 // FIXME: We could use a nicer diagnostic here.
533 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
534 }
535
536 return RT;
537}
538
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000539void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
540 InputList &Inputs) {
541
542 //
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000543 // CUDA/HIP
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000544 //
Yaxun Liuf6144222018-05-30 00:53:50 +0000545 // We need to generate a CUDA/HIP toolchain if any of the inputs has a CUDA
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000546 // or HIP type. However, mixed CUDA/HIP compilation is not supported.
547 bool IsCuda =
548 llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000549 return types::isCuda(I.first);
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000550 });
551 bool IsHIP =
552 llvm::any_of(Inputs,
553 [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
554 return types::isHIP(I.first);
555 }) ||
556 C.getInputArgs().hasArg(options::OPT_hip_link);
557 if (IsCuda && IsHIP) {
558 Diag(clang::diag::err_drv_mix_cuda_hip);
559 return;
560 }
Yaxun Liuf6144222018-05-30 00:53:50 +0000561 if (IsCuda) {
Justin Lebar66c4fd72016-11-18 00:41:22 +0000562 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
563 const llvm::Triple &HostTriple = HostTC->getTriple();
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000564 StringRef DeviceTripleStr;
Yaxun Liuf6144222018-05-30 00:53:50 +0000565 auto OFK = Action::OFK_Cuda;
566 DeviceTripleStr =
567 HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda" : "nvptx-nvidia-cuda";
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000568 llvm::Triple CudaTriple(DeviceTripleStr);
Yaxun Liuf6144222018-05-30 00:53:50 +0000569 // Use the CUDA and host triples as the key into the ToolChains map,
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000570 // because the device toolchain we create depends on both.
David Blaikie6ad71012017-01-13 18:53:43 +0000571 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
Justin Lebar66c4fd72016-11-18 00:41:22 +0000572 if (!CudaTC) {
David Blaikie6ad71012017-01-13 18:53:43 +0000573 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000574 *this, CudaTriple, *HostTC, C.getInputArgs(), OFK);
Justin Lebar66c4fd72016-11-18 00:41:22 +0000575 }
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000576 C.addOffloadDeviceToolChain(CudaTC.get(), OFK);
Yaxun Liuf6144222018-05-30 00:53:50 +0000577 } else if (IsHIP) {
578 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
579 const llvm::Triple &HostTriple = HostTC->getTriple();
580 StringRef DeviceTripleStr;
581 auto OFK = Action::OFK_HIP;
582 DeviceTripleStr = "amdgcn-amd-amdhsa";
583 llvm::Triple HIPTriple(DeviceTripleStr);
584 // Use the HIP and host triples as the key into the ToolChains map,
585 // because the device toolchain we create depends on both.
586 auto &HIPTC = ToolChains[HIPTriple.str() + "/" + HostTriple.str()];
587 if (!HIPTC) {
588 HIPTC = llvm::make_unique<toolchains::HIPToolChain>(
589 *this, HIPTriple, *HostTC, C.getInputArgs());
590 }
591 C.addOffloadDeviceToolChain(HIPTC.get(), OFK);
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000592 }
593
594 //
Samuel Antao39f9da22016-10-27 16:38:05 +0000595 // OpenMP
596 //
597 // We need to generate an OpenMP toolchain if the user specified targets with
598 // the -fopenmp-targets option.
599 if (Arg *OpenMPTargets =
600 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
601 if (OpenMPTargets->getNumValues()) {
602 // We expect that -fopenmp-targets is always used in conjunction with the
603 // option -fopenmp specifying a valid runtime with offloading support,
604 // i.e. libomp or libiomp.
605 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
606 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
607 options::OPT_fno_openmp, false);
608 if (HasValidOpenMPRuntime) {
609 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
610 HasValidOpenMPRuntime =
611 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
612 }
613
614 if (HasValidOpenMPRuntime) {
615 llvm::StringMap<const char *> FoundNormalizedTriples;
616 for (const char *Val : OpenMPTargets->getValues()) {
617 llvm::Triple TT(Val);
618 std::string NormalizedName = TT.normalize();
619
620 // Make sure we don't have a duplicate triple.
621 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
622 if (Duplicate != FoundNormalizedTriples.end()) {
623 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
624 << Val << Duplicate->second;
625 continue;
626 }
627
628 // Store the current triple so that we can check for duplicates in the
629 // following iterations.
630 FoundNormalizedTriples[NormalizedName] = Val;
631
632 // If the specified target is invalid, emit a diagnostic.
633 if (TT.getArch() == llvm::Triple::UnknownArch)
634 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
635 else {
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000636 const ToolChain *TC;
637 // CUDA toolchains have to be selected differently. They pair host
638 // and device in their implementation.
639 if (TT.isNVPTX()) {
640 const ToolChain *HostTC =
641 C.getSingleOffloadToolChain<Action::OFK_Host>();
642 assert(HostTC && "Host toolchain should be always defined.");
643 auto &CudaTC =
Gheorghe-Teodor Bercea52898432017-08-09 01:02:19 +0000644 ToolChains[TT.str() + "/" + HostTC->getTriple().normalize()];
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000645 if (!CudaTC)
646 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Gheorghe-Teodor Bercea2c926932017-08-08 14:33:05 +0000647 *this, TT, *HostTC, C.getInputArgs(), Action::OFK_OpenMP);
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000648 TC = CudaTC.get();
649 } else
650 TC = &getToolChain(C.getInputArgs(), TT);
651 C.addOffloadDeviceToolChain(TC, Action::OFK_OpenMP);
Samuel Antao39f9da22016-10-27 16:38:05 +0000652 }
653 }
654 } else
655 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
656 } else
657 Diag(clang::diag::warn_drv_empty_joined_argument)
658 << OpenMPTargets->getAsString(C.getInputArgs());
659 }
660
661 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000662 // TODO: Add support for other offloading programming models here.
663 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000664}
665
Serge Pavlov208ac652018-01-01 13:27:01 +0000666/// Looks the given directories for the specified file.
667///
668/// \param[out] FilePath File path, if the file was found.
669/// \param[in] Dirs Directories used for the search.
670/// \param[in] FileName Name of the file to search for.
671/// \return True if file was found.
672///
673/// Looks for file specified by FileName sequentially in directories specified
674/// by Dirs.
675///
676static bool searchForFile(SmallVectorImpl<char> &FilePath,
677 ArrayRef<std::string> Dirs,
678 StringRef FileName) {
679 SmallString<128> WPath;
680 for (const StringRef &Dir : Dirs) {
681 if (Dir.empty())
682 continue;
683 WPath.clear();
684 llvm::sys::path::append(WPath, Dir, FileName);
685 llvm::sys::path::native(WPath);
686 if (llvm::sys::fs::is_regular_file(WPath)) {
687 FilePath = std::move(WPath);
688 return true;
689 }
690 }
691 return false;
692}
693
694bool Driver::readConfigFile(StringRef FileName) {
695 // Try reading the given file.
696 SmallVector<const char *, 32> NewCfgArgs;
697 if (!llvm::cl::readConfigFile(FileName, Saver, NewCfgArgs)) {
698 Diag(diag::err_drv_cannot_read_config_file) << FileName;
699 return true;
700 }
701
702 // Read options from config file.
703 llvm::SmallString<128> CfgFileName(FileName);
704 llvm::sys::path::native(CfgFileName);
705 ConfigFile = CfgFileName.str();
706 bool ContainErrors;
707 CfgOptions = llvm::make_unique<InputArgList>(
708 ParseArgStrings(NewCfgArgs, ContainErrors));
709 if (ContainErrors) {
710 CfgOptions.reset();
711 return true;
712 }
713
714 if (CfgOptions->hasArg(options::OPT_config)) {
715 CfgOptions.reset();
716 Diag(diag::err_drv_nested_config_file);
717 return true;
718 }
719
720 // Claim all arguments that come from a configuration file so that the driver
721 // does not warn on any that is unused.
722 for (Arg *A : *CfgOptions)
723 A->claim();
724 return false;
725}
726
727bool Driver::loadConfigFile() {
728 std::string CfgFileName;
729 bool FileSpecifiedExplicitly = false;
730
731 // Process options that change search path for config files.
732 if (CLOptions) {
733 if (CLOptions->hasArg(options::OPT_config_system_dir_EQ)) {
734 SmallString<128> CfgDir;
735 CfgDir.append(
736 CLOptions->getLastArgValue(options::OPT_config_system_dir_EQ));
737 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000738 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000739 SystemConfigDir.clear();
740 else
741 SystemConfigDir = std::string(CfgDir.begin(), CfgDir.end());
742 }
743 }
744 if (CLOptions->hasArg(options::OPT_config_user_dir_EQ)) {
745 SmallString<128> CfgDir;
746 CfgDir.append(
747 CLOptions->getLastArgValue(options::OPT_config_user_dir_EQ));
748 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000749 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000750 UserConfigDir.clear();
751 else
752 UserConfigDir = std::string(CfgDir.begin(), CfgDir.end());
753 }
754 }
755 }
756
757 // First try to find config file specified in command line.
758 if (CLOptions) {
759 std::vector<std::string> ConfigFiles =
760 CLOptions->getAllArgValues(options::OPT_config);
761 if (ConfigFiles.size() > 1) {
762 Diag(diag::err_drv_duplicate_config);
763 return true;
764 }
765
766 if (!ConfigFiles.empty()) {
767 CfgFileName = ConfigFiles.front();
768 assert(!CfgFileName.empty());
769
770 // If argument contains directory separator, treat it as a path to
771 // configuration file.
772 if (llvm::sys::path::has_parent_path(CfgFileName)) {
773 SmallString<128> CfgFilePath;
774 if (llvm::sys::path::is_relative(CfgFileName))
775 llvm::sys::fs::current_path(CfgFilePath);
776 llvm::sys::path::append(CfgFilePath, CfgFileName);
777 if (!llvm::sys::fs::is_regular_file(CfgFilePath)) {
778 Diag(diag::err_drv_config_file_not_exist) << CfgFilePath;
779 return true;
780 }
781 return readConfigFile(CfgFilePath);
782 }
783
784 FileSpecifiedExplicitly = true;
785 }
786 }
787
788 // If config file is not specified explicitly, try to deduce configuration
789 // from executable name. For instance, an executable 'armv7l-clang' will
790 // search for config file 'armv7l-clang.cfg'.
791 if (CfgFileName.empty() && !ClangNameParts.TargetPrefix.empty())
792 CfgFileName = ClangNameParts.TargetPrefix + '-' + ClangNameParts.ModeSuffix;
793
794 if (CfgFileName.empty())
795 return false;
796
797 // Determine architecture part of the file name, if it is present.
798 StringRef CfgFileArch = CfgFileName;
799 size_t ArchPrefixLen = CfgFileArch.find('-');
800 if (ArchPrefixLen == StringRef::npos)
801 ArchPrefixLen = CfgFileArch.size();
802 llvm::Triple CfgTriple;
803 CfgFileArch = CfgFileArch.take_front(ArchPrefixLen);
804 CfgTriple = llvm::Triple(llvm::Triple::normalize(CfgFileArch));
805 if (CfgTriple.getArch() == llvm::Triple::ArchType::UnknownArch)
806 ArchPrefixLen = 0;
807
808 if (!StringRef(CfgFileName).endswith(".cfg"))
809 CfgFileName += ".cfg";
810
811 // If config file starts with architecture name and command line options
812 // redefine architecture (with options like -m32 -LE etc), try finding new
813 // config file with that architecture.
814 SmallString<128> FixedConfigFile;
815 size_t FixedArchPrefixLen = 0;
816 if (ArchPrefixLen) {
817 // Get architecture name from config file name like 'i386.cfg' or
818 // 'armv7l-clang.cfg'.
819 // Check if command line options changes effective triple.
820 llvm::Triple EffectiveTriple = computeTargetTriple(*this,
821 CfgTriple.getTriple(), *CLOptions);
822 if (CfgTriple.getArch() != EffectiveTriple.getArch()) {
823 FixedConfigFile = EffectiveTriple.getArchName();
824 FixedArchPrefixLen = FixedConfigFile.size();
825 // Append the rest of original file name so that file name transforms
826 // like: i386-clang.cfg -> x86_64-clang.cfg.
827 if (ArchPrefixLen < CfgFileName.size())
828 FixedConfigFile += CfgFileName.substr(ArchPrefixLen);
829 }
830 }
831
832 // Prepare list of directories where config file is searched for.
833 SmallVector<std::string, 3> CfgFileSearchDirs;
834 CfgFileSearchDirs.push_back(UserConfigDir);
835 CfgFileSearchDirs.push_back(SystemConfigDir);
836 CfgFileSearchDirs.push_back(Dir);
837
838 // Try to find config file. First try file with corrected architecture.
839 llvm::SmallString<128> CfgFilePath;
840 if (!FixedConfigFile.empty()) {
841 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
842 return readConfigFile(CfgFilePath);
843 // If 'x86_64-clang.cfg' was not found, try 'x86_64.cfg'.
844 FixedConfigFile.resize(FixedArchPrefixLen);
845 FixedConfigFile.append(".cfg");
846 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
847 return readConfigFile(CfgFilePath);
848 }
849
850 // Then try original file name.
851 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
852 return readConfigFile(CfgFilePath);
853
854 // Finally try removing driver mode part: 'x86_64-clang.cfg' -> 'x86_64.cfg'.
855 if (!ClangNameParts.ModeSuffix.empty() &&
856 !ClangNameParts.TargetPrefix.empty()) {
857 CfgFileName.assign(ClangNameParts.TargetPrefix);
858 CfgFileName.append(".cfg");
859 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
860 return readConfigFile(CfgFilePath);
861 }
862
863 // Report error but only if config file was specified explicitly, by option
864 // --config. If it was deduced from executable name, it is not an error.
865 if (FileSpecifiedExplicitly) {
866 Diag(diag::err_drv_config_file_not_found) << CfgFileName;
867 for (const std::string &SearchDir : CfgFileSearchDirs)
868 if (!SearchDir.empty())
869 Diag(diag::note_drv_config_file_searched_in) << SearchDir;
870 return true;
871 }
872
873 return false;
874}
875
Chris Lattner54b16772011-07-23 17:14:25 +0000876Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000877 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
878
Eric Christopherf901e852011-08-17 22:59:59 +0000879 // FIXME: Handle environment options which affect driver behavior, somewhere
Bill Wendlingadbeb9f2012-03-12 21:24:57 +0000880 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
Chad Rosier82301162011-09-14 00:47:55 +0000881
David Majnemer85c25b42016-07-24 17:44:03 +0000882 if (Optional<std::string> CompilerPathValue =
883 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
884 StringRef CompilerPath = *CompilerPathValue;
Chad Rosier82301162011-09-14 00:47:55 +0000885 while (!CompilerPath.empty()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000886 std::pair<StringRef, StringRef> Split =
887 CompilerPath.split(llvm::sys::EnvPathSeparator);
Chad Rosier82301162011-09-14 00:47:55 +0000888 PrefixDirs.push_back(Split.first);
889 CompilerPath = Split.second;
890 }
891 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000892
Hans Wennborg70850d82013-07-18 20:29:38 +0000893 // We look for the driver mode option early, because the mode can affect
894 // how other options are parsed.
Zachary Turneraff19c32016-08-12 17:47:52 +0000895 ParseDriverMode(ClangExecutable, ArgList.slice(1));
Hans Wennborg70850d82013-07-18 20:29:38 +0000896
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000897 // FIXME: What are we going to do with -V and -b?
898
Serge Pavlov208ac652018-01-01 13:27:01 +0000899 // Arguments specified in command line.
900 bool ContainsError;
901 CLOptions = llvm::make_unique<InputArgList>(
902 ParseArgStrings(ArgList.slice(1), ContainsError));
903
904 // Try parsing configuration file.
905 if (!ContainsError)
906 ContainsError = loadConfigFile();
907 bool HasConfigFile = !ContainsError && (CfgOptions.get() != nullptr);
908
909 // All arguments, from both config file and command line.
910 InputArgList Args = std::move(HasConfigFile ? std::move(*CfgOptions)
911 : std::move(*CLOptions));
912 if (HasConfigFile)
913 for (auto *Opt : *CLOptions) {
Serge Pavlovf015a562018-04-26 06:28:47 +0000914 if (Opt->getOption().matches(options::OPT_config))
915 continue;
916 unsigned Index = Args.MakeIndex(Opt->getSpelling());
Serge Pavlov208ac652018-01-01 13:27:01 +0000917 const Arg *BaseArg = &Opt->getBaseArg();
918 if (BaseArg == Opt)
919 BaseArg = nullptr;
920 Arg *Copy = new llvm::opt::Arg(Opt->getOption(), Opt->getSpelling(),
Serge Pavlovf015a562018-04-26 06:28:47 +0000921 Index, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000922 Copy->getValues() = Opt->getValues();
923 if (Opt->isClaimed())
924 Copy->claim();
925 Args.append(Copy);
926 }
927
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000928 // FIXME: This stuff needs to go into the Compilation, not the driver.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000929 bool CCCPrintPhases;
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000930
Filipe Cabecinhas136f35e2015-07-18 06:35:24 +0000931 // Silence driver warnings if requested
932 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
933
Rafael Espindola59ae7992009-12-07 18:28:29 +0000934 // -no-canonical-prefixes is used very early in main.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000935 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
Rafael Espindola59ae7992009-12-07 18:28:29 +0000936
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000937 // Ignore -pipe.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000938 Args.ClaimAllArgs(options::OPT_pipe);
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000939
Daniel Dunbaracd69572009-12-04 21:55:23 +0000940 // Extract -ccc args.
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000941 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000942 // FIXME: We need to figure out where this behavior should live. Most of it
943 // should be outside in the client; the parts that aren't should have proper
944 // options, either by introducing new ones or by overloading gcc ones like -V
945 // or -b.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000946 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
David Blaikie69a1d8c2015-06-22 22:07:27 +0000947 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
948 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
Richard Smithbd55daf2012-11-01 04:30:05 +0000949 CCCGenericGCCName = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000950 CCCUsePCH =
951 Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
Bruno Cardoso Lopes52dfe712017-04-12 21:46:20 +0000952 GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
953 options::OPT_fno_crash_diagnostics,
954 !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
Petr Hosekdd38d932018-05-29 22:35:39 +0000955 // FIXME: TargetTriple is used by the target-prefixed calls to as/ld
Joerg Sonnenberger17d75512012-02-22 19:15:16 +0000956 // and getToolChain is const.
Hans Wennborg2e274592013-08-13 23:38:57 +0000957 if (IsCLMode()) {
Hans Wennborg73609a02014-03-28 01:19:04 +0000958 // clang-cl targets MSVC-style Win32.
Petr Hosekdd38d932018-05-29 22:35:39 +0000959 llvm::Triple T(TargetTriple);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +0000960 T.setOS(llvm::Triple::Win32);
Hans Wennborg0f0e8d62015-09-18 17:11:50 +0000961 T.setVendor(llvm::Triple::PC);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +0000962 T.setEnvironment(llvm::Triple::MSVC);
Oleg Ranevskyy80523182017-08-31 20:31:30 +0000963 T.setObjectFormat(llvm::Triple::COFF);
Petr Hosekdd38d932018-05-29 22:35:39 +0000964 TargetTriple = T.str();
Hans Wennborg2e274592013-08-13 23:38:57 +0000965 }
David Blaikie69a1d8c2015-06-22 22:07:27 +0000966 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +0000967 TargetTriple = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000968 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
Richard Smithbd55daf2012-11-01 04:30:05 +0000969 Dir = InstalledDir = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000970 for (const Arg *A : Args.filtered(options::OPT_B)) {
Benjamin Kramer1a648d12011-02-08 20:31:42 +0000971 A->claim();
Richard Smithbd55daf2012-11-01 04:30:05 +0000972 PrefixDirs.push_back(A->getValue(0));
Benjamin Kramer1a648d12011-02-08 20:31:42 +0000973 }
David Blaikie69a1d8c2015-06-22 22:07:27 +0000974 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
Richard Smithbd55daf2012-11-01 04:30:05 +0000975 SysRoot = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000976 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
Peter Collingbourne9d9e1fc2013-05-27 21:40:20 +0000977 DyldPrefix = A->getValue();
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000978
David Blaikie69a1d8c2015-06-22 22:07:27 +0000979 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
Bob Wilsona20a1da2013-03-23 05:17:59 +0000980 ResourceDir = A->getValue();
Jim Grosbach061dabf2013-03-12 20:17:58 +0000981
David Blaikie69a1d8c2015-06-22 22:07:27 +0000982 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +0000983 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
984 .Case("cwd", SaveTempsCwd)
985 .Case("obj", SaveTempsObj)
986 .Default(SaveTempsCwd);
987 }
988
Steven Wu1257cd82016-05-18 17:04:52 +0000989 setLTOMode(Args);
990
Steven Wu844ab6a2016-11-16 06:06:44 +0000991 // Process -fembed-bitcode= flags.
992 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
993 StringRef Name = A->getValue();
994 unsigned Model = llvm::StringSwitch<unsigned>(Name)
995 .Case("off", EmbedNone)
996 .Case("all", EmbedBitcode)
997 .Case("bitcode", EmbedBitcode)
998 .Case("marker", EmbedMarker)
999 .Default(~0U);
1000 if (Model == ~0U) {
1001 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
1002 << Name;
1003 } else
1004 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
Steven Wu574b0f22016-03-01 01:07:58 +00001005 }
1006
David Blaikie69a1d8c2015-06-22 22:07:27 +00001007 std::unique_ptr<llvm::opt::InputArgList> UArgs =
1008 llvm::make_unique<InputArgList>(std::move(Args));
1009
Daniel Dunbar775d4062010-06-11 22:00:26 +00001010 // Perform the default argument translations.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001011 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
Daniel Dunbar775d4062010-06-11 22:00:26 +00001012
Chandler Carruthcb916192012-01-25 08:49:21 +00001013 // Owned by the host.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00001014 const ToolChain &TC = getToolChain(
Petr Hosekdd38d932018-05-29 22:35:39 +00001015 *UArgs, computeTargetTriple(*this, TargetTriple, *UArgs));
Chandler Carruthcb916192012-01-25 08:49:21 +00001016
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00001017 // The compilation takes ownership of Args.
Benjamin Kramer43c0f482017-06-30 13:21:27 +00001018 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs,
1019 ContainsError);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001020
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001021 if (!HandleImmediateArgs(*C))
1022 return C;
1023
Chad Rosierecdede82011-08-12 22:08:57 +00001024 // Construct the list of inputs.
1025 InputList Inputs;
Hans Wennborged1d0722013-08-13 21:32:29 +00001026 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
Chad Rosierecdede82011-08-12 22:08:57 +00001027
Samuel Antaoc1ffba52016-06-13 18:10:57 +00001028 // Populate the tool chains for the offloading devices, if any.
1029 CreateOffloadingDeviceToolChains(*C, Inputs);
Justin Lebar0e450a52016-03-30 23:30:25 +00001030
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001031 // Construct the list of abstract actions to perform for this compilation. On
Tim Northover157d9112014-01-16 08:48:16 +00001032 // MachO targets this uses the driver-driver and universal actions.
1033 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001034 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001035 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001036 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001037
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001038 if (CCCPrintPhases) {
Daniel Dunbareb843be2009-03-18 03:13:20 +00001039 PrintActions(*C);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001040 return C;
1041 }
1042
1043 BuildJobs(*C);
Daniel Dunbaradc91e62009-03-15 01:38:15 +00001044
1045 return C;
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001046}
1047
Justin Bognered9cbe02015-07-09 06:58:31 +00001048static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
1049 llvm::opt::ArgStringList ASL;
1050 for (const auto *A : Args)
1051 A->render(Args, ASL);
1052
1053 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
1054 if (I != ASL.begin())
1055 OS << ' ';
1056 Command::printArg(OS, *I, true);
1057 }
1058 OS << '\n';
1059}
1060
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001061bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
1062 SmallString<128> &CrashDiagDir) {
1063 using namespace llvm::sys;
1064 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
1065 "Only knows about .crash files on Darwin");
1066
1067 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
1068 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
1069 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
1070 path::home_directory(CrashDiagDir);
1071 if (CrashDiagDir.startswith("/var/root"))
1072 CrashDiagDir = "/";
1073 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
1074 int PID =
1075#if LLVM_ON_UNIX
1076 getpid();
1077#else
1078 0;
1079#endif
1080 std::error_code EC;
1081 fs::file_status FileStatus;
1082 TimePoint<> LastAccessTime;
1083 SmallString<128> CrashFilePath;
1084 // Lookup the .crash files and get the one generated by a subprocess spawned
1085 // by this driver invocation.
1086 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
1087 File != FileEnd && !EC; File.increment(EC)) {
1088 StringRef FileName = path::filename(File->path());
1089 if (!FileName.startswith(Name))
1090 continue;
1091 if (fs::status(File->path(), FileStatus))
1092 continue;
1093 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
1094 llvm::MemoryBuffer::getFile(File->path());
1095 if (!CrashFile)
1096 continue;
1097 // The first line should start with "Process:", otherwise this isn't a real
1098 // .crash file.
1099 StringRef Data = CrashFile.get()->getBuffer();
1100 if (!Data.startswith("Process:"))
1101 continue;
1102 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
1103 size_t ParentProcPos = Data.find("Parent Process:");
1104 if (ParentProcPos == StringRef::npos)
1105 continue;
1106 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
1107 if (LineEnd == StringRef::npos)
1108 continue;
1109 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
1110 int OpenBracket = -1, CloseBracket = -1;
1111 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
1112 if (ParentProcess[i] == '[')
1113 OpenBracket = i;
1114 if (ParentProcess[i] == ']')
1115 CloseBracket = i;
1116 }
1117 // Extract the parent process PID from the .crash file and check whether
1118 // it matches this driver invocation pid.
1119 int CrashPID;
1120 if (OpenBracket < 0 || CloseBracket < 0 ||
1121 ParentProcess.slice(OpenBracket + 1, CloseBracket)
1122 .getAsInteger(10, CrashPID) || CrashPID != PID) {
1123 continue;
1124 }
1125
1126 // Found a .crash file matching the driver pid. To avoid getting an older
1127 // and misleading crash file, continue looking for the most recent.
1128 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
1129 // multiple crashes poiting to the same parent process. Since the driver
1130 // does not collect pid information for the dispatched invocation there's
1131 // currently no way to distinguish among them.
1132 const auto FileAccessTime = FileStatus.getLastModificationTime();
1133 if (FileAccessTime > LastAccessTime) {
1134 CrashFilePath.assign(File->path());
1135 LastAccessTime = FileAccessTime;
1136 }
1137 }
1138
1139 // If found, copy it over to the location of other reproducer files.
1140 if (!CrashFilePath.empty()) {
1141 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
1142 if (EC)
1143 return false;
1144 return true;
1145 }
1146
1147 return false;
1148}
1149
Eric Christopherf901e852011-08-17 22:59:59 +00001150// When clang crashes, produce diagnostic information including the fully
1151// preprocessed source file(s). Request that the developer attach the
Chad Rosierbe10f982011-08-02 17:58:04 +00001152// diagnostic information to a bug report.
Alex Lorenz045c5142018-04-07 00:03:27 +00001153void Driver::generateCompilationDiagnostics(
1154 Compilation &C, const Command &FailingCommand,
1155 StringRef AdditionalInformation, CompilationDiagnosticReport *Report) {
Chad Rosier877c0a22012-02-22 00:30:39 +00001156 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
Chad Rosier62135492012-07-09 17:31:28 +00001157 return;
Chad Rosierbee5a1d2012-03-07 00:30:40 +00001158
Chad Rosierdbf46a12013-02-01 18:30:26 +00001159 // Don't try to generate diagnostics for link or dsymutil jobs.
Justin Bognere1a33d12014-10-20 21:02:05 +00001160 if (FailingCommand.getCreator().isLinkJob() ||
1161 FailingCommand.getCreator().isDsymutilJob())
Chad Rosier877c0a22012-02-22 00:30:39 +00001162 return;
1163
Chad Rosier8179f112012-06-19 17:51:34 +00001164 // Print the version of the compiler.
1165 PrintVersion(C, llvm::errs());
1166
Chad Rosierbe10f982011-08-02 17:58:04 +00001167 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001168 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
1169 "crash backtrace, preprocessed source, and associated run script.";
Chad Rosierbe10f982011-08-02 17:58:04 +00001170
1171 // Suppress driver output and emit preprocessor output to temp file.
Hans Wennborg70850d82013-07-18 20:29:38 +00001172 Mode = CPPMode;
Chad Rosierbe10f982011-08-02 17:58:04 +00001173 CCGenDiagnostics = true;
1174
Chad Rosiercdb008d2011-11-02 21:29:05 +00001175 // Save the original job command(s).
Justin Bogner25645152014-10-21 17:24:44 +00001176 Command Cmd = FailingCommand;
Chad Rosiercdb008d2011-11-02 21:29:05 +00001177
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001178 // Keep track of whether we produce any errors while trying to produce
1179 // preprocessed sources.
1180 DiagnosticErrorTrap Trap(Diags);
1181
1182 // Suppress tool output.
Chad Rosierbe10f982011-08-02 17:58:04 +00001183 C.initCompilationForDiagnostics();
Chad Rosierecdede82011-08-12 22:08:57 +00001184
1185 // Construct the list of inputs.
1186 InputList Inputs;
1187 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001188
Chad Rosier4f81fc22011-08-12 23:30:05 +00001189 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001190 bool IgnoreInput = false;
1191
1192 // Ignore input from stdin or any inputs that cannot be preprocessed.
Paul Robinsonf44157d2014-04-28 22:24:44 +00001193 // Check type first as not all linker inputs have a value.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001194 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
Paul Robinsonf44157d2014-04-28 22:24:44 +00001195 IgnoreInput = true;
1196 } else if (!strcmp(it->second->getValue(), "-")) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001197 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001198 << "Error generating preprocessed source(s) - "
1199 "ignoring input from stdin.";
Chad Rosierd57133d2011-08-18 00:22:25 +00001200 IgnoreInput = true;
Chad Rosierd57133d2011-08-18 00:22:25 +00001201 }
1202
1203 if (IgnoreInput) {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001204 it = Inputs.erase(it);
1205 ie = Inputs.end();
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001206 } else {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001207 ++it;
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001208 }
Chad Rosier4f81fc22011-08-12 23:30:05 +00001209 }
Chad Rosierd57133d2011-08-18 00:22:25 +00001210
Chad Rosierc5103c32013-01-29 23:57:10 +00001211 if (Inputs.empty()) {
1212 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001213 << "Error generating preprocessed source(s) - "
1214 "no preprocessable inputs.";
Chad Rosierc5103c32013-01-29 23:57:10 +00001215 return;
1216 }
1217
Chad Rosiere75ef402011-09-06 23:52:36 +00001218 // Don't attempt to generate preprocessed files if multiple -arch options are
Chad Rosier636d2832012-02-13 18:16:28 +00001219 // used, unless they're all duplicates.
1220 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001221 for (const Arg *A : C.getArgs()) {
Chad Rosiere75ef402011-09-06 23:52:36 +00001222 if (A->getOption().matches(options::OPT_arch)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001223 StringRef ArchName = A->getValue();
Chad Rosier636d2832012-02-13 18:16:28 +00001224 ArchNames.insert(ArchName);
Chad Rosiere75ef402011-09-06 23:52:36 +00001225 }
1226 }
Chad Rosier636d2832012-02-13 18:16:28 +00001227 if (ArchNames.size() > 1) {
1228 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001229 << "Error generating preprocessed source(s) - cannot generate "
1230 "preprocessed source with multiple -arch options.";
Chad Rosier636d2832012-02-13 18:16:28 +00001231 return;
1232 }
Chad Rosiere75ef402011-09-06 23:52:36 +00001233
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001234 // Construct the list of abstract actions to perform for this compilation. On
1235 // Darwin OSes this uses the driver-driver and builds universal actions.
Chandler Carruthcb916192012-01-25 08:49:21 +00001236 const ToolChain &TC = C.getDefaultToolChain();
Tim Northover157d9112014-01-16 08:48:16 +00001237 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001238 BuildUniversalActions(C, TC, Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001239 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001240 BuildActions(C, C.getArgs(), Inputs, C.getActions());
Chad Rosierbe10f982011-08-02 17:58:04 +00001241
1242 BuildJobs(C);
1243
1244 // If there were errors building the compilation, quit now.
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001245 if (Trap.hasErrorOccurred()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001246 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001247 << "Error generating preprocessed source(s).";
Chad Rosierbe10f982011-08-02 17:58:04 +00001248 return;
1249 }
1250
1251 // Generate preprocessed output.
Chad Rosierdd60e092013-01-29 20:15:05 +00001252 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
Justin Bogner0cd92482015-07-02 22:52:08 +00001253 C.ExecuteJobs(C.getJobs(), FailingCommands);
Chad Rosierbe10f982011-08-02 17:58:04 +00001254
Justin Bognerbc89b182014-10-20 21:20:27 +00001255 // If any of the preprocessing commands failed, clean up and exit.
1256 if (!FailingCommands.empty()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001257 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001258 << "Error generating preprocessed source(s).";
Justin Bognerbc89b182014-10-20 21:20:27 +00001259 return;
Chad Rosierbe10f982011-08-02 17:58:04 +00001260 }
Justin Bognerbc89b182014-10-20 21:20:27 +00001261
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001262 const ArgStringList &TempFiles = C.getTempFiles();
1263 if (TempFiles.empty()) {
1264 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001265 << "Error generating preprocessed source(s).";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001266 return;
1267 }
1268
Justin Bognerbc89b182014-10-20 21:20:27 +00001269 Diag(clang::diag::note_drv_command_failed_diag_msg)
1270 << "\n********************\n\n"
1271 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
1272 "Preprocessed source(s) and associated run script(s) are located at:";
Justin Bognerbc89b182014-10-20 21:20:27 +00001273
Justin Bogner659ecc32014-10-20 22:47:23 +00001274 SmallString<128> VFS;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001275 SmallString<128> ReproCrashFilename;
Justin Bogner659ecc32014-10-20 22:47:23 +00001276 for (const char *TempFile : TempFiles) {
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001277 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
Alex Lorenz045c5142018-04-07 00:03:27 +00001278 if (Report)
1279 Report->TemporaryFiles.push_back(TempFile);
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001280 if (ReproCrashFilename.empty()) {
1281 ReproCrashFilename = TempFile;
1282 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
1283 }
Justin Bogner659ecc32014-10-20 22:47:23 +00001284 if (StringRef(TempFile).endswith(".cache")) {
1285 // In some cases (modules) we'll dump extra data to help with reproducing
1286 // the crash into a directory next to the output.
1287 VFS = llvm::sys::path::filename(TempFile);
1288 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
1289 }
1290 }
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001291
1292 // Assume associated files are based off of the first temporary file.
Justin Bogner25645152014-10-21 17:24:44 +00001293 CrashReportInfo CrashInfo(TempFiles[0], VFS);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001294
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001295 llvm::SmallString<128> Script(CrashInfo.Filename);
1296 llvm::sys::path::replace_extension(Script, "sh");
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001297 std::error_code EC;
Zachary Turner1f67a3c2018-06-07 19:58:58 +00001298 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::CD_CreateNew);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001299 if (EC) {
1300 Diag(clang::diag::note_drv_command_failed_diag_msg)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001301 << "Error generating run script: " << Script << " " << EC.message();
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001302 } else {
Justin Bogner42220ed2015-03-12 00:14:35 +00001303 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
Justin Bognered9cbe02015-07-09 06:58:31 +00001304 << "# Driver args: ";
1305 printArgList(ScriptOS, C.getInputArgs());
1306 ScriptOS << "# Original command: ";
Justin Bogner42220ed2015-03-12 00:14:35 +00001307 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
Justin Bogner33bdbc62014-10-21 18:03:08 +00001308 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
Alex Lorenz045c5142018-04-07 00:03:27 +00001309 if (!AdditionalInformation.empty())
1310 ScriptOS << "\n# Additional information: " << AdditionalInformation
1311 << "\n";
1312 if (Report)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001313 Report->TemporaryFiles.push_back(Script.str());
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001314 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
Justin Bognerbc89b182014-10-20 21:20:27 +00001315 }
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001316
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001317 // On darwin, provide information about the .crash diagnostic report.
1318 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
1319 SmallString<128> CrashDiagDir;
1320 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
1321 Diag(clang::diag::note_drv_command_failed_diag_msg)
1322 << ReproCrashFilename.str();
1323 } else { // Suggest a directory for the user to look for .crash files.
1324 llvm::sys::path::append(CrashDiagDir, Name);
1325 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
1326 Diag(clang::diag::note_drv_command_failed_diag_msg)
1327 << "Crash backtrace is located in";
1328 Diag(clang::diag::note_drv_command_failed_diag_msg)
1329 << CrashDiagDir.str();
1330 Diag(clang::diag::note_drv_command_failed_diag_msg)
1331 << "(choose the .crash file that corresponds to your crash)";
1332 }
1333 }
1334
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001335 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1336 options::OPT_frewrite_map_file_EQ))
1337 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1338
Justin Bognerbc89b182014-10-20 21:20:27 +00001339 Diag(clang::diag::note_drv_command_failed_diag_msg)
1340 << "\n\n********************";
Chad Rosierbe10f982011-08-02 17:58:04 +00001341}
1342
Justin Bogner0cd92482015-07-02 22:52:08 +00001343void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
Oleg Ranevskyycd516372016-01-05 19:54:39 +00001344 // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001345 // if the tool does not support response files, there is a chance/ that things
1346 // will just work without a response file, so we silently just skip it.
Justin Bogner0cd92482015-07-02 22:52:08 +00001347 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
Oleg Ranevskyycd516372016-01-05 19:54:39 +00001348 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001349 return;
1350
1351 std::string TmpName = GetTemporaryPath("response", "txt");
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00001352 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001353}
1354
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001355int Driver::ExecuteCompilation(
1356 Compilation &C,
1357 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001358 // Just print if -### was present.
1359 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Hans Wennborgb212b342013-09-12 18:23:34 +00001360 C.getJobs().Print(llvm::errs(), "\n", true);
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001361 return 0;
1362 }
1363
1364 // If there were errors building the compilation, quit now.
Chad Rosierbe10f982011-08-02 17:58:04 +00001365 if (Diags.hasErrorOccurred())
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001366 return 1;
1367
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001368 // Set up response file names for each command, if necessary
Justin Bogner0cd92482015-07-02 22:52:08 +00001369 for (auto &Job : C.getJobs())
1370 setUpResponseFiles(C, Job);
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001371
Justin Bogner0cd92482015-07-02 22:52:08 +00001372 C.ExecuteJobs(C.getJobs(), FailingCommands);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001373
Daniel Dunbar07494792010-05-22 00:37:20 +00001374 // If the command succeeded, we are done.
Chad Rosierdd60e092013-01-29 20:15:05 +00001375 if (FailingCommands.empty())
1376 return 0;
Daniel Dunbar07494792010-05-22 00:37:20 +00001377
Chad Rosierdd60e092013-01-29 20:15:05 +00001378 // Otherwise, remove result files and print extra information about abnormal
1379 // failures.
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001380 for (const auto &CmdPair : FailingCommands) {
1381 int Res = CmdPair.first;
1382 const Command *FailingCommand = CmdPair.second;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001383
Chad Rosierdd60e092013-01-29 20:15:05 +00001384 // Remove result files if we're not saving temps.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001385 if (!isSaveTempsEnabled()) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001386 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1387 C.CleanupFileMap(C.getResultFiles(), JA, true);
1388
1389 // Failure result files are valid unless we crashed.
1390 if (Res < 0)
1391 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1392 }
1393
1394 // Print extra information about abnormal failures, if possible.
1395 //
1396 // This is ad-hoc, but we don't want to be excessively noisy. If the result
Justin Bogner5aaf2e72014-06-26 20:59:36 +00001397 // status was 1, assume the command failed normally. In particular, if it
Chad Rosierdd60e092013-01-29 20:15:05 +00001398 // was the compiler then assume it gave a reasonable error code. Failures
1399 // in other tools are less common, and they generally have worse
1400 // diagnostics, so always print the diagnostic there.
1401 const Tool &FailingTool = FailingCommand->getCreator();
1402
1403 if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
1404 // FIXME: See FIXME above regarding result code interpretation.
1405 if (Res < 0)
1406 Diag(clang::diag::err_drv_command_signalled)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001407 << FailingTool.getShortName();
Chad Rosierdd60e092013-01-29 20:15:05 +00001408 else
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001409 Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
1410 << Res;
Chad Rosierdd60e092013-01-29 20:15:05 +00001411 }
Peter Collingbourne119cfaa2011-11-21 00:01:05 +00001412 }
Chad Rosierdd60e092013-01-29 20:15:05 +00001413 return 0;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001414}
1415
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001416void Driver::PrintHelp(bool ShowHidden) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001417 unsigned IncludedFlagsBitmask;
1418 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001419 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001420 getIncludeExcludeOptionFlagMasks();
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001421
1422 ExcludedFlagsBitmask |= options::NoDriverOption;
1423 if (!ShowHidden)
1424 ExcludedFlagsBitmask |= HelpHidden;
1425
1426 getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
George Rimar5dbfa4e2017-07-26 09:10:17 +00001427 IncludedFlagsBitmask, ExcludedFlagsBitmask,
1428 /*ShowAllAliases=*/false);
Daniel Dunbar7c925282009-03-31 21:38:17 +00001429}
1430
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001431void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001432 // FIXME: The following handlers should use a callback mechanism, we don't
1433 // know what the client would like to do.
Ted Kremenek4c0df3d2010-01-23 02:11:34 +00001434 OS << getClangFullVersion() << '\n';
Daniel Dunbarb10248802009-03-26 16:09:13 +00001435 const ToolChain &TC = C.getDefaultToolChain();
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001436 OS << "Target: " << TC.getTripleString() << '\n';
Daniel Dunbar10978e42009-06-16 23:32:58 +00001437
1438 // Print the threading model.
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001439 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1440 // Don't print if the ToolChain would have barfed on it already
1441 if (TC.isThreadModelSupported(A->getValue()))
1442 OS << "Thread model: " << A->getValue();
1443 } else
1444 OS << "Thread model: " << TC.getThreadModel();
1445 OS << '\n';
Chandler Carruth9ade6a92015-08-05 17:07:33 +00001446
1447 // Print out the install directory.
1448 OS << "InstalledDir: " << InstalledDir << '\n';
Serge Pavlov208ac652018-01-01 13:27:01 +00001449
1450 // If configuration file was used, print its path.
1451 if (!ConfigFile.empty())
1452 OS << "Configuration file: " << ConfigFile << '\n';
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001453}
1454
Chris Lattner86ed5b02010-05-05 05:53:24 +00001455/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1456/// option.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001457static void PrintDiagnosticCategories(raw_ostream &OS) {
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001458 // Skip the empty category.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001459 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1460 ++i)
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001461 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
Chris Lattner86ed5b02010-05-05 05:53:24 +00001462}
1463
Yuka Takahashi41789e42018-03-05 08:54:20 +00001464void Driver::HandleAutocompletions(StringRef PassedFlags) const {
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001465 if (PassedFlags == "")
1466 return;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001467 // Print out all options that start with a given argument. This is used for
1468 // shell autocompletion.
1469 std::vector<std::string> SuggestedCompletions;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001470 std::vector<std::string> Flags;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001471
1472 unsigned short DisableFlags =
1473 options::NoDriverOption | options::Unsupported | options::Ignored;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001474
1475 // Parse PassedFlags by "," as all the command-line flags are passed to this
1476 // function separated by ","
1477 StringRef TargetFlags = PassedFlags;
1478 while (TargetFlags != "") {
1479 StringRef CurFlag;
1480 std::tie(CurFlag, TargetFlags) = TargetFlags.split(",");
1481 Flags.push_back(std::string(CurFlag));
Yuka Takahashi1a895202017-08-29 17:46:46 +00001482 }
1483
Yuka Takahashi41789e42018-03-05 08:54:20 +00001484 // We want to show cc1-only options only when clang is invoked with -cc1 or
1485 // -Xclang.
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001486 if (std::find(Flags.begin(), Flags.end(), "-Xclang") != Flags.end() ||
1487 std::find(Flags.begin(), Flags.end(), "-cc1") != Flags.end())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001488 DisableFlags &= ~options::NoDriverOption;
1489
1490 StringRef Cur;
1491 Cur = Flags.at(Flags.size() - 1);
1492 StringRef Prev;
1493 if (Flags.size() >= 2) {
1494 Prev = Flags.at(Flags.size() - 2);
1495 SuggestedCompletions = Opts->suggestValueCompletions(Prev, Cur);
1496 }
1497
1498 if (SuggestedCompletions.empty())
1499 SuggestedCompletions = Opts->suggestValueCompletions(Cur, "");
1500
1501 if (SuggestedCompletions.empty()) {
Yuka Takahashi1a895202017-08-29 17:46:46 +00001502 // If the flag is in the form of "--autocomplete=-foo",
1503 // we were requested to print out all option names that start with "-foo".
1504 // For example, "--autocomplete=-fsyn" is expanded to "-fsyntax-only".
Yuka Takahashi41789e42018-03-05 08:54:20 +00001505 SuggestedCompletions = Opts->findByPrefix(Cur, DisableFlags);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001506
1507 // We have to query the -W flags manually as they're not in the OptTable.
1508 // TODO: Find a good way to add them to OptTable instead and them remove
1509 // this code.
1510 for (StringRef S : DiagnosticIDs::getDiagnosticFlags())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001511 if (S.startswith(Cur))
Yuka Takahashi1a895202017-08-29 17:46:46 +00001512 SuggestedCompletions.push_back(S);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001513 }
1514
1515 // Sort the autocomplete candidates so that shells print them out in a
1516 // deterministic order. We could sort in any way, but we chose
1517 // case-insensitive sorting for consistency with the -help option
1518 // which prints out options in the case-insensitive alphabetical order.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00001519 llvm::sort(SuggestedCompletions.begin(), SuggestedCompletions.end(),
1520 [](StringRef A, StringRef B) {
1521 if (int X = A.compare_lower(B))
1522 return X < 0;
1523 return A.compare(B) > 0;
Mandeep Singh Grang8f54ae12017-11-20 18:49:14 +00001524 });
Yuka Takahashi1a895202017-08-29 17:46:46 +00001525
1526 llvm::outs() << llvm::join(SuggestedCompletions, "\n") << '\n';
1527}
1528
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001529bool Driver::HandleImmediateArgs(const Compilation &C) {
Daniel Dunbar18974bd2010-06-11 22:00:19 +00001530 // The order these options are handled in gcc is all over the place, but we
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001531 // don't expect inconsistencies w.r.t. that to matter in practice.
Daniel Dunbar7c925282009-03-31 21:38:17 +00001532
Daniel Dunbar1b09e042010-09-17 02:47:28 +00001533 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1534 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1535 return false;
1536 }
1537
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001538 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
Daniel Dunbare26e5002011-01-12 00:43:47 +00001539 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1540 // return an answer which matches our definition of __VERSION__.
1541 //
1542 // If we want to return a more correct answer some day, then we should
1543 // introduce a non-pedantically GCC compatible mode to Clang in which we
1544 // provide sensible definitions for -dumpversion, __VERSION__, etc.
1545 llvm::outs() << "4.2.1\n";
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001546 return false;
1547 }
Daniel Dunbarfb3d7472010-06-14 21:23:12 +00001548
Chris Lattner86ed5b02010-05-05 05:53:24 +00001549 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1550 PrintDiagnosticCategories(llvm::outs());
1551 return false;
1552 }
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001553
James Molloya3c85b82012-05-01 14:57:16 +00001554 if (C.getArgs().hasArg(options::OPT_help) ||
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001555 C.getArgs().hasArg(options::OPT__help_hidden)) {
1556 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
Daniel Dunbar7c925282009-03-31 21:38:17 +00001557 return false;
1558 }
1559
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001560 if (C.getArgs().hasArg(options::OPT__version)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001561 // Follow gcc behavior and use stdout for --version and stderr for -v.
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001562 PrintVersion(C, llvm::outs());
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001563 return false;
1564 }
1565
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001566 if (C.getArgs().hasArg(options::OPT_v) ||
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001567 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001568 PrintVersion(C, llvm::errs());
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001569 SuppressMissingInputWarning = true;
1570 }
1571
Serge Pavlov208ac652018-01-01 13:27:01 +00001572 if (C.getArgs().hasArg(options::OPT_v)) {
1573 if (!SystemConfigDir.empty())
1574 llvm::errs() << "System configuration file directory: "
1575 << SystemConfigDir << "\n";
1576 if (!UserConfigDir.empty())
1577 llvm::errs() << "User configuration file directory: "
1578 << UserConfigDir << "\n";
1579 }
1580
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001581 const ToolChain &TC = C.getDefaultToolChain();
Chandler Carruth0ae39aa2013-07-30 17:57:09 +00001582
1583 if (C.getArgs().hasArg(options::OPT_v))
1584 TC.printVerboseInfo(llvm::errs());
1585
Meador Inge51208a32017-04-04 21:46:50 +00001586 if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
Meador Ingea9113952017-04-05 22:27:20 +00001587 llvm::outs() << ResourceDir << '\n';
Meador Inge51208a32017-04-04 21:46:50 +00001588 return false;
1589 }
1590
Daniel Dunbard972e222009-03-20 04:37:21 +00001591 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1592 llvm::outs() << "programs: =";
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001593 bool separator = false;
1594 for (const std::string &Path : TC.getProgramPaths()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001595 if (separator)
1596 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001597 llvm::outs() << Path;
1598 separator = true;
Daniel Dunbard972e222009-03-20 04:37:21 +00001599 }
1600 llvm::outs() << "\n";
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001601 llvm::outs() << "libraries: =" << ResourceDir;
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001602
Sebastian Pop980920a2012-04-16 04:16:43 +00001603 StringRef sysroot = C.getSysRoot();
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001604
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001605 for (const std::string &Path : TC.getFilePaths()) {
1606 // Always print a separator. ResourceDir was the first item shown.
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001607 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001608 // Interpretation of leading '=' is needed only for NetBSD.
1609 if (Path[0] == '=')
Douglas Katzman26eabf62015-06-24 15:10:30 +00001610 llvm::outs() << sysroot << Path.substr(1);
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001611 else
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001612 llvm::outs() << Path;
Daniel Dunbard972e222009-03-20 04:37:21 +00001613 }
1614 llvm::outs() << "\n";
Daniel Dunbar7c925282009-03-31 21:38:17 +00001615 return false;
Daniel Dunbard972e222009-03-20 04:37:21 +00001616 }
1617
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001618 // FIXME: The following handlers should use a callback mechanism, we don't
1619 // know what the client would like to do.
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001620 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001621 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001622 return false;
1623 }
1624
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001625 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
Saleem Abdulrasoole5f3cf82018-05-01 18:40:42 +00001626 StringRef ProgName = A->getValue();
1627
1628 // Null program name cannot have a path.
1629 if (! ProgName.empty())
1630 llvm::outs() << GetProgramPath(ProgName, TC);
1631
1632 llvm::outs() << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001633 return false;
1634 }
1635
Yuka Takahashic8068db2017-05-23 18:39:08 +00001636 if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
Yuka Takahashiba5d4af2017-06-20 16:31:31 +00001637 StringRef PassedFlags = A->getValue();
Yuka Takahashi41789e42018-03-05 08:54:20 +00001638 HandleAutocompletions(PassedFlags);
Yuka Takahashic8068db2017-05-23 18:39:08 +00001639 return false;
1640 }
1641
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001642 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
Michal Gorny7cfe4802016-10-10 12:23:40 +00001643 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
Leo Li23bb21c2017-08-24 01:51:51 +00001644 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1645 RegisterEffectiveTriple TripleRAII(TC, Triple);
Michal Gorny7cfe4802016-10-10 12:23:40 +00001646 switch (RLT) {
1647 case ToolChain::RLT_CompilerRT:
1648 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1649 break;
1650 case ToolChain::RLT_Libgcc:
1651 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1652 break;
1653 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001654 return false;
1655 }
1656
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001657 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001658 for (const Multilib &Multilib : TC.getMultilibs())
1659 llvm::outs() << Multilib << "\n";
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001660 return false;
1661 }
1662
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001663 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
Christian Bruel6ccc4a72018-09-06 14:03:44 +00001664 const Multilib &Multilib = TC.getMultilib();
1665 if (Multilib.gccSuffix().empty())
1666 llvm::outs() << ".\n";
1667 else {
1668 StringRef Suffix(Multilib.gccSuffix());
1669 assert(Suffix.front() == '/');
1670 llvm::outs() << Suffix.substr(1) << "\n";
Jonathan Roelofs3fa96d82014-02-12 01:36:51 +00001671 }
Jonathan Roelofs0e7ec602014-02-12 01:29:25 +00001672 return false;
1673 }
Petr Hosekbc86a992018-08-16 00:22:03 +00001674
1675 if (C.getArgs().hasArg(options::OPT_print_target_triple)) {
1676 llvm::outs() << TC.getTripleString() << "\n";
1677 return false;
1678 }
1679
1680 if (C.getArgs().hasArg(options::OPT_print_effective_triple)) {
1681 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1682 llvm::outs() << Triple.getTriple() << "\n";
1683 return false;
1684 }
1685
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001686 return true;
1687}
1688
Douglas Katzmanfd528672015-06-11 15:05:22 +00001689// Display an action graph human-readably. Action A is the "sink" node
1690// and latest-occuring action. Traversal is in pre-order, visiting the
1691// inputs to each action before printing the action itself.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001692static unsigned PrintActions1(const Compilation &C, Action *A,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001693 std::map<Action *, unsigned> &Ids) {
Douglas Katzmanfd528672015-06-11 15:05:22 +00001694 if (Ids.count(A)) // A was already visited.
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001695 return Ids[A];
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001696
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001697 std::string str;
1698 llvm::raw_string_ostream os(str);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001699
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001700 os << Action::getClassName(A->getKind()) << ", ";
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001701 if (InputAction *IA = dyn_cast<InputAction>(A)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001702 os << "\"" << IA->getInputArg().getValue() << "\"";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001703 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001704 os << '"' << BIA->getArchName() << '"' << ", {"
Nico Weber5a459f82016-02-23 19:30:43 +00001705 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
Samuel Antaod06239d2016-07-15 23:13:27 +00001706 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1707 bool IsFirst = true;
1708 OA->doOnEachDependence(
1709 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1710 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1711 // sm_35 this will generate:
1712 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1713 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1714 if (!IsFirst)
1715 os << ", ";
1716 os << '"';
1717 if (TC)
1718 os << A->getOffloadingKindPrefix();
1719 else
1720 os << "host";
1721 os << " (";
1722 os << TC->getTriple().normalize();
1723
1724 if (BoundArch)
1725 os << ":" << BoundArch;
1726 os << ")";
1727 os << '"';
1728 os << " {" << PrintActions1(C, A, Ids) << "}";
1729 IsFirst = false;
1730 });
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001731 } else {
Samuel Antaod06239d2016-07-15 23:13:27 +00001732 const ActionList *AL = &A->getInputs();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00001733
Artem Belevich23256752015-09-22 17:23:09 +00001734 if (AL->size()) {
1735 const char *Prefix = "{";
1736 for (Action *PreRequisite : *AL) {
1737 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1738 Prefix = ", ";
1739 }
1740 os << "}";
1741 } else
1742 os << "{}";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001743 }
1744
Samuel Antaod06239d2016-07-15 23:13:27 +00001745 // Append offload info for all options other than the offloading action
1746 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1747 std::string offload_str;
1748 llvm::raw_string_ostream offload_os(offload_str);
1749 if (!isa<OffloadAction>(A)) {
1750 auto S = A->getOffloadingKindPrefix();
1751 if (!S.empty()) {
1752 offload_os << ", (" << S;
1753 if (A->getOffloadingArch())
1754 offload_os << ", " << A->getOffloadingArch();
1755 offload_os << ")";
1756 }
1757 }
1758
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001759 unsigned Id = Ids.size();
1760 Ids[A] = Id;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001761 llvm::errs() << Id << ": " << os.str() << ", "
Samuel Antaod06239d2016-07-15 23:13:27 +00001762 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001763
1764 return Id;
1765}
1766
Douglas Katzmanfd528672015-06-11 15:05:22 +00001767// Print the action graphs in a compilation C.
1768// For example "clang -c file1.c file2.c" is composed of two subgraphs.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001769void Driver::PrintActions(const Compilation &C) const {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001770 std::map<Action *, unsigned> Ids;
1771 for (Action *A : C.getActions())
1772 PrintActions1(C, A, Ids);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001773}
1774
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001775/// Check whether the given input tree contains any compilation or
Joerg Sonnenberger5fe4a7d2011-05-06 14:05:11 +00001776/// assembly actions.
1777static bool ContainsCompileOrAssembleAction(const Action *A) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001778 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
Bob Wilson23a55f12014-12-21 07:00:00 +00001779 isa<AssembleJobAction>(A))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001780 return true;
1781
Nico Weber5a459f82016-02-23 19:30:43 +00001782 for (const Action *Input : A->inputs())
Nico Weberfb80f962015-09-19 21:36:51 +00001783 if (ContainsCompileOrAssembleAction(Input))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001784 return true;
1785
1786 return false;
1787}
1788
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001789void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1790 const InputList &BAInputs) const {
1791 DerivedArgList &Args = C.getArgs();
1792 ActionList &Actions = C.getActions();
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001793 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1794 // Collect the list of architectures. Duplicates are allowed, but should only
1795 // be handled once (in the order seen).
Daniel Dunbare5dc4822009-03-13 20:33:35 +00001796 llvm::StringSet<> ArchNames;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001797 SmallVector<const char *, 4> Archs;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001798 for (Arg *A : Args) {
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001799 if (A->getOption().matches(options::OPT_arch)) {
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001800 // Validate the option here; we don't save the type here because its
1801 // particular spelling may participate in other driver choices.
1802 llvm::Triple::ArchType Arch =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001803 tools::darwin::getArchTypeForMachOArchName(A->getValue());
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001804 if (Arch == llvm::Triple::UnknownArch) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001805 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001806 continue;
1807 }
1808
Daniel Dunbar2da02722009-03-19 07:55:12 +00001809 A->claim();
David Blaikie61b86d42014-11-19 02:56:13 +00001810 if (ArchNames.insert(A->getValue()).second)
Richard Smithbd55daf2012-11-01 04:30:05 +00001811 Archs.push_back(A->getValue());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001812 }
1813 }
1814
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001815 // When there is no explicit arch for this platform, make sure we still bind
1816 // the architecture (to the default) so that -Xarch_ is handled correctly.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001817 if (!Archs.size())
Daniel Dunbarc3bd9f52012-11-08 03:38:26 +00001818 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001819
Daniel Dunbarf479c122009-03-12 18:40:18 +00001820 ActionList SingleActions;
Justin Lebar0f3474c2016-02-11 02:00:50 +00001821 BuildActions(C, Args, BAInputs, SingleActions);
Daniel Dunbarf479c122009-03-12 18:40:18 +00001822
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001823 // Add in arch bindings for every top level action, as well as lipo and
1824 // dsymutil steps if needed.
Nico Weberfb80f962015-09-19 21:36:51 +00001825 for (Action* Act : SingleActions) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001826 // Make sure we can lipo this kind of output. If not (and it is an actual
1827 // output) then we disallow, since we can't create an output file with the
1828 // right name without overwriting it. We could remove this oddity by just
1829 // changing the output names to include the arch, which would also fix
Daniel Dunbarf479c122009-03-12 18:40:18 +00001830 // -save-temps. Compatibility wins for now.
1831
Daniel Dunbare2ca3bd2009-03-13 17:46:02 +00001832 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
Daniel Dunbarf479c122009-03-12 18:40:18 +00001833 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001834 << types::getTypeName(Act->getType());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001835
1836 ActionList Inputs;
Justin Lebar41094612016-01-11 23:07:27 +00001837 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1838 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001839
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001840 // Lipo if necessary, we do it this way because we need to set the arch flag
1841 // so that -Xarch_ gets overwritten.
Daniel Dunbarf479c122009-03-12 18:40:18 +00001842 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1843 Actions.append(Inputs.begin(), Inputs.end());
1844 else
Justin Lebar41094612016-01-11 23:07:27 +00001845 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001846
Eric Christopher65c05fa2012-02-06 19:43:51 +00001847 // Handle debug info queries.
1848 Arg *A = Args.getLastArg(options::OPT_g_Group);
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001849 if (A && !A->getOption().matches(options::OPT_g0) &&
1850 !A->getOption().matches(options::OPT_gstabs) &&
1851 ContainsCompileOrAssembleAction(Actions.back())) {
Chad Rosier62135492012-07-09 17:31:28 +00001852
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001853 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1854 // have a compile input. We need to run 'dsymutil' ourselves in such cases
Eric Christopher776c26f2013-01-28 17:39:03 +00001855 // because the debug info will refer to a temporary object file which
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001856 // will be removed at the end of the compilation process.
1857 if (Act->getType() == types::TY_Image) {
1858 ActionList Inputs;
1859 Inputs.push_back(Actions.back());
1860 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001861 Actions.push_back(
1862 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001863 }
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001864
Ben Langmuir9b9a8d32014-02-06 18:53:25 +00001865 // Verify the debug info output.
Alp Tokere9d2bfc2014-01-17 02:06:23 +00001866 if (Args.hasArg(options::OPT_verify_debug_info)) {
Justin Lebar41094612016-01-11 23:07:27 +00001867 Action* LastAction = Actions.back();
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001868 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001869 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1870 LastAction, types::TY_Nothing));
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001871 }
1872 }
Daniel Dunbarf479c122009-03-12 18:40:18 +00001873 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001874}
1875
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001876/// Check that the file referenced by Value exists. If it doesn't,
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001877/// issue a diagnostic and return false.
Alp Toker8c8a8752013-12-03 06:53:35 +00001878static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001879 StringRef Value, types::ID Ty) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001880 if (!D.getCheckInputsExist())
1881 return true;
1882
1883 // stdin always exists.
1884 if (Value == "-")
1885 return true;
1886
1887 SmallString<64> Path(Value);
1888 if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
Yaron Keren92e1b622015-03-18 10:17:07 +00001889 if (!llvm::sys::path::is_absolute(Path)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001890 SmallString<64> Directory(WorkDir->getValue());
1891 llvm::sys::path::append(Directory, Value);
1892 Path.assign(Directory);
1893 }
1894 }
1895
1896 if (llvm::sys::fs::exists(Twine(Path)))
1897 return true;
1898
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001899 if (D.IsCLMode()) {
1900 if (!llvm::sys::path::is_absolute(Twine(Path)) &&
1901 llvm::sys::Process::FindInEnvPath("LIB", Value))
1902 return true;
1903
1904 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
1905 // Arguments to the /link flag might cause the linker to search for object
1906 // and library files in paths we don't know about. Don't error in such
1907 // cases.
1908 return true;
1909 }
1910 }
Hans Wennborg23d26a32014-06-18 17:21:50 +00001911
Yaron Keren92e1b622015-03-18 10:17:07 +00001912 D.Diag(clang::diag::err_drv_no_such_file) << Path;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001913 return false;
1914}
1915
Chad Rosierecdede82011-08-12 22:08:57 +00001916// Construct a the list of inputs and their types.
Hans Wennborg55362852014-05-02 22:55:30 +00001917void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
Chad Rosierecdede82011-08-12 22:08:57 +00001918 InputList &Inputs) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001919 // Track the current user specified (-x) input. We also explicitly track the
1920 // argument used to set the type; we only want to claim the type when we
1921 // actually use it, so we warn about unused -x arguments.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001922 types::ID InputType = types::TY_Nothing;
Craig Topper92fc2df2014-05-17 16:56:41 +00001923 Arg *InputTypeArg = nullptr;
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001924
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001925 // The last /TC or /TP option sets the input type to C or C++ globally.
Ehsan Akhgaric249abb2014-09-12 21:44:24 +00001926 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1927 options::OPT__SLASH_TP)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001928 InputTypeArg = TCTP;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001929 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001930 ? types::TY_C
1931 : types::TY_CXX;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001932
Richard Smith0aef3052017-02-18 01:14:43 +00001933 Arg *Previous = nullptr;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001934 bool ShowNote = false;
Richard Smith0aef3052017-02-18 01:14:43 +00001935 for (Arg *A : Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
1936 if (Previous) {
1937 Diag(clang::diag::warn_drv_overriding_flag_option)
1938 << Previous->getSpelling() << A->getSpelling();
1939 ShowNote = true;
1940 }
1941 Previous = A;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001942 }
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001943 if (ShowNote)
1944 Diag(clang::diag::note_drv_t_option_is_global);
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001945
1946 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1947 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1948 }
1949
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001950 for (Arg *A : Args) {
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00001951 if (A->getOption().getKind() == Option::InputClass) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001952 const char *Value = A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001953 types::ID Ty = types::TY_INVALID;
1954
1955 // Infer the input type if necessary.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001956 if (InputType == types::TY_Nothing) {
1957 // If there was an explicit arg for this, claim it.
1958 if (InputTypeArg)
1959 InputTypeArg->claim();
1960
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001961 // stdin must be handled specially.
1962 if (memcmp(Value, "-", 2) == 0) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001963 // If running with -E, treat as a C input (this changes the builtin
1964 // macros, for example). This may be overridden by -ObjC below.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001965 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001966 // Otherwise emit an error but still use a valid type to avoid
1967 // spurious errors (e.g., no inputs).
Hans Wennborg70850d82013-07-18 20:29:38 +00001968 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
Hans Wennborgcfdd8b52014-01-29 01:04:40 +00001969 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1970 : clang::diag::err_drv_unknown_stdin_type);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001971 Ty = types::TY_C;
1972 } else {
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001973 // Otherwise lookup by extension.
1974 // Fallback is C if invoked as C preprocessor or Object otherwise.
1975 // We use a host hook here because Darwin at least has its own
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001976 // idea of what .s is.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001977 if (const char *Ext = strrchr(Value, '.'))
Daniel Dunbarcc7df6c2010-08-02 05:43:56 +00001978 Ty = TC.LookupTypeForExtension(Ext + 1);
Daniel Dunbarea9f0322009-03-20 23:39:23 +00001979
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001980 if (Ty == types::TY_INVALID) {
Hans Wennborg70850d82013-07-18 20:29:38 +00001981 if (CCCIsCPP())
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001982 Ty = types::TY_C;
1983 else
1984 Ty = types::TY_Object;
1985 }
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001986
1987 // If the driver is invoked as C++ compiler (like clang++ or c++) it
1988 // should autodetect some input files as C++ for g++ compatibility.
Hans Wennborg70850d82013-07-18 20:29:38 +00001989 if (CCCIsCXX()) {
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001990 types::ID OldTy = Ty;
1991 Ty = types::lookupCXXTypeForCType(Ty);
1992
1993 if (Ty != OldTy)
1994 Diag(clang::diag::warn_drv_treating_input_as_cxx)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001995 << getTypeName(OldTy) << getTypeName(Ty);
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001996 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001997 }
1998
Daniel Dunbar82b22102009-05-18 21:47:54 +00001999 // -ObjC and -ObjC++ override the default language, but only for "source
2000 // files". We just treat everything that isn't a linker input as a
2001 // source file.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002002 //
Daniel Dunbar82b22102009-05-18 21:47:54 +00002003 // FIXME: Clean this up if we move the phase sequence into the type.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002004 if (Ty != types::TY_Object) {
2005 if (Args.hasArg(options::OPT_ObjC))
2006 Ty = types::TY_ObjC;
2007 else if (Args.hasArg(options::OPT_ObjCXX))
2008 Ty = types::TY_ObjCXX;
2009 }
2010 } else {
2011 assert(InputTypeArg && "InputType set w/o InputTypeArg");
Ehsan Akhgari7e954ea2014-09-12 18:15:10 +00002012 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
2013 // If emulating cl.exe, make sure that /TC and /TP don't affect input
2014 // object files.
2015 const char *Ext = strrchr(Value, '.');
2016 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
2017 Ty = types::TY_Object;
2018 }
2019 if (Ty == types::TY_INVALID) {
2020 Ty = InputType;
2021 InputTypeArg->claim();
2022 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002023 }
2024
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002025 if (DiagnoseInputExistence(*this, Args, Value, Ty))
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002026 Inputs.push_back(std::make_pair(Ty, A));
2027
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002028 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
2029 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002030 if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002031 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002032 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
2033 }
2034 A->claim();
2035 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
2036 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002037 if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002038 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002039 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
2040 }
2041 A->claim();
Michael J. Spencer66e2b202012-10-19 22:37:06 +00002042 } else if (A->getOption().hasFlag(options::LinkerInput)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002043 // Just treat as object type, we could make a special type for this if
2044 // necessary.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002045 Inputs.push_back(std::make_pair(types::TY_Object, A));
2046
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00002047 } else if (A->getOption().matches(options::OPT_x)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002048 InputTypeArg = A;
Richard Smithbd55daf2012-11-01 04:30:05 +00002049 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
Chad Rosier706c2352012-04-07 00:01:31 +00002050 A->claim();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002051
2052 // Follow gcc behavior and treat as linker input for invalid -x
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002053 // options. Its not clear why we shouldn't just revert to unknown; but
Michael J. Spencer1a4fe8c2010-12-17 21:22:33 +00002054 // this isn't very important, we might as well be bug compatible.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002055 if (!InputType) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002056 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002057 InputType = types::TY_Object;
2058 }
Hans Wennborg091f1b62017-01-27 17:09:41 +00002059 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
2060 assert(A->getNumValues() == 1 && "The /U option has one value.");
2061 StringRef Val = A->getValue(0);
2062 if (Val.find_first_of("/\\") != StringRef::npos) {
2063 // Warn about e.g. "/Users/me/myfile.c".
2064 Diag(diag::warn_slash_u_filename) << Val;
2065 Diag(diag::note_use_dashdash);
2066 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002067 }
2068 }
Hans Wennborg70850d82013-07-18 20:29:38 +00002069 if (CCCIsCPP() && Inputs.empty()) {
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002070 // If called as standalone preprocessor, stdin is processed
2071 // if no other input is present.
David Blaikie0aaa7622017-01-13 17:34:15 +00002072 Arg *A = MakeInputArg(Args, *Opts, "-");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002073 Inputs.push_back(std::make_pair(types::TY_C, A));
2074 }
Chad Rosierecdede82011-08-12 22:08:57 +00002075}
2076
Samuel Antao64e965e2016-09-30 15:34:19 +00002077namespace {
2078/// Provides a convenient interface for different programming models to generate
2079/// the required device actions.
2080class OffloadingActionBuilder final {
2081 /// Flag used to trace errors in the builder.
2082 bool IsValid = false;
2083
2084 /// The compilation that is using this builder.
2085 Compilation &C;
2086
Samuel Antao64e965e2016-09-30 15:34:19 +00002087 /// Map between an input argument and the offload kinds used to process it.
2088 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
2089
2090 /// Builder interface. It doesn't build anything or keep any state.
2091 class DeviceActionBuilder {
2092 public:
2093 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
2094
2095 enum ActionBuilderReturnCode {
2096 // The builder acted successfully on the current action.
2097 ABRT_Success,
2098 // The builder didn't have to act on the current action.
2099 ABRT_Inactive,
2100 // The builder was successful and requested the host action to not be
2101 // generated.
2102 ABRT_Ignore_Host,
2103 };
2104
2105 protected:
2106 /// Compilation associated with this builder.
2107 Compilation &C;
2108
2109 /// Tool chains associated with this builder. The same programming
2110 /// model may have associated one or more tool chains.
2111 SmallVector<const ToolChain *, 2> ToolChains;
2112
2113 /// The derived arguments associated with this builder.
2114 DerivedArgList &Args;
2115
2116 /// The inputs associated with this builder.
2117 const Driver::InputList &Inputs;
2118
2119 /// The associated offload kind.
2120 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
2121
2122 public:
2123 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
2124 const Driver::InputList &Inputs,
2125 Action::OffloadKind AssociatedOffloadKind)
2126 : C(C), Args(Args), Inputs(Inputs),
2127 AssociatedOffloadKind(AssociatedOffloadKind) {}
2128 virtual ~DeviceActionBuilder() {}
2129
2130 /// Fill up the array \a DA with all the device dependences that should be
2131 /// added to the provided host action \a HostAction. By default it is
2132 /// inactive.
2133 virtual ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002134 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2135 phases::ID CurPhase, phases::ID FinalPhase,
2136 PhasesTy &Phases) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002137 return ABRT_Inactive;
2138 }
2139
2140 /// Update the state to include the provided host action \a HostAction as a
2141 /// dependency of the current device action. By default it is inactive.
2142 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
2143 return ABRT_Inactive;
2144 }
2145
2146 /// Append top level actions generated by the builder. Return true if errors
2147 /// were found.
2148 virtual void appendTopLevelActions(ActionList &AL) {}
2149
2150 /// Append linker actions generated by the builder. Return true if errors
2151 /// were found.
2152 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
2153
2154 /// Initialize the builder. Return true if any initialization errors are
2155 /// found.
2156 virtual bool initialize() { return false; }
2157
Samuel Antao69d6f312016-10-27 17:50:43 +00002158 /// Return true if the builder can use bundling/unbundling.
2159 virtual bool canUseBundlerUnbundler() const { return false; }
2160
Samuel Antao64e965e2016-09-30 15:34:19 +00002161 /// Return true if this builder is valid. We have a valid builder if we have
2162 /// associated device tool chains.
2163 bool isValid() { return !ToolChains.empty(); }
2164
2165 /// Return the associated offload kind.
2166 Action::OffloadKind getAssociatedOffloadKind() {
2167 return AssociatedOffloadKind;
2168 }
2169 };
2170
Yaxun Liu3af038b2018-05-30 00:49:10 +00002171 /// Base class for CUDA/HIP action builder. It injects device code in
2172 /// the host backend action.
2173 class CudaActionBuilderBase : public DeviceActionBuilder {
2174 protected:
Samuel Antao64e965e2016-09-30 15:34:19 +00002175 /// Flags to signal if the user requested host-only or device-only
2176 /// compilation.
2177 bool CompileHostOnly = false;
2178 bool CompileDeviceOnly = false;
2179
2180 /// List of GPU architectures to use in this compilation.
2181 SmallVector<CudaArch, 4> GpuArchList;
2182
2183 /// The CUDA actions for the current input.
2184 ActionList CudaDeviceActions;
2185
2186 /// The CUDA fat binary if it was generated for the current input.
2187 Action *CudaFatBinary = nullptr;
2188
2189 /// Flag that is set to true if this builder acted on the current input.
2190 bool IsActive = false;
Yaxun Liu3af038b2018-05-30 00:49:10 +00002191 public:
2192 CudaActionBuilderBase(Compilation &C, DerivedArgList &Args,
2193 const Driver::InputList &Inputs,
2194 Action::OffloadKind OFKind)
2195 : DeviceActionBuilder(C, Args, Inputs, OFKind) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002196
Yaxun Liu3af038b2018-05-30 00:49:10 +00002197 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2198 // While generating code for CUDA, we only depend on the host input action
2199 // to trigger the creation of all the CUDA device actions.
2200
2201 // If we are dealing with an input action, replicate it for each GPU
2202 // architecture. If we are in host-only mode we return 'success' so that
2203 // the host uses the CUDA offload kind.
2204 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2205 assert(!GpuArchList.empty() &&
2206 "We should have at least one GPU architecture.");
2207
2208 // If the host input is not CUDA or HIP, we don't need to bother about
2209 // this input.
2210 if (IA->getType() != types::TY_CUDA &&
2211 IA->getType() != types::TY_HIP) {
2212 // The builder will ignore this input.
2213 IsActive = false;
2214 return ABRT_Inactive;
2215 }
2216
2217 // Set the flag to true, so that the builder acts on the current input.
2218 IsActive = true;
2219
2220 if (CompileHostOnly)
2221 return ABRT_Success;
2222
2223 // Replicate inputs for each GPU architecture.
2224 auto Ty = IA->getType() == types::TY_HIP ? types::TY_HIP_DEVICE
2225 : types::TY_CUDA_DEVICE;
2226 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2227 CudaDeviceActions.push_back(
2228 C.MakeAction<InputAction>(IA->getInputArg(), Ty));
2229 }
2230
2231 return ABRT_Success;
2232 }
2233
2234 // If this is an unbundling action use it as is for each CUDA toolchain.
2235 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2236 CudaDeviceActions.clear();
2237 for (auto Arch : GpuArchList) {
2238 CudaDeviceActions.push_back(UA);
2239 UA->registerDependentActionInfo(ToolChains[0], CudaArchToString(Arch),
2240 AssociatedOffloadKind);
2241 }
2242 return ABRT_Success;
2243 }
2244
2245 return IsActive ? ABRT_Success : ABRT_Inactive;
2246 }
2247
2248 void appendTopLevelActions(ActionList &AL) override {
2249 // Utility to append actions to the top level list.
2250 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
2251 OffloadAction::DeviceDependences Dep;
2252 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
2253 AssociatedOffloadKind);
2254 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2255 };
2256
2257 // If we have a fat binary, add it to the list.
2258 if (CudaFatBinary) {
2259 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
2260 CudaDeviceActions.clear();
2261 CudaFatBinary = nullptr;
2262 return;
2263 }
2264
2265 if (CudaDeviceActions.empty())
2266 return;
2267
2268 // If we have CUDA actions at this point, that's because we have a have
2269 // partial compilation, so we should have an action for each GPU
2270 // architecture.
2271 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2272 "Expecting one action per GPU architecture.");
2273 assert(ToolChains.size() == 1 &&
2274 "Expecting to have a sing CUDA toolchain.");
2275 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
2276 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
2277
2278 CudaDeviceActions.clear();
2279 }
2280
2281 bool initialize() override {
2282 assert(AssociatedOffloadKind == Action::OFK_Cuda ||
2283 AssociatedOffloadKind == Action::OFK_HIP);
2284
2285 // We don't need to support CUDA.
2286 if (AssociatedOffloadKind == Action::OFK_Cuda &&
2287 !C.hasOffloadToolChain<Action::OFK_Cuda>())
2288 return false;
2289
2290 // We don't need to support HIP.
2291 if (AssociatedOffloadKind == Action::OFK_HIP &&
2292 !C.hasOffloadToolChain<Action::OFK_HIP>())
2293 return false;
2294
2295 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
2296 assert(HostTC && "No toolchain for host compilation.");
2297 if (HostTC->getTriple().isNVPTX() ||
2298 HostTC->getTriple().getArch() == llvm::Triple::amdgcn) {
2299 // We do not support targeting NVPTX/AMDGCN for host compilation. Throw
2300 // an error and abort pipeline construction early so we don't trip
2301 // asserts that assume device-side compilation.
2302 C.getDriver().Diag(diag::err_drv_cuda_host_arch)
2303 << HostTC->getTriple().getArchName();
2304 return true;
2305 }
2306
2307 ToolChains.push_back(
2308 AssociatedOffloadKind == Action::OFK_Cuda
2309 ? C.getSingleOffloadToolChain<Action::OFK_Cuda>()
2310 : C.getSingleOffloadToolChain<Action::OFK_HIP>());
2311
2312 Arg *PartialCompilationArg = Args.getLastArg(
2313 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
2314 options::OPT_cuda_compile_host_device);
2315 CompileHostOnly = PartialCompilationArg &&
2316 PartialCompilationArg->getOption().matches(
2317 options::OPT_cuda_host_only);
2318 CompileDeviceOnly = PartialCompilationArg &&
2319 PartialCompilationArg->getOption().matches(
2320 options::OPT_cuda_device_only);
2321
2322 // Collect all cuda_gpu_arch parameters, removing duplicates.
2323 std::set<CudaArch> GpuArchs;
2324 bool Error = false;
2325 for (Arg *A : Args) {
2326 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
2327 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
2328 continue;
2329 A->claim();
2330
2331 const StringRef ArchStr = A->getValue();
2332 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
2333 ArchStr == "all") {
2334 GpuArchs.clear();
2335 continue;
2336 }
2337 CudaArch Arch = StringToCudaArch(ArchStr);
2338 if (Arch == CudaArch::UNKNOWN) {
2339 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
2340 Error = true;
2341 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
2342 GpuArchs.insert(Arch);
2343 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
2344 GpuArchs.erase(Arch);
2345 else
2346 llvm_unreachable("Unexpected option.");
2347 }
2348
2349 // Collect list of GPUs remaining in the set.
2350 for (CudaArch Arch : GpuArchs)
2351 GpuArchList.push_back(Arch);
2352
2353 // Default to sm_20 which is the lowest common denominator for
2354 // supported GPUs. sm_20 code should work correctly, if
2355 // suboptimally, on all newer GPUs.
2356 if (GpuArchList.empty())
2357 GpuArchList.push_back(CudaArch::SM_20);
2358
2359 return Error;
2360 }
2361 };
2362
2363 /// \brief CUDA action builder. It injects device code in the host backend
2364 /// action.
2365 class CudaActionBuilder final : public CudaActionBuilderBase {
Samuel Antao64e965e2016-09-30 15:34:19 +00002366 public:
2367 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
2368 const Driver::InputList &Inputs)
Yaxun Liu3af038b2018-05-30 00:49:10 +00002369 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_Cuda) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002370
2371 ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002372 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2373 phases::ID CurPhase, phases::ID FinalPhase,
2374 PhasesTy &Phases) override {
Samuel Antao64e965e2016-09-30 15:34:19 +00002375 if (!IsActive)
2376 return ABRT_Inactive;
2377
2378 // If we don't have more CUDA actions, we don't have any dependences to
2379 // create for the host.
2380 if (CudaDeviceActions.empty())
2381 return ABRT_Success;
2382
2383 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2384 "Expecting one action per GPU architecture.");
2385 assert(!CompileHostOnly &&
2386 "Not expecting CUDA actions in host-only compilation.");
2387
2388 // If we are generating code for the device or we are in a backend phase,
2389 // we attempt to generate the fat binary. We compile each arch to ptx and
2390 // assemble to cubin, then feed the cubin *and* the ptx into a device
2391 // "link" action, which uses fatbinary to combine these cubins into one
2392 // fatbin. The fatbin is then an input to the host action if not in
2393 // device-only mode.
2394 if (CompileDeviceOnly || CurPhase == phases::Backend) {
2395 ActionList DeviceActions;
2396 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2397 // Produce the device action from the current phase up to the assemble
2398 // phase.
2399 for (auto Ph : Phases) {
2400 // Skip the phases that were already dealt with.
2401 if (Ph < CurPhase)
2402 continue;
2403 // We have to be consistent with the host final phase.
2404 if (Ph > FinalPhase)
2405 break;
2406
2407 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
Artem Belevichecb178b2018-03-21 22:22:59 +00002408 C, Args, Ph, CudaDeviceActions[I], Action::OFK_Cuda);
Samuel Antao64e965e2016-09-30 15:34:19 +00002409
2410 if (Ph == phases::Assemble)
2411 break;
2412 }
2413
2414 // If we didn't reach the assemble phase, we can't generate the fat
2415 // binary. We don't need to generate the fat binary if we are not in
2416 // device-only mode.
2417 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
2418 CompileDeviceOnly)
2419 continue;
2420
2421 Action *AssembleAction = CudaDeviceActions[I];
2422 assert(AssembleAction->getType() == types::TY_Object);
2423 assert(AssembleAction->getInputs().size() == 1);
2424
2425 Action *BackendAction = AssembleAction->getInputs()[0];
2426 assert(BackendAction->getType() == types::TY_PP_Asm);
2427
2428 for (auto &A : {AssembleAction, BackendAction}) {
2429 OffloadAction::DeviceDependences DDep;
2430 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
2431 Action::OFK_Cuda);
2432 DeviceActions.push_back(
2433 C.MakeAction<OffloadAction>(DDep, A->getType()));
2434 }
2435 }
2436
2437 // We generate the fat binary if we have device input actions.
2438 if (!DeviceActions.empty()) {
2439 CudaFatBinary =
2440 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
2441
2442 if (!CompileDeviceOnly) {
2443 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2444 Action::OFK_Cuda);
2445 // Clear the fat binary, it is already a dependence to an host
2446 // action.
2447 CudaFatBinary = nullptr;
2448 }
2449
2450 // Remove the CUDA actions as they are already connected to an host
2451 // action or fat binary.
2452 CudaDeviceActions.clear();
2453 }
2454
2455 // We avoid creating host action in device-only mode.
2456 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Samuel Antao5b1a89a2016-10-27 00:53:34 +00002457 } else if (CurPhase > phases::Backend) {
2458 // If we are past the backend phase and still have a device action, we
2459 // don't have to do anything as this action is already a device
2460 // top-level action.
2461 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002462 }
2463
2464 assert(CurPhase < phases::Backend && "Generating single CUDA "
2465 "instructions should only occur "
2466 "before the backend phase!");
2467
2468 // By default, we produce an action for each device arch.
2469 for (Action *&A : CudaDeviceActions)
2470 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2471
2472 return ABRT_Success;
2473 }
Yaxun Liu3af038b2018-05-30 00:49:10 +00002474 };
2475 /// \brief HIP action builder. It injects device code in the host backend
2476 /// action.
2477 class HIPActionBuilder final : public CudaActionBuilderBase {
2478 /// The linker inputs obtained for each device arch.
2479 SmallVector<ActionList, 8> DeviceLinkerInputs;
Samuel Antao64e965e2016-09-30 15:34:19 +00002480
Yaxun Liu3af038b2018-05-30 00:49:10 +00002481 public:
2482 HIPActionBuilder(Compilation &C, DerivedArgList &Args,
2483 const Driver::InputList &Inputs)
2484 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_HIP) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002485
Yaxun Liu3af038b2018-05-30 00:49:10 +00002486 bool canUseBundlerUnbundler() const override { return true; }
Samuel Antao64e965e2016-09-30 15:34:19 +00002487
Yaxun Liu3af038b2018-05-30 00:49:10 +00002488 ActionBuilderReturnCode
2489 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2490 phases::ID CurPhase, phases::ID FinalPhase,
2491 PhasesTy &Phases) override {
2492 // amdgcn does not support linking of object files, therefore we skip
2493 // backend and assemble phases to output LLVM IR.
2494 if (CudaDeviceActions.empty() || CurPhase == phases::Backend ||
2495 CurPhase == phases::Assemble)
2496 return ABRT_Success;
2497
2498 assert((CurPhase == phases::Link ||
2499 CudaDeviceActions.size() == GpuArchList.size()) &&
2500 "Expecting one action per GPU architecture.");
2501 assert(!CompileHostOnly &&
2502 "Not expecting CUDA actions in host-only compilation.");
2503
2504 // Save CudaDeviceActions to DeviceLinkerInputs for each GPU subarch.
2505 // This happens to each device action originated from each input file.
2506 // Later on, device actions in DeviceLinkerInputs are used to create
2507 // device link actions in appendLinkDependences and the created device
2508 // link actions are passed to the offload action as device dependence.
2509 if (CurPhase == phases::Link) {
2510 DeviceLinkerInputs.resize(CudaDeviceActions.size());
2511 auto LI = DeviceLinkerInputs.begin();
2512 for (auto *A : CudaDeviceActions) {
2513 LI->push_back(A);
2514 ++LI;
Samuel Antao64e965e2016-09-30 15:34:19 +00002515 }
2516
Yaxun Liu3af038b2018-05-30 00:49:10 +00002517 // We will pass the device action as a host dependence, so we don't
2518 // need to do anything else with them.
2519 CudaDeviceActions.clear();
Samuel Antao64e965e2016-09-30 15:34:19 +00002520 return ABRT_Success;
2521 }
2522
Yaxun Liu3af038b2018-05-30 00:49:10 +00002523 // By default, we produce an action for each device arch.
2524 for (Action *&A : CudaDeviceActions)
2525 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A,
2526 AssociatedOffloadKind);
2527
2528 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002529 }
2530
Yaxun Liu3af038b2018-05-30 00:49:10 +00002531 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2532 // Append a new link action for each device.
2533 unsigned I = 0;
2534 for (auto &LI : DeviceLinkerInputs) {
2535 auto *DeviceLinkAction =
2536 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2537 DA.add(*DeviceLinkAction, *ToolChains[0],
2538 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2539 ++I;
Samuel Antao64e965e2016-09-30 15:34:19 +00002540 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002541 }
2542 };
2543
Samuel Antao28c4f182016-10-27 17:08:03 +00002544 /// OpenMP action builder. The host bitcode is passed to the device frontend
2545 /// and all the device linked images are passed to the host link phase.
2546 class OpenMPActionBuilder final : public DeviceActionBuilder {
2547 /// The OpenMP actions for the current input.
2548 ActionList OpenMPDeviceActions;
2549
2550 /// The linker inputs obtained for each toolchain.
2551 SmallVector<ActionList, 8> DeviceLinkerInputs;
2552
2553 public:
2554 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2555 const Driver::InputList &Inputs)
2556 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2557
2558 ActionBuilderReturnCode
2559 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2560 phases::ID CurPhase, phases::ID FinalPhase,
2561 PhasesTy &Phases) override {
2562
2563 // We should always have an action for each input.
2564 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2565 "Number of OpenMP actions and toolchains do not match.");
2566
2567 // The host only depends on device action in the linking phase, when all
2568 // the device images have to be embedded in the host image.
2569 if (CurPhase == phases::Link) {
2570 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2571 "Toolchains and linker inputs sizes do not match.");
2572 auto LI = DeviceLinkerInputs.begin();
2573 for (auto *A : OpenMPDeviceActions) {
2574 LI->push_back(A);
2575 ++LI;
2576 }
2577
2578 // We passed the device action as a host dependence, so we don't need to
2579 // do anything else with them.
2580 OpenMPDeviceActions.clear();
2581 return ABRT_Success;
2582 }
2583
2584 // By default, we produce an action for each device arch.
2585 for (Action *&A : OpenMPDeviceActions)
2586 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2587
2588 return ABRT_Success;
2589 }
2590
2591 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2592
2593 // If this is an input action replicate it for each OpenMP toolchain.
2594 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2595 OpenMPDeviceActions.clear();
2596 for (unsigned I = 0; I < ToolChains.size(); ++I)
2597 OpenMPDeviceActions.push_back(
2598 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2599 return ABRT_Success;
2600 }
2601
Samuel Antaofab4f372016-10-27 18:00:51 +00002602 // If this is an unbundling action use it as is for each OpenMP toolchain.
2603 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2604 OpenMPDeviceActions.clear();
2605 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2606 OpenMPDeviceActions.push_back(UA);
2607 UA->registerDependentActionInfo(
2608 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2609 }
2610 return ABRT_Success;
2611 }
2612
Samuel Antao28c4f182016-10-27 17:08:03 +00002613 // When generating code for OpenMP we use the host compile phase result as
2614 // a dependence to the device compile phase so that it can learn what
2615 // declarations should be emitted. However, this is not the only use for
2616 // the host action, so we prevent it from being collapsed.
2617 if (isa<CompileJobAction>(HostAction)) {
2618 HostAction->setCannotBeCollapsedWithNextDependentAction();
2619 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2620 "Toolchains and device action sizes do not match.");
2621 OffloadAction::HostDependence HDep(
2622 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2623 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2624 auto TC = ToolChains.begin();
2625 for (Action *&A : OpenMPDeviceActions) {
2626 assert(isa<CompileJobAction>(A));
2627 OffloadAction::DeviceDependences DDep;
2628 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2629 A = C.MakeAction<OffloadAction>(HDep, DDep);
2630 ++TC;
2631 }
2632 }
2633 return ABRT_Success;
2634 }
2635
Samuel Antao69d6f312016-10-27 17:50:43 +00002636 void appendTopLevelActions(ActionList &AL) override {
2637 if (OpenMPDeviceActions.empty())
2638 return;
2639
2640 // We should always have an action for each input.
2641 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2642 "Number of OpenMP actions and toolchains do not match.");
2643
2644 // Append all device actions followed by the proper offload action.
2645 auto TI = ToolChains.begin();
2646 for (auto *A : OpenMPDeviceActions) {
2647 OffloadAction::DeviceDependences Dep;
2648 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2649 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2650 ++TI;
2651 }
2652 // We no longer need the action stored in this builder.
2653 OpenMPDeviceActions.clear();
2654 }
2655
Samuel Antao28c4f182016-10-27 17:08:03 +00002656 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2657 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2658 "Toolchains and linker inputs sizes do not match.");
2659
2660 // Append a new link action for each device.
2661 auto TC = ToolChains.begin();
2662 for (auto &LI : DeviceLinkerInputs) {
2663 auto *DeviceLinkAction =
2664 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2665 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2666 Action::OFK_OpenMP);
2667 ++TC;
2668 }
2669 }
2670
2671 bool initialize() override {
2672 // Get the OpenMP toolchains. If we don't get any, the action builder will
2673 // know there is nothing to do related to OpenMP offloading.
2674 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2675 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2676 ++TI)
2677 ToolChains.push_back(TI->second);
2678
2679 DeviceLinkerInputs.resize(ToolChains.size());
2680 return false;
2681 }
Samuel Antao69d6f312016-10-27 17:50:43 +00002682
2683 bool canUseBundlerUnbundler() const override {
2684 // OpenMP should use bundled files whenever possible.
2685 return true;
2686 }
Samuel Antao28c4f182016-10-27 17:08:03 +00002687 };
2688
2689 ///
2690 /// TODO: Add the implementation for other specialized builders here.
2691 ///
Samuel Antao64e965e2016-09-30 15:34:19 +00002692
2693 /// Specialized builders being used by this offloading action builder.
2694 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2695
Samuel Antao69d6f312016-10-27 17:50:43 +00002696 /// Flag set to true if all valid builders allow file bundling/unbundling.
2697 bool CanUseBundler;
2698
Samuel Antao64e965e2016-09-30 15:34:19 +00002699public:
2700 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2701 const Driver::InputList &Inputs)
Samuel Antao10e905c2016-10-27 01:08:58 +00002702 : C(C) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002703 // Create a specialized builder for each device toolchain.
2704
2705 IsValid = true;
2706
2707 // Create a specialized builder for CUDA.
2708 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2709
Yaxun Liu3af038b2018-05-30 00:49:10 +00002710 // Create a specialized builder for HIP.
2711 SpecializedBuilders.push_back(new HIPActionBuilder(C, Args, Inputs));
2712
Samuel Antao28c4f182016-10-27 17:08:03 +00002713 // Create a specialized builder for OpenMP.
2714 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2715
Samuel Antao64e965e2016-09-30 15:34:19 +00002716 //
2717 // TODO: Build other specialized builders here.
2718 //
2719
Samuel Antao69d6f312016-10-27 17:50:43 +00002720 // Initialize all the builders, keeping track of errors. If all valid
2721 // builders agree that we can use bundling, set the flag to true.
2722 unsigned ValidBuilders = 0u;
2723 unsigned ValidBuildersSupportingBundling = 0u;
2724 for (auto *SB : SpecializedBuilders) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002725 IsValid = IsValid && !SB->initialize();
Samuel Antao69d6f312016-10-27 17:50:43 +00002726
2727 // Update the counters if the builder is valid.
2728 if (SB->isValid()) {
2729 ++ValidBuilders;
2730 if (SB->canUseBundlerUnbundler())
2731 ++ValidBuildersSupportingBundling;
2732 }
2733 }
2734 CanUseBundler =
2735 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
Artem Belevichf981e30b2016-08-02 22:37:47 +00002736 }
Justin Lebardc3c5042016-04-19 02:27:07 +00002737
Samuel Antao64e965e2016-09-30 15:34:19 +00002738 ~OffloadingActionBuilder() {
2739 for (auto *SB : SpecializedBuilders)
2740 delete SB;
Samuel Antaod06239d2016-07-15 23:13:27 +00002741 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002742
Samuel Antao64e965e2016-09-30 15:34:19 +00002743 /// Generate an action that adds device dependences (if any) to a host action.
2744 /// If no device dependence actions exist, just return the host action \a
2745 /// HostAction. If an error is found or if no builder requires the host action
2746 /// to be generated, return nullptr.
2747 Action *
2748 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2749 phases::ID CurPhase, phases::ID FinalPhase,
2750 DeviceActionBuilder::PhasesTy &Phases) {
2751 if (!IsValid)
2752 return nullptr;
Justin Lebar7bf77982016-01-11 23:27:13 +00002753
Samuel Antao64e965e2016-09-30 15:34:19 +00002754 if (SpecializedBuilders.empty())
2755 return HostAction;
2756
2757 assert(HostAction && "Invalid host action!");
2758
2759 OffloadAction::DeviceDependences DDeps;
2760 // Check if all the programming models agree we should not emit the host
2761 // action. Also, keep track of the offloading kinds employed.
2762 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2763 unsigned InactiveBuilders = 0u;
2764 unsigned IgnoringBuilders = 0u;
2765 for (auto *SB : SpecializedBuilders) {
2766 if (!SB->isValid()) {
2767 ++InactiveBuilders;
2768 continue;
2769 }
2770
Samuel Antao28c4f182016-10-27 17:08:03 +00002771 auto RetCode =
2772 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
Samuel Antao64e965e2016-09-30 15:34:19 +00002773
2774 // If the builder explicitly says the host action should be ignored,
2775 // we need to increment the variable that tracks the builders that request
2776 // the host object to be ignored.
2777 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2778 ++IgnoringBuilders;
2779
2780 // Unless the builder was inactive for this action, we have to record the
2781 // offload kind because the host will have to use it.
2782 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2783 OffloadKind |= SB->getAssociatedOffloadKind();
2784 }
2785
2786 // If all builders agree that the host object should be ignored, just return
2787 // nullptr.
2788 if (IgnoringBuilders &&
2789 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2790 return nullptr;
2791
2792 if (DDeps.getActions().empty())
2793 return HostAction;
2794
2795 // We have dependences we need to bundle together. We use an offload action
2796 // for that.
2797 OffloadAction::HostDependence HDep(
2798 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2799 /*BoundArch=*/nullptr, DDeps);
2800 return C.MakeAction<OffloadAction>(HDep, DDeps);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002801 }
2802
Samuel Antao64e965e2016-09-30 15:34:19 +00002803 /// Generate an action that adds a host dependence to a device action. The
2804 /// results will be kept in this action builder. Return true if an error was
2805 /// found.
Samuel Antaofab4f372016-10-27 18:00:51 +00002806 bool addHostDependenceToDeviceActions(Action *&HostAction,
Samuel Antao64e965e2016-09-30 15:34:19 +00002807 const Arg *InputArg) {
2808 if (!IsValid)
2809 return true;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002810
Samuel Antaofab4f372016-10-27 18:00:51 +00002811 // If we are supporting bundling/unbundling and the current action is an
2812 // input action of non-source file, we replace the host action by the
2813 // unbundling action. The bundler tool has the logic to detect if an input
2814 // is a bundle or not and if the input is not a bundle it assumes it is a
2815 // host file. Therefore it is safe to create an unbundling action even if
2816 // the input is not a bundle.
2817 if (CanUseBundler && isa<InputAction>(HostAction) &&
2818 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
2819 !types::isSrcFile(HostAction->getType())) {
2820 auto UnbundlingHostAction =
2821 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
2822 UnbundlingHostAction->registerDependentActionInfo(
2823 C.getSingleOffloadToolChain<Action::OFK_Host>(),
Yaxun Liuf37b50a2018-07-24 01:03:44 +00002824 /*BoundArch=*/StringRef(), Action::OFK_Host);
Samuel Antaofab4f372016-10-27 18:00:51 +00002825 HostAction = UnbundlingHostAction;
2826 }
2827
Samuel Antao64e965e2016-09-30 15:34:19 +00002828 assert(HostAction && "Invalid host action!");
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002829
Samuel Antao64e965e2016-09-30 15:34:19 +00002830 // Register the offload kinds that are used.
2831 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2832 for (auto *SB : SpecializedBuilders) {
2833 if (!SB->isValid())
2834 continue;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002835
Samuel Antao64e965e2016-09-30 15:34:19 +00002836 auto RetCode = SB->addDeviceDepences(HostAction);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002837
Samuel Antao64e965e2016-09-30 15:34:19 +00002838 // Host dependences for device actions are not compatible with that same
2839 // action being ignored.
2840 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
2841 "Host dependence not expected to be ignored.!");
Samuel Antaod06239d2016-07-15 23:13:27 +00002842
Samuel Antao64e965e2016-09-30 15:34:19 +00002843 // Unless the builder was inactive for this action, we have to record the
2844 // offload kind because the host will have to use it.
2845 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2846 OffloadKind |= SB->getAssociatedOffloadKind();
2847 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002848
Samuel Antao64e965e2016-09-30 15:34:19 +00002849 return false;
2850 }
2851
Samuel Antao69d6f312016-10-27 17:50:43 +00002852 /// Add the offloading top level actions to the provided action list. This
2853 /// function can replace the host action by a bundling action if the
2854 /// programming models allow it.
Samuel Antao64e965e2016-09-30 15:34:19 +00002855 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
2856 const Arg *InputArg) {
Samuel Antao69d6f312016-10-27 17:50:43 +00002857 // Get the device actions to be appended.
2858 ActionList OffloadAL;
Samuel Antao64e965e2016-09-30 15:34:19 +00002859 for (auto *SB : SpecializedBuilders) {
2860 if (!SB->isValid())
2861 continue;
Samuel Antao69d6f312016-10-27 17:50:43 +00002862 SB->appendTopLevelActions(OffloadAL);
Samuel Antao64e965e2016-09-30 15:34:19 +00002863 }
2864
Samuel Antao69d6f312016-10-27 17:50:43 +00002865 // If we can use the bundler, replace the host action by the bundling one in
2866 // the resulting list. Otherwise, just append the device actions.
2867 if (CanUseBundler && !OffloadAL.empty()) {
2868 // Add the host action to the list in order to create the bundling action.
2869 OffloadAL.push_back(HostAction);
2870
2871 // We expect that the host action was just appended to the action list
2872 // before this method was called.
2873 assert(HostAction == AL.back() && "Host action not in the list??");
2874 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
2875 AL.back() = HostAction;
2876 } else
2877 AL.append(OffloadAL.begin(), OffloadAL.end());
2878
Samuel Antao64e965e2016-09-30 15:34:19 +00002879 // Propagate to the current host action (if any) the offload information
2880 // associated with the current input.
2881 if (HostAction)
2882 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
2883 /*BoundArch=*/nullptr);
Samuel Antao64e965e2016-09-30 15:34:19 +00002884 return false;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002885 }
Artem Belevich5bde4e02015-07-20 20:02:54 +00002886
Samuel Antao64e965e2016-09-30 15:34:19 +00002887 /// Processes the host linker action. This currently consists of replacing it
2888 /// with an offload action if there are device link objects and propagate to
2889 /// the host action all the offload kinds used in the current compilation. The
2890 /// resulting action is returned.
2891 Action *processHostLinkAction(Action *HostAction) {
2892 // Add all the dependences from the device linking actions.
2893 OffloadAction::DeviceDependences DDeps;
2894 for (auto *SB : SpecializedBuilders) {
2895 if (!SB->isValid())
2896 continue;
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002897
Samuel Antao64e965e2016-09-30 15:34:19 +00002898 SB->appendLinkDependences(DDeps);
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002899 }
Samuel Antaod06239d2016-07-15 23:13:27 +00002900
Samuel Antao64e965e2016-09-30 15:34:19 +00002901 // Calculate all the offload kinds used in the current compilation.
2902 unsigned ActiveOffloadKinds = 0u;
2903 for (auto &I : InputArgToOffloadKindMap)
2904 ActiveOffloadKinds |= I.second;
2905
2906 // If we don't have device dependencies, we don't have to create an offload
2907 // action.
2908 if (DDeps.getActions().empty()) {
2909 // Propagate all the active kinds to host action. Given that it is a link
2910 // action it is assumed to depend on all actions generated so far.
2911 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
2912 /*BoundArch=*/nullptr);
2913 return HostAction;
2914 }
2915
2916 // Create the offload action with all dependences. When an offload action
2917 // is created the kinds are propagated to the host action, so we don't have
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002918 // to do that explicitly here.
Samuel Antao64e965e2016-09-30 15:34:19 +00002919 OffloadAction::HostDependence HDep(
2920 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2921 /*BoundArch*/ nullptr, ActiveOffloadKinds);
2922 return C.MakeAction<OffloadAction>(HDep, DDeps);
2923 }
2924};
2925} // anonymous namespace.
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002926
Justin Lebar0f3474c2016-02-11 02:00:50 +00002927void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
2928 const InputList &Inputs, ActionList &Actions) const {
Chad Rosierecdede82011-08-12 22:08:57 +00002929 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002930
Daniel Dunbar34c41872009-03-13 00:17:48 +00002931 if (!SuppressMissingInputWarning && Inputs.empty()) {
Daniel Dunbarbfeec742009-03-12 23:55:14 +00002932 Diag(clang::diag::err_drv_no_input_files);
2933 return;
2934 }
2935
Chad Rosier7742b5d2011-07-27 23:36:45 +00002936 Arg *FinalPhaseArg;
2937 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00002938
Bob Haarmanaaf51912017-02-27 19:40:19 +00002939 if (FinalPhase == phases::Link) {
2940 if (Args.hasArg(options::OPT_emit_llvm))
2941 Diag(clang::diag::err_drv_emit_llvm_link);
2942 if (IsCLMode() && LTOMode != LTOK_None &&
2943 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
2944 Diag(clang::diag::err_drv_lto_without_lld);
Rafael Espindolae8025642013-08-25 14:27:09 +00002945 }
2946
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002947 // Reject -Z* at the top level, these options should never have been exposed
2948 // by gcc.
Daniel Dunbardd765242009-03-26 16:12:09 +00002949 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
Daniel Dunbar0e759942009-03-20 06:14:23 +00002950 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00002951
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002952 // Diagnose misuse of /Fo.
2953 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002954 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00002955 if (Inputs.size() > 1 && !V.empty() &&
2956 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002957 // Check whether /Fo tries to name an output file for multiple inputs.
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002958 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002959 << A->getSpelling() << V;
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002960 Args.eraseArg(options::OPT__SLASH_Fo);
2961 }
2962 }
2963
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002964 // Diagnose misuse of /Fa.
2965 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
2966 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00002967 if (Inputs.size() > 1 && !V.empty() &&
2968 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002969 // Check whether /Fa tries to name an asm file for multiple inputs.
2970 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002971 << A->getSpelling() << V;
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002972 Args.eraseArg(options::OPT__SLASH_Fa);
2973 }
2974 }
2975
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00002976 // Diagnose misuse of /o.
2977 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
2978 if (A->getValue()[0] == '\0') {
2979 // It has to have a value.
2980 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
2981 Args.eraseArg(options::OPT__SLASH_o);
2982 }
2983 }
2984
Mike Rice58df1af2018-09-11 17:10:44 +00002985 // Ignore /Yc/Yu if both /Yc and /Yu passed but with different filenames.
Nico Weber2ca4be92016-03-01 23:16:44 +00002986 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
2987 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
Nico Weber2ca4be92016-03-01 23:16:44 +00002988 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
2989 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
2990 Args.eraseArg(options::OPT__SLASH_Yc);
2991 Args.eraseArg(options::OPT__SLASH_Yu);
2992 YcArg = YuArg = nullptr;
2993 }
Nico Weber2ca4be92016-03-01 23:16:44 +00002994 if (YcArg && Inputs.size() > 1) {
2995 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
2996 Args.eraseArg(options::OPT__SLASH_Yc);
2997 YcArg = nullptr;
2998 }
Erich Keaneeaca3882018-08-17 13:43:39 +00002999 if (FinalPhase == phases::Preprocess || Args.hasArg(options::OPT__SLASH_Y_)) {
3000 // If only preprocessing or /Y- is used, all pch handling is disabled.
3001 // Rather than check for it everywhere, just remove clang-cl pch-related
3002 // flags here.
Nico Weber2ca4be92016-03-01 23:16:44 +00003003 Args.eraseArg(options::OPT__SLASH_Fp);
3004 Args.eraseArg(options::OPT__SLASH_Yc);
3005 Args.eraseArg(options::OPT__SLASH_Yu);
3006 YcArg = YuArg = nullptr;
3007 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003008
Samuel Antao64e965e2016-09-30 15:34:19 +00003009 // Builder to be used to build offloading actions.
3010 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
Samuel Antaod06239d2016-07-15 23:13:27 +00003011
Daniel Dunbar65229332009-03-13 11:38:42 +00003012 // Construct the actions to perform.
3013 ActionList LinkerInputs;
Alp Toker965f8822013-11-27 05:22:15 +00003014
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003015 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
Artem Belevich5bde4e02015-07-20 20:02:54 +00003016 for (auto &I : Inputs) {
3017 types::ID InputType = I.first;
3018 const Arg *InputArg = I.second;
Daniel Dunbar65229332009-03-13 11:38:42 +00003019
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003020 PL.clear();
3021 types::getCompilationPhases(InputType, PL);
Daniel Dunbar65229332009-03-13 11:38:42 +00003022
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003023 // If the first step comes after the final phase we are doing as part of
3024 // this compilation, warn the user about it.
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003025 phases::ID InitialPhase = PL[0];
Daniel Dunbar65229332009-03-13 11:38:42 +00003026 if (InitialPhase > FinalPhase) {
Martin Storsjo665c7a42018-05-04 06:05:58 +00003027 if (InputArg->isClaimed())
3028 continue;
3029
Daniel Dunbaradc5c7c2009-03-19 07:57:08 +00003030 // Claim here to avoid the more general unused warning.
3031 InputArg->claim();
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003032
Daniel Dunbar2db3e732011-04-20 15:44:48 +00003033 // Suppress all unused style warnings with -Qunused-arguments
3034 if (Args.hasArg(options::OPT_Qunused_arguments))
3035 continue;
3036
Richard Smith403f76e2012-08-06 04:09:06 +00003037 // Special case when final phase determined by binary name, rather than
3038 // by a command-line argument with a corresponding Arg.
Hans Wennborg70850d82013-07-18 20:29:38 +00003039 if (CCCIsCPP())
Richard Smith403f76e2012-08-06 04:09:06 +00003040 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003041 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003042 // Special case '-E' warning on a previously preprocessed file to make
3043 // more sense.
Richard Smith403f76e2012-08-06 04:09:06 +00003044 else if (InitialPhase == phases::Compile &&
3045 FinalPhase == phases::Preprocess &&
3046 getPreprocessedType(InputType) == types::TY_INVALID)
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003047 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003048 << InputArg->getAsString(Args) << !!FinalPhaseArg
3049 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003050 else
3051 Diag(clang::diag::warn_drv_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003052 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
3053 << !!FinalPhaseArg
3054 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar65229332009-03-13 11:38:42 +00003055 continue;
3056 }
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003057
Nico Weberad2d8f32016-04-21 19:59:10 +00003058 if (YcArg) {
3059 // Add a separate precompile phase for the compile phase.
3060 if (FinalPhase >= phases::Compile) {
Richard Smith8cd452d2016-08-30 18:55:16 +00003061 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003062 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
Richard Smith8cd452d2016-08-30 18:55:16 +00003063 types::getCompilationPhases(HeaderType, PCHPL);
Nico Weberad2d8f32016-04-21 19:59:10 +00003064 // Build the pipeline for the pch file.
Richard Smith8cd452d2016-08-30 18:55:16 +00003065 Action *ClangClPch =
Erich Keane76675de2018-07-05 17:22:13 +00003066 C.MakeAction<InputAction>(*InputArg, HeaderType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003067 for (phases::ID Phase : PCHPL)
3068 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
3069 assert(ClangClPch);
3070 Actions.push_back(ClangClPch);
3071 // The driver currently exits after the first failed command. This
3072 // relies on that behavior, to make sure if the pch generation fails,
3073 // the main compilation won't run.
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00003074 // FIXME: If the main compilation fails, the PCH generation should
3075 // probably not be considered successful either.
Nico Weberad2d8f32016-04-21 19:59:10 +00003076 }
3077 }
3078
Daniel Dunbar65229332009-03-13 11:38:42 +00003079 // Build the pipeline for this file.
Justin Lebar41094612016-01-11 23:07:27 +00003080 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
Samuel Antao64e965e2016-09-30 15:34:19 +00003081
3082 // Use the current host action in any of the offloading actions, if
3083 // required.
3084 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3085 break;
3086
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003087 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
3088 i != e; ++i) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003089 phases::ID Phase = *i;
Daniel Dunbar65229332009-03-13 11:38:42 +00003090
3091 // We are done if this step is past what the user requested.
3092 if (Phase > FinalPhase)
3093 break;
3094
Samuel Antao64e965e2016-09-30 15:34:19 +00003095 // Add any offload action the host action depends on.
3096 Current = OffloadBuilder.addDeviceDependencesToHostAction(
3097 Current, InputArg, Phase, FinalPhase, PL);
3098 if (!Current)
3099 break;
3100
Daniel Dunbar65229332009-03-13 11:38:42 +00003101 // Queue linker inputs.
3102 if (Phase == phases::Link) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003103 assert((i + 1) == e && "linking must be final compilation step.");
Justin Lebar41094612016-01-11 23:07:27 +00003104 LinkerInputs.push_back(Current);
3105 Current = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003106 break;
3107 }
3108
Samuel Antao64e965e2016-09-30 15:34:19 +00003109 // Otherwise construct the appropriate action.
3110 auto *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
3111
3112 // We didn't create a new action, so we will just move to the next phase.
3113 if (NewCurrent == Current)
Daniel Dunbar13864952009-03-24 20:17:30 +00003114 continue;
3115
Samuel Antao64e965e2016-09-30 15:34:19 +00003116 Current = NewCurrent;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003117
Samuel Antao64e965e2016-09-30 15:34:19 +00003118 // Use the current host action in any of the offloading actions, if
3119 // required.
3120 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3121 break;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003122
Daniel Dunbar65229332009-03-13 11:38:42 +00003123 if (Current->getType() == types::TY_Nothing)
3124 break;
3125 }
3126
Samuel Antao64e965e2016-09-30 15:34:19 +00003127 // If we ended with something, add to the output list.
3128 if (Current)
Justin Lebar41094612016-01-11 23:07:27 +00003129 Actions.push_back(Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003130
3131 // Add any top level actions generated for offloading.
3132 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003133 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003134
Samuel Antao64e965e2016-09-30 15:34:19 +00003135 // Add a link action if necessary.
Samuel Antaod06239d2016-07-15 23:13:27 +00003136 if (!LinkerInputs.empty()) {
Samuel Antao64e965e2016-09-30 15:34:19 +00003137 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
3138 LA = OffloadBuilder.processHostLinkAction(LA);
3139 Actions.push_back(LA);
Samuel Antaod06239d2016-07-15 23:13:27 +00003140 }
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003141
3142 // If we are linking, claim any options which are obviously only used for
3143 // compilation.
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003144 if (FinalPhase == phases::Link && PL.size() == 1) {
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003145 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003146 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
3147 }
3148
3149 // Claim ignored clang-cl options.
3150 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
Artem Belevichbaae0932015-07-28 21:01:30 +00003151
Justin Lebardc3c5042016-04-19 02:27:07 +00003152 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
3153 // to non-CUDA compilations and should not trigger warnings there.
Artem Belevichbaae0932015-07-28 21:01:30 +00003154 Args.ClaimAllArgs(options::OPT_cuda_host_only);
Justin Lebardc3c5042016-04-19 02:27:07 +00003155 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
Daniel Dunbar65229332009-03-13 11:38:42 +00003156}
3157
Artem Belevichecb178b2018-03-21 22:22:59 +00003158Action *Driver::ConstructPhaseAction(
3159 Compilation &C, const ArgList &Args, phases::ID Phase, Action *Input,
3160 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003161 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
Samuel Antao64e965e2016-09-30 15:34:19 +00003162
3163 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
3164 // encode this in the steps because the intermediate type depends on
3165 // arguments. Just special case here.
3166 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
3167 return Input;
3168
Daniel Dunbar65229332009-03-13 11:38:42 +00003169 // Build the appropriate action.
3170 switch (Phase) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003171 case phases::Link:
3172 llvm_unreachable("link action invalid here.");
Daniel Dunbar65229332009-03-13 11:38:42 +00003173 case phases::Preprocess: {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003174 types::ID OutputTy;
3175 // -{M, MM} alter the output type.
Daniel Dunbar86aed7d2010-12-08 21:33:40 +00003176 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003177 OutputTy = types::TY_Dependencies;
3178 } else {
David Blaikie5d577a22012-06-29 22:03:56 +00003179 OutputTy = Input->getType();
3180 if (!Args.hasFlag(options::OPT_frewrite_includes,
Justin Bognerce8245b2014-06-24 08:01:01 +00003181 options::OPT_fno_rewrite_includes, false) &&
Richard Smith86a3ef52017-06-09 21:24:02 +00003182 !Args.hasFlag(options::OPT_frewrite_imports,
3183 options::OPT_fno_rewrite_imports, false) &&
Justin Bognerce8245b2014-06-24 08:01:01 +00003184 !CCGenDiagnostics)
David Blaikie5d577a22012-06-29 22:03:56 +00003185 OutputTy = types::getPreprocessedType(OutputTy);
Daniel Dunbard67a3222009-03-30 06:36:42 +00003186 assert(OutputTy != types::TY_INVALID &&
3187 "Cannot preprocess this input type!");
3188 }
Justin Lebar41094612016-01-11 23:07:27 +00003189 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
Daniel Dunbar65229332009-03-13 11:38:42 +00003190 }
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003191 case phases::Precompile: {
Richard Smithdd4ad3d2016-08-30 19:06:26 +00003192 types::ID OutputTy = getPrecompiledType(Input->getType());
3193 assert(OutputTy != types::TY_INVALID &&
3194 "Cannot precompile this input type!");
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003195 if (Args.hasArg(options::OPT_fsyntax_only)) {
3196 // Syntax checks should not emit a PCH file
3197 OutputTy = types::TY_Nothing;
3198 }
Justin Lebar41094612016-01-11 23:07:27 +00003199 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003200 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003201 case phases::Compile: {
David Blaikie486f4402014-08-29 07:25:23 +00003202 if (Args.hasArg(options::OPT_fsyntax_only))
Justin Lebar41094612016-01-11 23:07:27 +00003203 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
David Blaikie486f4402014-08-29 07:25:23 +00003204 if (Args.hasArg(options::OPT_rewrite_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003205 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003206 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003207 return C.MakeAction<CompileJobAction>(Input,
3208 types::TY_RewrittenLegacyObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003209 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
Justin Lebar41094612016-01-11 23:07:27 +00003210 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
David Blaikie486f4402014-08-29 07:25:23 +00003211 if (Args.hasArg(options::OPT__migrate))
Justin Lebar41094612016-01-11 23:07:27 +00003212 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
David Blaikie486f4402014-08-29 07:25:23 +00003213 if (Args.hasArg(options::OPT_emit_ast))
Justin Lebar41094612016-01-11 23:07:27 +00003214 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
David Blaikie486f4402014-08-29 07:25:23 +00003215 if (Args.hasArg(options::OPT_module_file_info))
Justin Lebar41094612016-01-11 23:07:27 +00003216 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
David Blaikie486f4402014-08-29 07:25:23 +00003217 if (Args.hasArg(options::OPT_verify_pch))
Justin Lebar41094612016-01-11 23:07:27 +00003218 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
3219 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
Bob Wilson23a55f12014-12-21 07:00:00 +00003220 }
3221 case phases::Backend: {
Artem Belevichecb178b2018-03-21 22:22:59 +00003222 if (isUsingLTO() && TargetDeviceOffloadKind == Action::OFK_None) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003223 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003224 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003225 return C.MakeAction<BackendJobAction>(Input, Output);
David Blaikie486f4402014-08-29 07:25:23 +00003226 }
3227 if (Args.hasArg(options::OPT_emit_llvm)) {
Shuxin Yang4b3c7ff2013-08-23 21:34:57 +00003228 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003229 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003230 return C.MakeAction<BackendJobAction>(Input, Output);
Daniel Dunbar65229332009-03-13 11:38:42 +00003231 }
Justin Lebar41094612016-01-11 23:07:27 +00003232 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
Daniel Dunbar65229332009-03-13 11:38:42 +00003233 }
3234 case phases::Assemble:
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003235 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
Daniel Dunbar65229332009-03-13 11:38:42 +00003236 }
3237
David Blaikie83d382b2011-09-23 05:06:16 +00003238 llvm_unreachable("invalid phase in ConstructPhaseAction");
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003239}
3240
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00003241void Driver::BuildJobs(Compilation &C) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003242 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003243
3244 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3245
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003246 // It is an error to provide a -o option if we are making multiple output
3247 // files.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003248 if (FinalOutput) {
3249 unsigned NumOutputs = 0;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003250 for (const Action *A : C.getActions())
3251 if (A->getType() != types::TY_Nothing)
Daniel Dunbare75d8342009-03-16 06:56:51 +00003252 ++NumOutputs;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003253
Daniel Dunbare75d8342009-03-16 06:56:51 +00003254 if (NumOutputs > 1) {
3255 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
Craig Topper92fc2df2014-05-17 16:56:41 +00003256 FinalOutput = nullptr;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003257 }
3258 }
3259
Chad Rosier35767232013-04-30 22:01:21 +00003260 // Collect the list of architectures.
3261 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003262 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
3263 for (const Arg *A : C.getArgs())
Chad Rosier35767232013-04-30 22:01:21 +00003264 if (A->getOption().matches(options::OPT_arch))
3265 ArchNames.insert(A->getValue());
Chad Rosier35767232013-04-30 22:01:21 +00003266
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003267 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
3268 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003269 for (Action *A : C.getActions()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003270 // If we are linking an image for multiple archs then the linker wants
3271 // -arch_multiple and -final_output <final image name>. Unfortunately, this
3272 // doesn't fit in cleanly because we have to pass this information down.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003273 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003274 // FIXME: This is a hack; find a cleaner way to integrate this into the
3275 // process.
Craig Topper92fc2df2014-05-17 16:56:41 +00003276 const char *LinkingOutput = nullptr;
Daniel Dunbardd765242009-03-26 16:12:09 +00003277 if (isa<LipoJobAction>(A)) {
Daniel Dunbare75d8342009-03-16 06:56:51 +00003278 if (FinalOutput)
Richard Smithbd55daf2012-11-01 04:30:05 +00003279 LinkingOutput = FinalOutput->getValue();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003280 else
Hans Wennborga7707222015-01-09 17:38:53 +00003281 LinkingOutput = getDefaultImageName();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003282 }
3283
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003284 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003285 /*BoundArch*/ StringRef(),
Daniel Dunbare75d8342009-03-16 06:56:51 +00003286 /*AtTopLevel*/ true,
Chad Rosier35767232013-04-30 22:01:21 +00003287 /*MultipleArchs*/ ArchNames.size() > 1,
Samuel Antaod06239d2016-07-15 23:13:27 +00003288 /*LinkingOutput*/ LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003289 /*TargetDeviceOffloadKind*/ Action::OFK_None);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003290 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003291
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003292 // If the user passed -Qunused-arguments or there were errors, don't warn
3293 // about any unused arguments.
Argyrios Kyrtzidis31448a42010-11-18 21:47:07 +00003294 if (Diags.hasErrorOccurred() ||
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003295 C.getArgs().hasArg(options::OPT_Qunused_arguments))
Daniel Dunbard175d972009-03-18 18:03:46 +00003296 return;
3297
Daniel Dunbar58399ae2009-03-29 22:24:54 +00003298 // Claim -### here.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003299 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003300
Nico Weber47bf5052016-04-25 21:15:49 +00003301 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003302 (void)C.getArgs().hasArg(options::OPT_driver_mode);
Nico Weber47bf5052016-04-25 21:15:49 +00003303 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
Hans Wennborg70850d82013-07-18 20:29:38 +00003304
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003305 for (Arg *A : C.getArgs()) {
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003306 // FIXME: It would be nice to be able to send the argument to the
David Blaikie9c902b52011-09-25 23:23:43 +00003307 // DiagnosticsEngine, so that extra values, position, and so on could be
3308 // printed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003309 if (!A->isClaimed()) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +00003310 if (A->getOption().hasFlag(options::NoArgumentUnused))
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003311 continue;
3312
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003313 // Suppress the warning automatically if this is just a flag, and it is an
3314 // instance of an argument we already claimed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003315 const Option &Opt = A->getOption();
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00003316 if (Opt.getKind() == Option::FlagClass) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003317 bool DuplicateClaimed = false;
3318
Sean Silva14facf32015-06-09 01:57:17 +00003319 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
3320 if (AA->isClaimed()) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003321 DuplicateClaimed = true;
3322 break;
3323 }
3324 }
3325
3326 if (DuplicateClaimed)
3327 continue;
3328 }
3329
Ehsan Akhgarid8518332016-01-25 21:14:52 +00003330 // In clang-cl, don't mention unknown arguments here since they have
3331 // already been warned about.
3332 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
3333 Diag(clang::diag::warn_drv_unused_argument)
3334 << A->getAsString(C.getArgs());
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003335 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003336 }
Daniel Dunbar95e6b192009-03-13 22:12:33 +00003337}
Daniel Dunbarc4343942010-02-03 03:07:56 +00003338
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003339namespace {
3340/// Utility class to control the collapse of dependent actions and select the
3341/// tools accordingly.
3342class ToolSelector final {
3343 /// The tool chain this selector refers to.
3344 const ToolChain &TC;
Daniel Dunbarf9ff3502010-05-14 02:03:00 +00003345
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003346 /// The compilation this selector refers to.
3347 const Compilation &C;
Samuel Antaod06239d2016-07-15 23:13:27 +00003348
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003349 /// The base action this selector refers to.
3350 const JobAction *BaseAction;
Samuel Antaod06239d2016-07-15 23:13:27 +00003351
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003352 /// Set to true if the current toolchain refers to host actions.
3353 bool IsHostSelector;
Samuel Antaod06239d2016-07-15 23:13:27 +00003354
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003355 /// Set to true if save-temps and embed-bitcode functionalities are active.
3356 bool SaveTemps;
3357 bool EmbedBitcode;
3358
3359 /// Get previous dependent action or null if that does not exist. If
3360 /// \a CanBeCollapsed is false, that action must be legal to collapse or
3361 /// null will be returned.
3362 const JobAction *getPrevDependentAction(const ActionList &Inputs,
3363 ActionList &SavedOffloadAction,
3364 bool CanBeCollapsed = true) {
3365 // An option can be collapsed only if it has a single input.
3366 if (Inputs.size() != 1)
Craig Topper92fc2df2014-05-17 16:56:41 +00003367 return nullptr;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003368
3369 Action *CurAction = *Inputs.begin();
3370 if (CanBeCollapsed &&
3371 !CurAction->isCollapsingWithNextDependentActionLegal())
3372 return nullptr;
3373
3374 // If the input action is an offload action. Look through it and save any
3375 // offload action that can be dropped in the event of a collapse.
3376 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
3377 // If the dependent action is a device action, we will attempt to collapse
3378 // only with other device actions. Otherwise, we would do the same but
3379 // with host actions only.
3380 if (!IsHostSelector) {
3381 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
3382 CurAction =
3383 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
3384 if (CanBeCollapsed &&
3385 !CurAction->isCollapsingWithNextDependentActionLegal())
3386 return nullptr;
3387 SavedOffloadAction.push_back(OA);
3388 return dyn_cast<JobAction>(CurAction);
3389 }
3390 } else if (OA->hasHostDependence()) {
3391 CurAction = OA->getHostDependence();
3392 if (CanBeCollapsed &&
3393 !CurAction->isCollapsingWithNextDependentActionLegal())
3394 return nullptr;
3395 SavedOffloadAction.push_back(OA);
3396 return dyn_cast<JobAction>(CurAction);
3397 }
3398 return nullptr;
3399 }
3400
3401 return dyn_cast<JobAction>(CurAction);
3402 }
3403
3404 /// Return true if an assemble action can be collapsed.
3405 bool canCollapseAssembleAction() const {
3406 return TC.useIntegratedAs() && !SaveTemps &&
3407 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
3408 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
3409 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
3410 }
3411
3412 /// Return true if a preprocessor action can be collapsed.
3413 bool canCollapsePreprocessorAction() const {
3414 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
3415 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
3416 !C.getArgs().hasArg(options::OPT_rewrite_objc);
3417 }
3418
3419 /// Struct that relates an action with the offload actions that would be
3420 /// collapsed with it.
3421 struct JobActionInfo final {
3422 /// The action this info refers to.
3423 const JobAction *JA = nullptr;
3424 /// The offload actions we need to take care off if this action is
3425 /// collapsed.
3426 ActionList SavedOffloadAction;
3427 };
3428
3429 /// Append collapsed offload actions from the give nnumber of elements in the
3430 /// action info array.
3431 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
3432 ArrayRef<JobActionInfo> &ActionInfo,
3433 unsigned ElementNum) {
3434 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
3435 for (unsigned I = 0; I < ElementNum; ++I)
3436 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
3437 ActionInfo[I].SavedOffloadAction.end());
3438 }
3439
3440 /// Functions that attempt to perform the combining. They detect if that is
3441 /// legal, and if so they update the inputs \a Inputs and the offload action
3442 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
3443 /// the combined action is returned. If the combining is not legal or if the
3444 /// tool does not exist, null is returned.
3445 /// Currently three kinds of collapsing are supported:
3446 /// - Assemble + Backend + Compile;
3447 /// - Assemble + Backend ;
3448 /// - Backend + Compile.
3449 const Tool *
3450 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
3451 const ActionList *&Inputs,
3452 ActionList &CollapsedOffloadAction) {
3453 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
3454 return nullptr;
3455 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3456 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3457 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
3458 if (!AJ || !BJ || !CJ)
3459 return nullptr;
3460
3461 // Get compiler tool.
3462 const Tool *T = TC.SelectTool(*CJ);
3463 if (!T)
3464 return nullptr;
3465
Steven Wu574b0f22016-03-01 01:07:58 +00003466 // When using -fembed-bitcode, it is required to have the same tool (clang)
3467 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
3468 if (EmbedBitcode) {
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003469 const Tool *BT = TC.SelectTool(*BJ);
3470 if (BT == T)
3471 return nullptr;
Steven Wu574b0f22016-03-01 01:07:58 +00003472 }
Bob Wilson23a55f12014-12-21 07:00:00 +00003473
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003474 if (!T->hasIntegratedAssembler())
Bob Wilson23a55f12014-12-21 07:00:00 +00003475 return nullptr;
Samuel Antaod06239d2016-07-15 23:13:27 +00003476
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003477 Inputs = &CJ->getInputs();
3478 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3479 /*NumElements=*/3);
3480 return T;
3481 }
3482 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
3483 const ActionList *&Inputs,
3484 ActionList &CollapsedOffloadAction) {
3485 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
3486 return nullptr;
3487 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3488 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3489 if (!AJ || !BJ)
3490 return nullptr;
3491
3492 // Retrieve the compile job, backend action must always be preceded by one.
3493 ActionList CompileJobOffloadActions;
3494 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
3495 /*CanBeCollapsed=*/false);
3496 if (!AJ || !BJ || !CJ)
3497 return nullptr;
3498
3499 assert(isa<CompileJobAction>(CJ) &&
3500 "Expecting compile job preceding backend job.");
3501
3502 // Get compiler tool.
3503 const Tool *T = TC.SelectTool(*CJ);
3504 if (!T)
3505 return nullptr;
3506
3507 if (!T->hasIntegratedAssembler())
3508 return nullptr;
3509
3510 Inputs = &BJ->getInputs();
3511 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3512 /*NumElements=*/2);
3513 return T;
3514 }
3515 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
3516 const ActionList *&Inputs,
3517 ActionList &CollapsedOffloadAction) {
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003518 if (ActionInfo.size() < 2)
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003519 return nullptr;
3520 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3521 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3522 if (!BJ || !CJ)
3523 return nullptr;
3524
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003525 // Check if the initial input (to the compile job or its predessor if one
3526 // exists) is LLVM bitcode. In that case, no preprocessor step is required
3527 // and we can still collapse the compile and backend jobs when we have
3528 // -save-temps. I.e. there is no need for a separate compile job just to
3529 // emit unoptimized bitcode.
3530 bool InputIsBitcode = true;
3531 for (size_t i = 1; i < ActionInfo.size(); i++)
3532 if (ActionInfo[i].JA->getType() != types::TY_LLVM_BC &&
3533 ActionInfo[i].JA->getType() != types::TY_LTO_BC) {
3534 InputIsBitcode = false;
3535 break;
3536 }
3537 if (!InputIsBitcode && !canCollapsePreprocessorAction())
3538 return nullptr;
3539
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003540 // Get compiler tool.
3541 const Tool *T = TC.SelectTool(*CJ);
3542 if (!T)
3543 return nullptr;
3544
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003545 if (T->canEmitIR() && ((SaveTemps && !InputIsBitcode) || EmbedBitcode))
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003546 return nullptr;
3547
3548 Inputs = &CJ->getInputs();
3549 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3550 /*NumElements=*/2);
3551 return T;
3552 }
3553
3554 /// Updates the inputs if the obtained tool supports combining with
3555 /// preprocessor action, and the current input is indeed a preprocessor
3556 /// action. If combining results in the collapse of offloading actions, those
3557 /// are appended to \a CollapsedOffloadAction.
3558 void combineWithPreprocessor(const Tool *T, const ActionList *&Inputs,
3559 ActionList &CollapsedOffloadAction) {
3560 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3561 return;
3562
3563 // Attempt to get a preprocessor action dependence.
3564 ActionList PreprocessJobOffloadActions;
3565 auto *PJ = getPrevDependentAction(*Inputs, PreprocessJobOffloadActions);
3566 if (!PJ || !isa<PreprocessJobAction>(PJ))
3567 return;
3568
3569 // This is legal to combine. Append any offload action we found and set the
3570 // current inputs to preprocessor inputs.
3571 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3572 PreprocessJobOffloadActions.end());
3573 Inputs = &PJ->getInputs();
3574 }
3575
3576public:
3577 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3578 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3579 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3580 EmbedBitcode(EmbedBitcode) {
3581 assert(BaseAction && "Invalid base action.");
3582 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3583 }
3584
3585 /// Check if a chain of actions can be combined and return the tool that can
3586 /// handle the combination of actions. The pointer to the current inputs \a
3587 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3588 /// connected to collapsed actions are updated accordingly. The latter enables
3589 /// the caller of the selector to process them afterwards instead of just
3590 /// dropping them. If no suitable tool is found, null will be returned.
3591 const Tool *getTool(const ActionList *&Inputs,
3592 ActionList &CollapsedOffloadAction) {
3593 //
3594 // Get the largest chain of actions that we could combine.
3595 //
3596
3597 SmallVector<JobActionInfo, 5> ActionChain(1);
3598 ActionChain.back().JA = BaseAction;
3599 while (ActionChain.back().JA) {
3600 const Action *CurAction = ActionChain.back().JA;
3601
3602 // Grow the chain by one element.
3603 ActionChain.resize(ActionChain.size() + 1);
3604 JobActionInfo &AI = ActionChain.back();
3605
3606 // Attempt to fill it with the
3607 AI.JA =
3608 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
Daniel Dunbarc4343942010-02-03 03:07:56 +00003609 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003610
3611 // Pop the last action info as it could not be filled.
3612 ActionChain.pop_back();
3613
3614 //
3615 // Attempt to combine actions. If all combining attempts failed, just return
3616 // the tool of the provided action. At the end we attempt to combine the
3617 // action with any preprocessor action it may depend on.
3618 //
3619
3620 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3621 CollapsedOffloadAction);
3622 if (!T)
3623 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3624 if (!T)
3625 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3626 if (!T) {
3627 Inputs = &BaseAction->getInputs();
3628 T = TC.SelectTool(*BaseAction);
3629 }
3630
3631 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3632 return T;
Daniel Dunbarc4343942010-02-03 03:07:56 +00003633 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003634};
Daniel Dunbarc4343942010-02-03 03:07:56 +00003635}
3636
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003637/// Return a string that uniquely identifies the result of a job. The bound arch
3638/// is not necessarily represented in the toolchain's triple -- for example,
3639/// armv7 and armv7s both map to the same triple -- so we need both in our map.
3640/// Also, we need to add the offloading device kind, as the same tool chain can
3641/// be used for host and device for some programming models, e.g. OpenMP.
3642static std::string GetTriplePlusArchString(const ToolChain *TC,
3643 StringRef BoundArch,
3644 Action::OffloadKind OffloadKind) {
Justin Lebar55c83322016-01-16 03:30:08 +00003645 std::string TriplePlusArch = TC->getTriple().normalize();
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003646 if (!BoundArch.empty()) {
Justin Lebar55c83322016-01-16 03:30:08 +00003647 TriplePlusArch += "-";
3648 TriplePlusArch += BoundArch;
3649 }
Samuel Antao59efaed2016-10-27 17:31:22 +00003650 TriplePlusArch += "-";
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003651 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3652 return TriplePlusArch;
3653}
3654
3655InputInfo Driver::BuildJobsForAction(
3656 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3657 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3658 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3659 Action::OffloadKind TargetDeviceOffloadKind) const {
3660 std::pair<const Action *, std::string> ActionTC = {
3661 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003662 auto CachedResult = CachedResults.find(ActionTC);
3663 if (CachedResult != CachedResults.end()) {
3664 return CachedResult->second;
3665 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003666 InputInfo Result = BuildJobsForActionNoCache(
3667 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003668 CachedResults, TargetDeviceOffloadKind);
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003669 CachedResults[ActionTC] = Result;
3670 return Result;
3671}
3672
3673InputInfo Driver::BuildJobsForActionNoCache(
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003674 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003675 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
Samuel Antaod06239d2016-07-15 23:13:27 +00003676 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003677 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003678 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbarc4acf9d2009-03-18 23:18:19 +00003679
Samuel Antaod06239d2016-07-15 23:13:27 +00003680 InputInfoList OffloadDependencesInputInfo;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003681 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
Samuel Antaod06239d2016-07-15 23:13:27 +00003682 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
Alex Lorenz4003a982017-08-08 11:22:21 +00003683 // The 'Darwin' toolchain is initialized only when its arguments are
3684 // computed. Get the default arguments for OFK_None to ensure that
3685 // initialization is performed before processing the offload action.
3686 // FIXME: Remove when darwin's toolchain is initialized during construction.
3687 C.getArgsForToolChain(TC, BoundArch, Action::OFK_None);
3688
Samuel Antaod06239d2016-07-15 23:13:27 +00003689 // The offload action is expected to be used in four different situations.
3690 //
3691 // a) Set a toolchain/architecture/kind for a host action:
3692 // Host Action 1 -> OffloadAction -> Host Action 2
3693 //
3694 // b) Set a toolchain/architecture/kind for a device action;
3695 // Device Action 1 -> OffloadAction -> Device Action 2
3696 //
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003697 // c) Specify a device dependence to a host action;
Samuel Antaod06239d2016-07-15 23:13:27 +00003698 // Device Action 1 _
3699 // \
3700 // Host Action 1 ---> OffloadAction -> Host Action 2
3701 //
3702 // d) Specify a host dependence to a device action.
3703 // Host Action 1 _
3704 // \
3705 // Device Action 1 ---> OffloadAction -> Device Action 2
3706 //
3707 // For a) and b), we just return the job generated for the dependence. For
3708 // c) and d) we override the current action with the host/device dependence
3709 // if the current toolchain is host/device and set the offload dependences
3710 // info with the jobs obtained from the device/host dependence(s).
3711
3712 // If there is a single device option, just generate the job for it.
3713 if (OA->hasSingleDeviceDependence()) {
3714 InputInfo DevA;
3715 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3716 const char *DepBoundArch) {
3717 DevA =
3718 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3719 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003720 CachedResults, DepA->getOffloadingDeviceKind());
Samuel Antaod06239d2016-07-15 23:13:27 +00003721 });
3722 return DevA;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003723 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003724
3725 // If 'Action 2' is host, we generate jobs for the device dependences and
3726 // override the current action with the host dependence. Otherwise, we
3727 // generate the host dependences and override the action with the device
3728 // dependence. The dependences can't therefore be a top-level action.
3729 OA->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003730 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003731 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3732 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3733 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3734 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003735 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003736 });
3737
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003738 A = BuildingForOffloadDevice
Samuel Antaod06239d2016-07-15 23:13:27 +00003739 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3740 : OA->getHostDependence();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003741 }
3742
Daniel Dunbare75d8342009-03-16 06:56:51 +00003743 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003744 // FIXME: It would be nice to not claim this here; maybe the old scheme of
3745 // just using Args was better?
Daniel Dunbar5cdf3e02009-03-19 07:29:38 +00003746 const Arg &Input = IA->getInputArg();
3747 Input.claim();
Daniel Dunbar35cbfeb2010-06-09 22:31:08 +00003748 if (Input.getOption().matches(options::OPT_INPUT)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00003749 const char *Name = Input.getValue();
Justin Lebard98cea82016-01-11 23:15:21 +00003750 return InputInfo(A, Name, /* BaseInput = */ Name);
Douglas Katzman678d0cb2015-06-16 18:01:24 +00003751 }
Justin Lebard98cea82016-01-11 23:15:21 +00003752 return InputInfo(A, &Input, /* BaseInput = */ "");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003753 }
3754
3755 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003756 const ToolChain *TC;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003757 StringRef ArchName = BAA->getArchName();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003758
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003759 if (!ArchName.empty())
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003760 TC = &getToolChain(C.getArgs(),
Petr Hosekdd38d932018-05-29 22:35:39 +00003761 computeTargetTriple(*this, TargetTriple,
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003762 C.getArgs(), ArchName));
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003763 else
3764 TC = &C.getDefaultToolChain();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003765
Nico Weber5a459f82016-02-23 19:30:43 +00003766 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00003767 MultipleArchs, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003768 TargetDeviceOffloadKind);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003769 }
3770
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003771
Daniel Dunbare75d8342009-03-16 06:56:51 +00003772 const ActionList *Inputs = &A->getInputs();
Daniel Dunbarc4343942010-02-03 03:07:56 +00003773
3774 const JobAction *JA = cast<JobAction>(A);
Samuel Antaod06239d2016-07-15 23:13:27 +00003775 ActionList CollapsedOffloadActions;
3776
Mehdi Amini6683e222017-01-24 18:12:25 +00003777 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
3778 embedBitcodeInObject() && !isUsingLTO());
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003779 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
3780
Rafael Espindola79764462013-03-24 15:06:53 +00003781 if (!T)
Justin Lebar9eaa4892016-01-11 23:09:32 +00003782 return InputInfo();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003783
Samuel Antaod06239d2016-07-15 23:13:27 +00003784 // If we've collapsed action list that contained OffloadAction we
3785 // need to build jobs for host/device-side inputs it may have held.
3786 for (const auto *OA : CollapsedOffloadActions)
3787 cast<OffloadAction>(OA)->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003788 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003789 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3790 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
Artem Belevichbee2f412016-08-22 18:50:34 +00003791 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
Samuel Antaod06239d2016-07-15 23:13:27 +00003792 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003793 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003794 });
Artem Belevichf8144ab2015-08-27 18:10:41 +00003795
Daniel Dunbare75d8342009-03-16 06:56:51 +00003796 // Only use pipes when there is exactly one input.
Daniel Dunbar1a093d22009-03-18 06:00:36 +00003797 InputInfoList InputInfos;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003798 for (const Action *Input : *Inputs) {
Eric Christopher14668dd2013-02-18 00:38:25 +00003799 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
3800 // shouldn't get temporary output names.
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003801 // FIXME: Clean this up.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003802 bool SubJobAtTopLevel =
3803 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
Samuel Antaod06239d2016-07-15 23:13:27 +00003804 InputInfos.push_back(BuildJobsForAction(
3805 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003806 CachedResults, A->getOffloadingDeviceKind()));
Daniel Dunbare75d8342009-03-16 06:56:51 +00003807 }
3808
Daniel Dunbare75d8342009-03-16 06:56:51 +00003809 // Always use the first input as the base input.
3810 const char *BaseInput = InputInfos[0].getBaseInput();
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003811
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003812 // ... except dsymutil actions, which use their actual input as the base
3813 // input.
3814 if (JA->getType() == types::TY_dSYM)
3815 BaseInput = InputInfos[0].getFilename();
3816
Samuel Antaod06239d2016-07-15 23:13:27 +00003817 // Append outputs of offload device jobs to the input list
3818 if (!OffloadDependencesInputInfo.empty())
3819 InputInfos.append(OffloadDependencesInputInfo.begin(),
3820 OffloadDependencesInputInfo.end());
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003821
Vedant Kumar18286cf2016-07-27 23:02:20 +00003822 // Set the effective triple of the toolchain for the duration of this job.
3823 llvm::Triple EffectiveTriple;
3824 const ToolChain &ToolTC = T->getToolChain();
Samuel Antao31fef982016-10-27 17:39:44 +00003825 const ArgList &Args =
3826 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
Vedant Kumar18286cf2016-07-27 23:02:20 +00003827 if (InputInfos.size() != 1) {
3828 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
3829 } else {
3830 // Pass along the input type if it can be unambiguously determined.
3831 EffectiveTriple = llvm::Triple(
3832 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
3833 }
3834 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
3835
Daniel Dunbard00272f2010-08-02 02:38:15 +00003836 // Determine the place to write output to, if any.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003837 InputInfo Result;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003838 InputInfoList UnbundlingResults;
3839 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
3840 // If we have an unbundling job, we need to create results for all the
3841 // outputs. We also update the results cache so that other actions using
3842 // this unbundling action can get the right results.
3843 for (auto &UI : UA->getDependentActionsInfo()) {
3844 assert(UI.DependentOffloadKind != Action::OFK_None &&
3845 "Unbundling with no offloading??");
3846
3847 // Unbundling actions are never at the top level. When we generate the
3848 // offloading prefix, we also do that for the host file because the
3849 // unbundling action does not change the type of the output which can
3850 // cause a overwrite.
3851 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3852 UI.DependentOffloadKind,
3853 UI.DependentToolChain->getTriple().normalize(),
3854 /*CreatePrefixForHost=*/true);
3855 auto CurI = InputInfo(
Yaxun Liu609f7522018-05-11 19:02:18 +00003856 UA,
3857 GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
3858 /*AtTopLevel=*/false,
3859 MultipleArchs ||
3860 UI.DependentOffloadKind == Action::OFK_HIP,
3861 OffloadingPrefix),
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003862 BaseInput);
3863 // Save the unbundling result.
3864 UnbundlingResults.push_back(CurI);
3865
3866 // Get the unique string identifier for this dependence and cache the
3867 // result.
Yaxun Liu470b8332018-06-06 19:44:10 +00003868 StringRef Arch;
3869 if (TargetDeviceOffloadKind == Action::OFK_HIP) {
3870 if (UI.DependentOffloadKind == Action::OFK_Host)
Yaxun Liuf37b50a2018-07-24 01:03:44 +00003871 Arch = StringRef();
Yaxun Liu470b8332018-06-06 19:44:10 +00003872 else
3873 Arch = UI.DependentBoundArch;
3874 } else
3875 Arch = BoundArch;
3876
3877 CachedResults[{A, GetTriplePlusArchString(UI.DependentToolChain, Arch,
3878 UI.DependentOffloadKind)}] =
3879 CurI;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003880 }
3881
3882 // Now that we have all the results generated, select the one that should be
3883 // returned for the current depending action.
3884 std::pair<const Action *, std::string> ActionTC = {
3885 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
3886 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
3887 "Result does not exist??");
3888 Result = CachedResults[ActionTC];
3889 } else if (JA->getType() == types::TY_Nothing)
Justin Lebard98cea82016-01-11 23:15:21 +00003890 Result = InputInfo(A, BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003891 else {
3892 // We only have to generate a prefix for the host if this is not a top-level
3893 // action.
3894 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3895 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
3896 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
3897 !AtTopLevel);
Justin Lebard98cea82016-01-11 23:15:21 +00003898 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
Samuel Antaod06239d2016-07-15 23:13:27 +00003899 AtTopLevel, MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003900 OffloadingPrefix),
Justin Lebard98cea82016-01-11 23:15:21 +00003901 BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003902 }
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003903
Chad Rosierbe10f982011-08-02 17:58:04 +00003904 if (CCCPrintBindings && !CCGenDiagnostics) {
Rafael Espindola79764462013-03-24 15:06:53 +00003905 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
3906 << " - \"" << T->getName() << "\", inputs: [";
Daniel Dunbarb39cc522009-03-17 22:47:06 +00003907 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
3908 llvm::errs() << InputInfos[i].getAsString();
3909 if (i + 1 != e)
3910 llvm::errs() << ", ";
3911 }
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003912 if (UnbundlingResults.empty())
3913 llvm::errs() << "], output: " << Result.getAsString() << "\n";
3914 else {
3915 llvm::errs() << "], outputs: [";
3916 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
3917 llvm::errs() << UnbundlingResults[i].getAsString();
3918 if (i + 1 != e)
3919 llvm::errs() << ", ";
3920 }
3921 llvm::errs() << "] \n";
3922 }
Daniel Dunbarb39cc522009-03-17 22:47:06 +00003923 } else {
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003924 if (UnbundlingResults.empty())
3925 T->ConstructJob(
3926 C, *JA, Result, InputInfos,
3927 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3928 LinkingOutput);
3929 else
Samuel Antao7108bf32016-11-03 15:41:50 +00003930 T->ConstructJobMultipleOutputs(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003931 C, *JA, UnbundlingResults, InputInfos,
3932 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3933 LinkingOutput);
Daniel Dunbarb39cc522009-03-17 22:47:06 +00003934 }
Justin Lebar9eaa4892016-01-11 23:09:32 +00003935 return Result;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003936}
3937
Hans Wennborga7707222015-01-09 17:38:53 +00003938const char *Driver::getDefaultImageName() const {
Petr Hosekdd38d932018-05-29 22:35:39 +00003939 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Hans Wennborga7707222015-01-09 17:38:53 +00003940 return Target.isOSWindows() ? "a.exe" : "a.out";
3941}
3942
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003943/// Create output filename based on ArgValue, which could either be a
Hans Wennborg2c21f742013-10-17 16:16:23 +00003944/// full filename, filename without extension, or a directory. If ArgValue
3945/// does not provide a filename, then use BaseName, and use the extension
3946/// suitable for FileType.
Hans Wennborg207fcf02013-08-12 21:56:42 +00003947static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003948 StringRef BaseName,
3949 types::ID FileType) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00003950 SmallString<128> Filename = ArgValue;
Justin Bogner5aaf2e72014-06-26 20:59:36 +00003951
Hans Wennborgf1a74252013-09-10 20:18:04 +00003952 if (ArgValue.empty()) {
3953 // If the argument is empty, output to BaseName in the current dir.
3954 Filename = BaseName;
3955 } else if (llvm::sys::path::is_separator(Filename.back())) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00003956 // If the argument is a directory, output to BaseName in that dir.
3957 llvm::sys::path::append(Filename, BaseName);
3958 }
3959
3960 if (!llvm::sys::path::has_extension(ArgValue)) {
3961 // If the argument didn't provide an extension, then set it.
3962 const char *Extension = types::getTypeTempSuffix(FileType, true);
Hans Wennborgf1a74252013-09-10 20:18:04 +00003963
3964 if (FileType == types::TY_Image &&
3965 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
3966 // The output file is a dll.
3967 Extension = "dll";
3968 }
3969
Hans Wennborg207fcf02013-08-12 21:56:42 +00003970 llvm::sys::path::replace_extension(Filename, Extension);
3971 }
3972
3973 return Args.MakeArgString(Filename.c_str());
3974}
3975
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003976const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003977 const char *BaseInput,
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003978 StringRef BoundArch, bool AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00003979 bool MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003980 StringRef OffloadingPrefix) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003981 llvm::PrettyStackTraceString CrashInfo("Computing output path");
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003982 // Output to a user requested destination?
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003983 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003984 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
Chad Rosier633dcdc2013-01-24 19:14:47 +00003985 return C.addResultFile(FinalOutput->getValue(), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003986 }
3987
Hans Wennborge0053472013-12-20 18:40:46 +00003988 // For /P, preprocess to file named after BaseInput.
3989 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
3990 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
3991 StringRef BaseName = llvm::sys::path::filename(BaseInput);
Hans Wennborg04c764f2014-06-17 00:19:12 +00003992 StringRef NameArg;
Greg Bedwell065f70a2015-06-09 10:24:06 +00003993 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
Hans Wennborg04c764f2014-06-17 00:19:12 +00003994 NameArg = A->getValue();
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003995 return C.addResultFile(
3996 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
3997 &JA);
Hans Wennborge0053472013-12-20 18:40:46 +00003998 }
3999
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004000 // Default to writing to stdout?
David Blaikiebc023c92018-06-14 23:09:06 +00004001 if (AtTopLevel && !CCGenDiagnostics && isa<PreprocessJobAction>(JA))
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004002 return "-";
4003
Hans Wennborg2c21f742013-10-17 16:16:23 +00004004 // Is this the assembly listing for /FA?
4005 if (JA.getType() == types::TY_PP_Asm &&
4006 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
4007 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
4008 // Use /Fa and the input filename to determine the asm file name.
4009 StringRef BaseName = llvm::sys::path::filename(BaseInput);
4010 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004011 return C.addResultFile(
4012 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
4013 &JA);
Hans Wennborg2c21f742013-10-17 16:16:23 +00004014 }
4015
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004016 // Output to a temporary file?
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004017 if ((!AtTopLevel && !isSaveTempsEnabled() &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004018 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
Chad Rosierbe10f982011-08-02 17:58:04 +00004019 CCGenDiagnostics) {
Chad Rosier97c37372011-08-26 22:27:02 +00004020 StringRef Name = llvm::sys::path::filename(BaseInput);
4021 std::pair<StringRef, StringRef> Split = Name.split('.');
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004022 SmallString<128> TmpName;
4023 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
4024 Arg *A = C.getArgs().getLastArg(options::OPT_fcrash_diagnostics_dir);
4025 if (CCGenDiagnostics && A) {
4026 SmallString<128> CrashDirectory(A->getValue());
4027 llvm::sys::path::append(CrashDirectory, Split.first);
4028 const char *Middle = Suffix ? "-%%%%%%." : "-%%%%%%";
4029 std::error_code EC =
4030 llvm::sys::fs::createUniqueFile(CrashDirectory + Middle + Suffix, TmpName);
4031 if (EC) {
4032 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4033 return "";
4034 }
4035 } else {
4036 TmpName = GetTemporaryPath(Split.first, Suffix);
4037 }
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004038 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004039 }
4040
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004041 SmallString<128> BasePath(BaseInput);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004042 StringRef BaseName;
Daniel Dunbar67fea712011-03-25 18:16:51 +00004043
4044 // Dsymutil actions should use the full path.
Eric Christopher551ef452011-08-23 17:56:55 +00004045 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
Daniel Dunbar67fea712011-03-25 18:16:51 +00004046 BaseName = BasePath;
4047 else
4048 BaseName = llvm::sys::path::filename(BasePath);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004049
4050 // Determine what the derived output name should be.
4051 const char *NamedOutput;
Hans Wennborg2b89a262013-08-06 22:11:28 +00004052
Hans Wennborg625fba82016-10-04 21:01:04 +00004053 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004054 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
4055 // The /Fo or /o flag decides the object filename.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004056 StringRef Val =
4057 C.getArgs()
4058 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
4059 ->getValue();
4060 NamedOutput =
4061 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
Hans Wennborg207fcf02013-08-12 21:56:42 +00004062 } else if (JA.getType() == types::TY_Image &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004063 C.getArgs().hasArg(options::OPT__SLASH_Fe,
4064 options::OPT__SLASH_o)) {
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004065 // The /Fe or /o flag names the linked file.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004066 StringRef Val =
4067 C.getArgs()
4068 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
4069 ->getValue();
4070 NamedOutput =
4071 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004072 } else if (JA.getType() == types::TY_Image) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004073 if (IsCLMode()) {
4074 // clang-cl uses BaseName for the executable name.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004075 NamedOutput =
4076 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
Samuel Antao59efaed2016-10-27 17:31:22 +00004077 } else {
Hans Wennborga7707222015-01-09 17:38:53 +00004078 SmallString<128> Output(getDefaultImageName());
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004079 Output += OffloadingPrefix;
Samuel Antao59efaed2016-10-27 17:31:22 +00004080 if (MultipleArchs && !BoundArch.empty()) {
4081 Output += "-";
4082 Output.append(BoundArch);
4083 }
Chad Rosier35767232013-04-30 22:01:21 +00004084 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
Nico Weber2ca4be92016-03-01 23:16:44 +00004085 }
4086 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004087 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004088 } else {
Hans Wennborg0a096a02013-09-05 17:05:56 +00004089 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004090 assert(Suffix && "All types used for output should have a suffix.");
4091
4092 std::string::size_type End = std::string::npos;
4093 if (!types::appendSuffixForType(JA.getType()))
4094 End = BaseName.rfind('.');
Chad Rosier35767232013-04-30 22:01:21 +00004095 SmallString<128> Suffixed(BaseName.substr(0, End));
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004096 Suffixed += OffloadingPrefix;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004097 if (MultipleArchs && !BoundArch.empty()) {
Chad Rosier35767232013-04-30 22:01:21 +00004098 Suffixed += "-";
4099 Suffixed.append(BoundArch);
4100 }
Bob Wilson23a55f12014-12-21 07:00:00 +00004101 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
4102 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
4103 // optimized bitcode output.
4104 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
4105 JA.getType() == types::TY_LLVM_BC)
4106 Suffixed += ".tmp";
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004107 Suffixed += '.';
4108 Suffixed += Suffix;
4109 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
4110 }
4111
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004112 // Prepend object file path if -save-temps=obj
4113 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
4114 JA.getType() != types::TY_PCH) {
4115 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
4116 SmallString<128> TempPath(FinalOutput->getValue());
4117 llvm::sys::path::remove_filename(TempPath);
4118 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
4119 llvm::sys::path::append(TempPath, OutputFileName);
4120 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
4121 }
4122
Chad Rosier62135492012-07-09 17:31:28 +00004123 // If we're saving temps and the temp file conflicts with the input file,
Chad Rosier5b58af02012-04-20 20:05:08 +00004124 // then avoid overwriting input file.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004125 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
Chad Rosier5b58af02012-04-20 20:05:08 +00004126 bool SameFile = false;
4127 SmallString<256> Result;
4128 llvm::sys::fs::current_path(Result);
4129 llvm::sys::path::append(Result, BaseName);
4130 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
4131 // Must share the same path to conflict.
4132 if (SameFile) {
4133 StringRef Name = llvm::sys::path::filename(BaseInput);
4134 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004135 std::string TmpName = GetTemporaryPath(
4136 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004137 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Chad Rosier5b58af02012-04-20 20:05:08 +00004138 }
Chad Rosierf8412cd2011-07-15 21:54:29 +00004139 }
4140
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004141 // As an annoying special case, PCH generation doesn't strip the pathname.
Nico Weber8ab92192016-03-02 23:29:29 +00004142 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
Michael J. Spencere1696752010-12-18 00:19:12 +00004143 llvm::sys::path::remove_filename(BasePath);
4144 if (BasePath.empty())
Daniel Dunbare6c83192009-03-18 09:58:30 +00004145 BasePath = NamedOutput;
4146 else
Michael J. Spencere1696752010-12-18 00:19:12 +00004147 llvm::sys::path::append(BasePath, NamedOutput);
Chad Rosier633dcdc2013-01-24 19:14:47 +00004148 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004149 } else {
Chad Rosier633dcdc2013-01-24 19:14:47 +00004150 return C.addResultFile(NamedOutput, &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004151 }
4152}
4153
Mehdi Amini12011172016-10-06 05:11:48 +00004154std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
Petr Hosek8f2499f2018-09-12 03:26:10 +00004155 // Seach for Name in a list of paths.
4156 auto SearchPaths = [&](const llvm::SmallVectorImpl<std::string> &P)
4157 -> llvm::Optional<std::string> {
4158 // Respect a limited subset of the '-Bprefix' functionality in GCC by
4159 // attempting to use this prefix when looking for file paths.
4160 for (const auto &Dir : P) {
4161 if (Dir.empty())
4162 continue;
4163 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
4164 llvm::sys::path::append(P, Name);
4165 if (llvm::sys::fs::exists(Twine(P)))
4166 return {P.str()};
4167 }
4168 return None;
4169 };
4170
4171 if (auto P = SearchPaths(PrefixDirs))
4172 return *P;
Chandler Carruth84559242010-03-22 01:52:07 +00004173
Petr Hosek916a4672017-08-10 04:16:38 +00004174 SmallString<128> R(ResourceDir);
4175 llvm::sys::path::append(R, Name);
4176 if (llvm::sys::fs::exists(Twine(R)))
4177 return R.str();
4178
4179 SmallString<128> P(TC.getCompilerRTPath());
Rafael Espindola609a6642013-06-24 18:33:43 +00004180 llvm::sys::path::append(P, Name);
4181 if (llvm::sys::fs::exists(Twine(P)))
Peter Collingbournefa9771f2011-09-06 02:08:31 +00004182 return P.str();
4183
Petr Hosek8f2499f2018-09-12 03:26:10 +00004184 if (auto P = SearchPaths(TC.getLibraryPaths()))
4185 return *P;
4186
4187 if (auto P = SearchPaths(TC.getFilePaths()))
4188 return *P;
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004189
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004190 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004191}
4192
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004193void Driver::generatePrefixedToolNames(
Mehdi Amini12011172016-10-06 05:11:48 +00004194 StringRef Tool, const ToolChain &TC,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004195 SmallVectorImpl<std::string> &Names) const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004196 // FIXME: Needs a better variable than TargetTriple
4197 Names.emplace_back((TargetTriple + "-" + Tool).str());
Benjamin Kramer3204b152015-05-29 19:42:19 +00004198 Names.emplace_back(Tool);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004199
4200 // Allow the discovery of tools prefixed with LLVM's default target triple.
Petr Hosekdd38d932018-05-29 22:35:39 +00004201 std::string DefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
4202 if (DefaultTargetTriple != TargetTriple)
4203 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004204}
4205
Benjamin Kramer7111b912014-11-04 20:26:01 +00004206static bool ScanDirForExecutable(SmallString<128> &Dir,
4207 ArrayRef<std::string> Names) {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004208 for (const auto &Name : Names) {
4209 llvm::sys::path::append(Dir, Name);
4210 if (llvm::sys::fs::can_execute(Twine(Dir)))
4211 return true;
4212 llvm::sys::path::remove_filename(Dir);
4213 }
4214 return false;
4215}
4216
Mehdi Amini12011172016-10-06 05:11:48 +00004217std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004218 SmallVector<std::string, 2> TargetSpecificExecutables;
4219 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
4220
Chandler Carruth84559242010-03-22 01:52:07 +00004221 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00004222 // attempting to use this prefix when looking for program paths.
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004223 for (const auto &PrefixDir : PrefixDirs) {
4224 if (llvm::sys::fs::is_directory(PrefixDir)) {
4225 SmallString<128> P(PrefixDir);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004226 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004227 return P.str();
Simon Atanasyana47ba292012-10-31 14:39:28 +00004228 } else {
Mehdi Amini12011172016-10-06 05:11:48 +00004229 SmallString<128> P((PrefixDir + Name).str());
Rafael Espindola609a6642013-06-24 18:33:43 +00004230 if (llvm::sys::fs::can_execute(Twine(P)))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004231 return P.str();
Simon Atanasyan86bdab72012-10-31 12:01:53 +00004232 }
Chandler Carruth84559242010-03-22 01:52:07 +00004233 }
4234
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004235 const ToolChain::path_list &List = TC.getProgramPaths();
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004236 for (const auto &Path : List) {
4237 SmallString<128> P(Path);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004238 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004239 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004240 }
4241
Daniel Dunbar76ce7412009-03-23 16:15:50 +00004242 // If all else failed, search the path.
Michael J. Spencerb011d482014-11-07 21:30:32 +00004243 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
4244 if (llvm::ErrorOr<std::string> P =
4245 llvm::sys::findProgramByName(TargetSpecificExecutable))
Michael J. Spencer04162ea2014-11-04 01:30:55 +00004246 return *P;
Daniel Dunbar6f668772009-03-18 21:34:08 +00004247
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004248 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004249}
4250
Mehdi Amini12011172016-10-06 05:11:48 +00004251std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
Rafael Espindola37d229d2013-06-25 04:26:55 +00004252 SmallString<128> Path;
Rafael Espindolac0809172014-06-12 14:02:15 +00004253 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
Rafael Espindola37d229d2013-06-25 04:26:55 +00004254 if (EC) {
4255 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004256 return "";
4257 }
4258
Rafael Espindola37d229d2013-06-25 04:26:55 +00004259 return Path.str();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004260}
4261
Nico Weber2ca4be92016-03-01 23:16:44 +00004262std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
4263 SmallString<128> Output;
4264 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
4265 // FIXME: If anybody needs it, implement this obscure rule:
4266 // "If you specify a directory without a file name, the default file name
4267 // is VCx0.pch., where x is the major version of Visual C++ in use."
4268 Output = FpArg->getValue();
4269
4270 // "If you do not specify an extension as part of the path name, an
4271 // extension of .pch is assumed. "
4272 if (!llvm::sys::path::has_extension(Output))
4273 Output += ".pch";
4274 } else {
Mike Rice58df1af2018-09-11 17:10:44 +00004275 if (Arg *YcArg = C.getArgs().getLastArg(options::OPT__SLASH_Yc))
4276 Output = YcArg->getValue();
4277 if (Output.empty())
4278 Output = BaseName;
Nico Weber2ca4be92016-03-01 23:16:44 +00004279 llvm::sys::path::replace_extension(Output, ".pch");
4280 }
4281 return Output.str();
4282}
4283
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004284const ToolChain &Driver::getToolChain(const ArgList &Args,
Artem Belevich959e0542015-07-10 19:47:55 +00004285 const llvm::Triple &Target) const {
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004286
David Blaikie6ad71012017-01-13 18:53:43 +00004287 auto &TC = ToolChains[Target.str()];
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004288 if (!TC) {
4289 switch (Target.getOS()) {
Reid Kleckner330fb172016-05-11 16:19:05 +00004290 case llvm::Triple::Haiku:
David Blaikie6ad71012017-01-13 18:53:43 +00004291 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
Reid Kleckner330fb172016-05-11 16:19:05 +00004292 break;
Ed Schouten4dabea22017-06-25 08:29:09 +00004293 case llvm::Triple::Ananas:
4294 TC = llvm::make_unique<toolchains::Ananas>(*this, Target, Args);
4295 break;
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004296 case llvm::Triple::CloudABI:
David Blaikie6ad71012017-01-13 18:53:43 +00004297 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004298 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004299 case llvm::Triple::Darwin:
4300 case llvm::Triple::MacOSX:
4301 case llvm::Triple::IOS:
Tim Northover6f3ff222015-10-30 16:30:27 +00004302 case llvm::Triple::TvOS:
4303 case llvm::Triple::WatchOS:
David Blaikie6ad71012017-01-13 18:53:43 +00004304 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004305 break;
4306 case llvm::Triple::DragonFly:
David Blaikie6ad71012017-01-13 18:53:43 +00004307 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004308 break;
4309 case llvm::Triple::OpenBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004310 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004311 break;
4312 case llvm::Triple::NetBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004313 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004314 break;
4315 case llvm::Triple::FreeBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004316 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004317 break;
4318 case llvm::Triple::Minix:
David Blaikie6ad71012017-01-13 18:53:43 +00004319 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004320 break;
4321 case llvm::Triple::Linux:
Andrey Turetskiy4798eb62016-06-16 10:36:09 +00004322 case llvm::Triple::ELFIAMCU:
Chandler Carruthcf705b22012-01-25 21:03:58 +00004323 if (Target.getArch() == llvm::Triple::hexagon)
David Blaikie6ad71012017-01-13 18:53:43 +00004324 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4325 Args);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004326 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
4327 !Target.hasEnvironment())
David Blaikie6ad71012017-01-13 18:53:43 +00004328 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
4329 Args);
Chandler Carruthcf705b22012-01-25 21:03:58 +00004330 else
David Blaikie6ad71012017-01-13 18:53:43 +00004331 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004332 break;
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004333 case llvm::Triple::NaCl:
David Blaikie6ad71012017-01-13 18:53:43 +00004334 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004335 break;
Petr Hosek62e1d232016-10-06 06:08:09 +00004336 case llvm::Triple::Fuchsia:
David Blaikie6ad71012017-01-13 18:53:43 +00004337 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
Petr Hosek62e1d232016-10-06 06:08:09 +00004338 break;
David Chisnallf571cde2012-02-15 13:39:01 +00004339 case llvm::Triple::Solaris:
David Blaikie6ad71012017-01-13 18:53:43 +00004340 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
David Chisnallf571cde2012-02-15 13:39:01 +00004341 break;
Tom Stellard8fa33092015-07-18 01:49:05 +00004342 case llvm::Triple::AMDHSA:
David Blaikie6ad71012017-01-13 18:53:43 +00004343 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
Tom Stellard8fa33092015-07-18 01:49:05 +00004344 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004345 case llvm::Triple::Win32:
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004346 switch (Target.getEnvironment()) {
4347 default:
4348 if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004349 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004350 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004351 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004352 else
David Blaikie6ad71012017-01-13 18:53:43 +00004353 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004354 break;
4355 case llvm::Triple::GNU:
David Blaikie6ad71012017-01-13 18:53:43 +00004356 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004357 break;
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004358 case llvm::Triple::Itanium:
David Blaikie6ad71012017-01-13 18:53:43 +00004359 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
4360 Args);
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004361 break;
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004362 case llvm::Triple::MSVC:
4363 case llvm::Triple::UnknownEnvironment:
Dave Leef96bedf2017-11-06 21:18:05 +00004364 if (Args.getLastArgValue(options::OPT_fuse_ld_EQ)
4365 .startswith_lower("bfd"))
4366 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(
4367 *this, Target, Args);
4368 else
4369 TC =
4370 llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004371 break;
4372 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004373 break;
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004374 case llvm::Triple::PS4:
David Blaikie6ad71012017-01-13 18:53:43 +00004375 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004376 break;
David L Kreitzerd397ea42016-10-14 20:44:33 +00004377 case llvm::Triple::Contiki:
David Blaikie6ad71012017-01-13 18:53:43 +00004378 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
David L Kreitzerd397ea42016-10-14 20:44:33 +00004379 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004380 default:
Douglas Katzman9f5e70e2015-05-26 18:01:33 +00004381 // Of these targets, Hexagon is the only one that might have
4382 // an OS of Linux, in which case it got handled above already.
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004383 switch (Target.getArch()) {
4384 case llvm::Triple::tce:
David Blaikie6ad71012017-01-13 18:53:43 +00004385 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004386 break;
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004387 case llvm::Triple::tcele:
David Blaikie6ad71012017-01-13 18:53:43 +00004388 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004389 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004390 case llvm::Triple::hexagon:
David Blaikie6ad71012017-01-13 18:53:43 +00004391 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4392 Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004393 break;
Jacques Pienaard964cc22016-03-28 21:02:54 +00004394 case llvm::Triple::lanai:
David Blaikie6ad71012017-01-13 18:53:43 +00004395 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
Jacques Pienaard964cc22016-03-28 21:02:54 +00004396 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004397 case llvm::Triple::xcore:
David Blaikie6ad71012017-01-13 18:53:43 +00004398 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004399 break;
Dan Gohmanc2853072015-09-03 22:51:53 +00004400 case llvm::Triple::wasm32:
4401 case llvm::Triple::wasm64:
David Blaikie6ad71012017-01-13 18:53:43 +00004402 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
Dan Gohmanc2853072015-09-03 22:51:53 +00004403 break;
Dylan McKay924fa3a2017-01-05 05:20:27 +00004404 case llvm::Triple::avr:
David Blaikie6ad71012017-01-13 18:53:43 +00004405 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
Dylan McKay924fa3a2017-01-05 05:20:27 +00004406 break;
David Bolvanskyf4be2532018-07-31 14:21:46 +00004407 case llvm::Triple::riscv32:
4408 case llvm::Triple::riscv64:
4409 TC = llvm::make_unique<toolchains::RISCVToolChain>(*this, Target, Args);
4410 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004411 default:
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004412 if (Target.getVendor() == llvm::Triple::Myriad)
David Blaikie6ad71012017-01-13 18:53:43 +00004413 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
4414 Args);
Jonathan Roelofs901c7762017-05-25 15:42:13 +00004415 else if (toolchains::BareMetal::handlesTarget(Target))
4416 TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004417 else if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004418 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004419 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004420 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004421 else
David Blaikie6ad71012017-01-13 18:53:43 +00004422 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004423 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004424 }
4425 }
Justin Lebar66c4fd72016-11-18 00:41:22 +00004426
4427 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
4428 // compiles always need two toolchains, the CUDA toolchain and the host
4429 // toolchain. So the only valid way to create a CUDA toolchain is via
4430 // CreateOffloadingDeviceToolChains.
4431
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004432 return *TC;
Daniel Dunbar4dff6a42009-03-10 23:41:59 +00004433}
Daniel Dunbar8fa879d2009-03-24 18:57:02 +00004434
Rafael Espindola2f69d402013-03-18 15:33:26 +00004435bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
Douglas Katzman00249092015-06-12 15:45:21 +00004436 // Say "no" if there is not exactly one input of a type clang understands.
Nico Weber5a459f82016-02-23 19:30:43 +00004437 if (JA.size() != 1 ||
4438 !types::isAcceptedByClang((*JA.input_begin())->getType()))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004439 return false;
4440
Douglas Katzman00249092015-06-12 15:45:21 +00004441 // And say "no" if this is not a kind of action clang understands.
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004442 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
Bob Wilson23a55f12014-12-21 07:00:00 +00004443 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004444 return false;
4445
4446 return true;
4447}
4448
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004449/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
4450/// grouped values as integers. Numbers which are not provided are set to 0.
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004451///
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004452/// \return True if the entire string was parsed (9.2), or all groups were
4453/// parsed (10.3.5extrastuff).
Mehdi Amini12011172016-10-06 05:11:48 +00004454bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
4455 unsigned &Micro, bool &HadExtra) {
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004456 HadExtra = false;
4457
4458 Major = Minor = Micro = 0;
Mehdi Amini12011172016-10-06 05:11:48 +00004459 if (Str.empty())
Bob Wilson433cb312015-04-07 01:03:35 +00004460 return false;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004461
Mehdi Amini12011172016-10-06 05:11:48 +00004462 if (Str.consumeInteger(10, Major))
4463 return false;
4464 if (Str.empty())
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004465 return true;
Mehdi Amini12011172016-10-06 05:11:48 +00004466 if (Str[0] != '.')
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004467 return false;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004468
Mehdi Amini12011172016-10-06 05:11:48 +00004469 Str = Str.drop_front(1);
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004470
Mehdi Amini12011172016-10-06 05:11:48 +00004471 if (Str.consumeInteger(10, Minor))
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004472 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004473 if (Str.empty())
4474 return true;
4475 if (Str[0] != '.')
4476 return false;
4477 Str = Str.drop_front(1);
4478
4479 if (Str.consumeInteger(10, Micro))
4480 return false;
4481 if (!Str.empty())
4482 HadExtra = true;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004483 return true;
4484}
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004485
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004486/// Parse digits from a string \p Str and fulfill \p Digits with
4487/// the parsed numbers. This method assumes that the max number of
4488/// digits to look for is equal to Digits.size().
4489///
4490/// \return True if the entire string was parsed and there are
4491/// no extra characters remaining at the end.
Mehdi Amini12011172016-10-06 05:11:48 +00004492bool Driver::GetReleaseVersion(StringRef Str,
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004493 MutableArrayRef<unsigned> Digits) {
Mehdi Amini12011172016-10-06 05:11:48 +00004494 if (Str.empty())
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004495 return false;
4496
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004497 unsigned CurDigit = 0;
4498 while (CurDigit < Digits.size()) {
Mehdi Amini12011172016-10-06 05:11:48 +00004499 unsigned Digit;
4500 if (Str.consumeInteger(10, Digit))
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004501 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004502 Digits[CurDigit] = Digit;
4503 if (Str.empty())
4504 return true;
4505 if (Str[0] != '.')
4506 return false;
4507 Str = Str.drop_front(1);
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004508 CurDigit++;
4509 }
4510
4511 // More digits than requested, bail out...
4512 return false;
4513}
4514
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004515std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
4516 unsigned IncludedFlagsBitmask = 0;
Rafael Espindolacc707bc2013-09-25 15:54:41 +00004517 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004518
4519 if (Mode == CLMode) {
Hans Wennborg19076102013-07-31 20:51:53 +00004520 // Include CL and Core options.
4521 IncludedFlagsBitmask |= options::CLOption;
4522 IncludedFlagsBitmask |= options::CoreOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004523 } else {
4524 ExcludedFlagsBitmask |= options::CLOption;
4525 }
4526
4527 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
4528}
Benjamin Kramerab88f622014-03-25 18:02:07 +00004529
Douglas Katzmanf08fadf2015-06-04 14:40:44 +00004530bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
Benjamin Kramerab88f622014-03-25 18:02:07 +00004531 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
4532}