blob: 41c1da333ff0b2859d238ba8dc3cc9cc071e4542 [file] [log] [blame]
Nick Lewyckye47c2452010-09-23 23:48:20 +00001//===--- Driver.cpp - Clang GCC Compatible Driver -------------------------===//
Daniel Dunbar544ecd12009-03-02 19:59:07 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Daniel Dunbar544ecd12009-03-02 19:59:07 +000010#include "clang/Driver/Driver.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000011#include "InputInfo.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000012#include "ToolChains/AMDGPU.h"
13#include "ToolChains/AVR.h"
Ed Schouten4dabea22017-06-25 08:29:09 +000014#include "ToolChains/Ananas.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000015#include "ToolChains/BareMetal.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000016#include "ToolChains/Clang.h"
17#include "ToolChains/CloudABI.h"
18#include "ToolChains/Contiki.h"
19#include "ToolChains/CrossWindows.h"
20#include "ToolChains/Cuda.h"
21#include "ToolChains/Darwin.h"
22#include "ToolChains/DragonFly.h"
23#include "ToolChains/FreeBSD.h"
24#include "ToolChains/Fuchsia.h"
25#include "ToolChains/Gnu.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000026#include "ToolChains/HIP.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000027#include "ToolChains/Haiku.h"
28#include "ToolChains/Hexagon.h"
29#include "ToolChains/Lanai.h"
30#include "ToolChains/Linux.h"
Yaxun Liuf6144222018-05-30 00:53:50 +000031#include "ToolChains/MSVC.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000032#include "ToolChains/MinGW.h"
33#include "ToolChains/Minix.h"
Konstantin Zhuravlyove37b32c2017-03-08 22:36:04 +000034#include "ToolChains/MipsLinux.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000035#include "ToolChains/Myriad.h"
36#include "ToolChains/NaCl.h"
37#include "ToolChains/NetBSD.h"
38#include "ToolChains/OpenBSD.h"
39#include "ToolChains/PS4CPU.h"
Erik Pilkington46420b62018-09-27 20:36:28 +000040#include "ToolChains/RISCVToolchain.h"
David L. Jonesf561aba2017-03-08 01:02:16 +000041#include "ToolChains/Solaris.h"
42#include "ToolChains/TCE.h"
43#include "ToolChains/WebAssembly.h"
44#include "ToolChains/XCore.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000045#include "clang/Basic/Version.h"
Alp Toker1d257e12014-06-04 03:28:55 +000046#include "clang/Config/config.h"
Daniel Dunbar1688f1a2009-03-12 07:58:46 +000047#include "clang/Driver/Action.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000048#include "clang/Driver/Compilation.h"
Daniel Dunbarc0b3e952009-03-12 08:55:43 +000049#include "clang/Driver/DriverDiagnostic.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000050#include "clang/Driver/Job.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000051#include "clang/Driver/Options.h"
Peter Collingbournea4ccff32015-02-20 20:30:56 +000052#include "clang/Driver/SanitizerArgs.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000053#include "clang/Driver/Tool.h"
54#include "clang/Driver/ToolChain.h"
Chris Lattnerce6c42f2011-03-23 04:04:01 +000055#include "llvm/ADT/ArrayRef.h"
Hans Wennborg6ddc6902013-07-27 00:23:45 +000056#include "llvm/ADT/STLExtras.h"
Justin Lebar62907612016-07-06 21:21:39 +000057#include "llvm/ADT/SmallSet.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000058#include "llvm/ADT/StringExtras.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000059#include "llvm/ADT/StringSet.h"
Hans Wennborg70850d82013-07-18 20:29:38 +000060#include "llvm/ADT/StringSwitch.h"
Nico Weberd637c052018-04-30 13:52:15 +000061#include "llvm/Config/llvm-config.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000062#include "llvm/Option/Arg.h"
63#include "llvm/Option/ArgList.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000064#include "llvm/Option/OptSpecifier.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000065#include "llvm/Option/OptTable.h"
66#include "llvm/Option/Option.h"
Serge Pavlov208ac652018-01-01 13:27:01 +000067#include "llvm/Support/CommandLine.h"
David Blaikie79000202011-09-23 05:57:42 +000068#include "llvm/Support/ErrorHandling.h"
Michael J. Spencerf28df4c2010-12-17 21:22:22 +000069#include "llvm/Support/FileSystem.h"
Fangrui Songd0028232018-10-10 00:15:33 +000070#include "llvm/Support/FormatVariadic.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"
Jonas Devliegherefc514902018-10-10 13:27:25 +000077#include "llvm/Support/VirtualFileSystem.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000078#include "llvm/Support/raw_ostream.h"
Dylan Noblesmith4f4e7452012-02-02 00:40:14 +000079#include <map>
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000080#include <memory>
Benjamin Kramercfeacf52016-05-27 14:27:13 +000081#include <utility>
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +000082#if LLVM_ON_UNIX
83#include <unistd.h> // getpid
Nick Desaulniers9d0df312018-10-15 17:39:00 +000084#include <sysexits.h> // EX_IOERR
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +000085#endif
Dylan Noblesmith86780e92012-02-01 14:25:28 +000086
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000087using namespace clang::driver;
Chris Lattnerada1c912009-03-26 05:56:24 +000088using namespace clang;
Reid Kleckner898229a2013-06-14 17:17:23 +000089using namespace llvm::opt;
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000090
Petr Hosekdd38d932018-05-29 22:35:39 +000091Driver::Driver(StringRef ClangExecutable, StringRef TargetTriple,
Benjamin Kramerd45b2052015-10-07 15:48:01 +000092 DiagnosticsEngine &Diags,
Jonas Devliegherefc514902018-10-10 13:27:25 +000093 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)
Benjamin Kramercfeacf52016-05-27 14:27:13 +000094 : Opts(createDriverOptTable()), Diags(Diags), VFS(std::move(VFS)),
95 Mode(GCCMode), SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
96 LTOMode(LTOK_None), ClangExecutable(ClangExecutable),
Alex Lorenz045c5142018-04-07 00:03:27 +000097 SysRoot(DEFAULT_SYSROOT), DriverTitle("clang LLVM compiler"),
98 CCPrintOptionsFilename(nullptr), CCPrintHeadersFilename(nullptr),
99 CCLogDiagnosticsFilename(nullptr), CCCPrintBindings(false),
100 CCPrintOptions(false), CCPrintHeaders(false), CCLogDiagnostics(false),
Petr Hosekdd38d932018-05-29 22:35:39 +0000101 CCGenDiagnostics(false), TargetTriple(TargetTriple),
Alex Lorenz045c5142018-04-07 00:03:27 +0000102 CCCGenericGCCName(""), Saver(Alloc), CheckInputsExist(true),
103 CCCUsePCH(true), GenReproducer(false),
104 SuppressMissingInputWarning(false) {
Daniel Dunbar3f3e2cd2010-01-20 02:35:16 +0000105
Benjamin Kramerd45b2052015-10-07 15:48:01 +0000106 // Provide a sane fallback if no VFS is specified.
107 if (!this->VFS)
Jonas Devliegherefc514902018-10-10 13:27:25 +0000108 this->VFS = llvm::vfs::getRealFileSystem();
Benjamin Kramerd45b2052015-10-07 15:48:01 +0000109
Sumanth Gundapaneni3a1592942015-03-03 20:43:12 +0000110 Name = llvm::sys::path::filename(ClangExecutable);
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000111 Dir = llvm::sys::path::parent_path(ClangExecutable);
Benjamin Kramerf420dda2015-10-13 15:19:32 +0000112 InstalledDir = Dir; // Provide a sensible default installed dir.
Bob Wilsona20a1da2013-03-23 05:17:59 +0000113
Serge Pavlov208ac652018-01-01 13:27:01 +0000114#if defined(CLANG_CONFIG_FILE_SYSTEM_DIR)
115 SystemConfigDir = CLANG_CONFIG_FILE_SYSTEM_DIR;
116#endif
117#if defined(CLANG_CONFIG_FILE_USER_DIR)
118 UserConfigDir = CLANG_CONFIG_FILE_USER_DIR;
119#endif
120
Bob Wilsona20a1da2013-03-23 05:17:59 +0000121 // Compute the path to the resource directory.
122 StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
123 SmallString<128> P(Dir);
Chandler Carruthfd3cc702014-12-29 12:09:08 +0000124 if (ClangResourceDir != "") {
Bob Wilsona20a1da2013-03-23 05:17:59 +0000125 llvm::sys::path::append(P, ClangResourceDir);
Chandler Carruthfd3cc702014-12-29 12:09:08 +0000126 } else {
127 StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX);
Argyrios Kyrtzidisbcae0472017-02-25 18:14:35 +0000128 P = llvm::sys::path::parent_path(Dir);
129 llvm::sys::path::append(P, Twine("lib") + ClangLibdirSuffix, "clang",
Chandler Carruthfd3cc702014-12-29 12:09:08 +0000130 CLANG_VERSION_STRING);
131 }
Bob Wilsona20a1da2013-03-23 05:17:59 +0000132 ResourceDir = P.str();
Daniel Dunbar544ecd12009-03-02 19:59:07 +0000133}
134
Zachary Turneraff19c32016-08-12 17:47:52 +0000135void Driver::ParseDriverMode(StringRef ProgramName,
136 ArrayRef<const char *> Args) {
Martin Storsjo1fab23d2018-04-25 21:23:59 +0000137 if (ClangNameParts.isEmpty())
138 ClangNameParts = ToolChain::getTargetAndModeFromProgramName(ProgramName);
Serge Pavlov4e769842017-08-29 05:22:26 +0000139 setDriverModeFromOption(ClangNameParts.DriverMode);
Hans Wennborg70850d82013-07-18 20:29:38 +0000140
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000141 for (const char *ArgPtr : Args) {
Erich Keane258f0592018-02-07 00:19:58 +0000142 // Ignore nullptrs, they are the response file's EOL markers.
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000143 if (ArgPtr == nullptr)
Reid Kleckneraf5fd6a2014-08-22 19:29:30 +0000144 continue;
Douglas Katzman6bbffc42015-06-25 18:51:37 +0000145 const StringRef Arg = ArgPtr;
Zachary Turneraff19c32016-08-12 17:47:52 +0000146 setDriverModeFromOption(Arg);
Hans Wennborg70850d82013-07-18 20:29:38 +0000147 }
148}
149
Zachary Turneraff19c32016-08-12 17:47:52 +0000150void Driver::setDriverModeFromOption(StringRef Opt) {
151 const std::string OptName =
152 getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
153 if (!Opt.startswith(OptName))
154 return;
155 StringRef Value = Opt.drop_front(OptName.size());
156
Erich Keane2908a042018-02-12 17:47:01 +0000157 if (auto M = llvm::StringSwitch<llvm::Optional<DriverMode>>(Value)
158 .Case("gcc", GCCMode)
159 .Case("g++", GXXMode)
160 .Case("cpp", CPPMode)
161 .Case("cl", CLMode)
162 .Default(None))
163 Mode = *M;
Zachary Turneraff19c32016-08-12 17:47:52 +0000164 else
165 Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
166}
167
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000168InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings,
Hans Wennborg797004d2018-11-08 11:27:04 +0000169 bool IsClCompatMode,
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000170 bool &ContainsError) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000171 llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000172 ContainsError = false;
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000173
174 unsigned IncludedFlagsBitmask;
175 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000176 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Hans Wennborg797004d2018-11-08 11:27:04 +0000177 getIncludeExcludeOptionFlagMasks(IsClCompatMode);
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000178
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000179 unsigned MissingArgIndex, MissingArgCount;
David Blaikie69a1d8c2015-06-22 22:07:27 +0000180 InputArgList Args =
David Blaikie6d492ad2015-06-21 06:32:36 +0000181 getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
182 IncludedFlagsBitmask, ExcludedFlagsBitmask);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000183
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000184 // Check for missing argument error.
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000185 if (MissingArgCount) {
186 Diag(diag::err_drv_missing_argument)
David Blaikie69a1d8c2015-06-22 22:07:27 +0000187 << Args.getArgString(MissingArgIndex) << MissingArgCount;
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000188 ContainsError |=
189 Diags.getDiagnosticLevel(diag::err_drv_missing_argument,
190 SourceLocation()) > DiagnosticsEngine::Warning;
191 }
Daniel Dunbar65229332009-03-13 11:38:42 +0000192
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000193 // Check for unsupported options.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000194 for (const Arg *A : Args) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +0000195 if (A->getOption().hasFlag(options::Unsupported)) {
Brian Gesiak24910762018-01-06 00:25:40 +0000196 unsigned DiagID;
197 auto ArgString = A->getAsString(Args);
198 std::string Nearest;
199 if (getOpts().findNearest(
200 ArgString, Nearest, IncludedFlagsBitmask,
201 ExcludedFlagsBitmask | options::Unsupported) > 1) {
202 DiagID = diag::err_drv_unsupported_opt;
203 Diag(DiagID) << ArgString;
204 } else {
205 DiagID = diag::err_drv_unsupported_opt_with_suggestion;
206 Diag(DiagID) << ArgString << Nearest;
207 }
208 ContainsError |= Diags.getDiagnosticLevel(DiagID, SourceLocation()) >
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000209 DiagnosticsEngine::Warning;
Daniel Dunbard8500f32009-03-22 23:26:43 +0000210 continue;
211 }
Chad Rosierce975d92012-02-22 17:55:22 +0000212
213 // Warn about -mcpu= without an argument.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000214 if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000215 Diag(diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
216 ContainsError |= Diags.getDiagnosticLevel(
217 diag::warn_drv_empty_joined_argument,
218 SourceLocation()) > DiagnosticsEngine::Warning;
Chad Rosierce975d92012-02-22 17:55:22 +0000219 }
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000220 }
221
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000222 for (const Arg *A : Args.filtered(options::OPT_UNKNOWN)) {
Brian Gesiak24910762018-01-06 00:25:40 +0000223 unsigned DiagID;
224 auto ArgString = A->getAsString(Args);
225 std::string Nearest;
226 if (getOpts().findNearest(
227 ArgString, Nearest, IncludedFlagsBitmask, ExcludedFlagsBitmask) > 1) {
228 DiagID = IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl
229 : diag::err_drv_unknown_argument;
230 Diags.Report(DiagID) << ArgString;
231 } else {
232 DiagID = IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl_with_suggestion
233 : diag::err_drv_unknown_argument_with_suggestion;
234 Diags.Report(DiagID) << ArgString << Nearest;
235 }
236 ContainsError |= Diags.getDiagnosticLevel(DiagID, SourceLocation()) >
Benjamin Kramer43c0f482017-06-30 13:21:27 +0000237 DiagnosticsEngine::Warning;
238 }
Rafael Espindola8a2d4962013-09-23 23:55:25 +0000239
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000240 return Args;
241}
242
Chad Rosier7742b5d2011-07-27 23:36:45 +0000243// Determine which compilation mode we are in. We look for options which
244// affect the phase, starting with the earliest phases, and record which
245// option we used to determine the final phase.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000246phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
247 Arg **FinalPhaseArg) const {
Craig Topper92fc2df2014-05-17 16:56:41 +0000248 Arg *PhaseArg = nullptr;
Chad Rosier7742b5d2011-07-27 23:36:45 +0000249 phases::ID FinalPhase;
Eric Christopherf901e852011-08-17 22:59:59 +0000250
Hans Wennborge50cec32014-06-13 20:59:54 +0000251 // -{E,EP,P,M,MM} only run the preprocessor.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000252 if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
Hans Wennborge50cec32014-06-13 20:59:54 +0000253 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
Hans Wennborge0053472013-12-20 18:40:46 +0000254 (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
255 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000256 FinalPhase = phases::Preprocess;
Eric Christopherf901e852011-08-17 22:59:59 +0000257
Richard Smithdd4ad3d2016-08-30 19:06:26 +0000258 // --precompile only runs up to precompilation.
259 } else if ((PhaseArg = DAL.getLastArg(options::OPT__precompile))) {
260 FinalPhase = phases::Precompile;
261
Bob Wilson23a55f12014-12-21 07:00:00 +0000262 // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
Chad Rosier7742b5d2011-07-27 23:36:45 +0000263 } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000264 (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000265 (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000266 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
Fariborz Jahanian73223bb2012-04-02 15:59:19 +0000267 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
Ted Kremenekf7639e12012-03-06 20:06:33 +0000268 (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000269 (PhaseArg = DAL.getLastArg(options::OPT__analyze,
Chad Rosier1aeb15a2012-03-06 23:14:35 +0000270 options::OPT__analyze_auto)) ||
Bob Wilson23a55f12014-12-21 07:00:00 +0000271 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000272 FinalPhase = phases::Compile;
273
Bob Wilson23a55f12014-12-21 07:00:00 +0000274 // -S only runs up to the backend.
275 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
276 FinalPhase = phases::Backend;
277
Artem Belevich4242f412015-07-28 21:01:21 +0000278 // -c compilation only runs up to the assembler.
279 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000280 FinalPhase = phases::Assemble;
281
282 // Otherwise do everything.
283 } else
284 FinalPhase = phases::Link;
285
286 if (FinalPhaseArg)
287 *FinalPhaseArg = PhaseArg;
288
289 return FinalPhase;
290}
291
David Blaikie0aaa7622017-01-13 17:34:15 +0000292static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
Martin Storsjo665c7a42018-05-04 06:05:58 +0000293 StringRef Value, bool Claim = true) {
David Blaikie0aaa7622017-01-13 17:34:15 +0000294 Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
Hans Wennborged1d0722013-08-13 21:32:29 +0000295 Args.getBaseArgs().MakeIndex(Value), Value.data());
Hans Wennborg55362852014-05-02 22:55:30 +0000296 Args.AddSynthesizedArg(A);
Martin Storsjo665c7a42018-05-04 06:05:58 +0000297 if (Claim)
298 A->claim();
Hans Wennborged1d0722013-08-13 21:32:29 +0000299 return A;
300}
301
Daniel Dunbar775d4062010-06-11 22:00:26 +0000302DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
303 DerivedArgList *DAL = new DerivedArgList(Args);
304
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000305 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
Nirav Daveb0bb6142015-11-24 16:07:21 +0000306 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000307 for (Arg *A : Args) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000308 // Unfortunately, we have to parse some forwarding options (-Xassembler,
309 // -Xlinker, -Xpreprocessor) because we either integrate their functionality
310 // (assembler and preprocessor), or bypass a previous driver ('collect2').
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000311
312 // Rewrite linker options, to replace --no-demangle with a custom internal
313 // option.
314 if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
315 A->getOption().matches(options::OPT_Xlinker)) &&
316 A->containsValue("--no-demangle")) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000317 // Add the rewritten no-demangle argument.
318 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
319
320 // Add the remaining values as Xlinker arguments.
Benjamin Kramer72e64312015-09-24 14:48:49 +0000321 for (StringRef Val : A->getValues())
Douglas Katzmana34b7bf2015-06-30 19:32:57 +0000322 if (Val != "--no-demangle")
323 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000324
325 continue;
326 }
327
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000328 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
329 // some build systems. We don't try to be complete here because we don't
330 // care to encourage this usage model.
331 if (A->getOption().matches(options::OPT_Wp_COMMA) &&
Richard Smithbd55daf2012-11-01 04:30:05 +0000332 (A->getValue(0) == StringRef("-MD") ||
333 A->getValue(0) == StringRef("-MMD"))) {
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000334 // Rewrite to -MD/-MMD along with -MF.
Richard Smithbd55daf2012-11-01 04:30:05 +0000335 if (A->getValue(0) == StringRef("-MD"))
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000336 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
337 else
338 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
Michael J. Spencer70d85be2012-11-07 23:37:14 +0000339 if (A->getNumValues() == 2)
340 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
341 A->getValue(1));
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000342 continue;
343 }
344
Shantonu Senafeb03b2010-09-17 18:39:08 +0000345 // Rewrite reserved library names.
346 if (A->getOption().matches(options::OPT_l)) {
Richard Smithbd55daf2012-11-01 04:30:05 +0000347 StringRef Value = A->getValue();
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000348
Shantonu Senafeb03b2010-09-17 18:39:08 +0000349 // Rewrite unless -nostdlib is present.
Nirav Daveb0bb6142015-11-24 16:07:21 +0000350 if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000351 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000352 continue;
353 }
Shantonu Senafeb03b2010-09-17 18:39:08 +0000354
355 // Rewrite unconditionally.
356 if (Value == "cc_kext") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000357 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
Shantonu Senafeb03b2010-09-17 18:39:08 +0000358 continue;
359 }
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000360 }
361
Hans Wennborged1d0722013-08-13 21:32:29 +0000362 // Pick up inputs via the -- option.
363 if (A->getOption().matches(options::OPT__DASH_DASH)) {
364 A->claim();
Benjamin Kramer72e64312015-09-24 14:48:49 +0000365 for (StringRef Val : A->getValues())
Martin Storsjo665c7a42018-05-04 06:05:58 +0000366 DAL->append(MakeInputArg(*DAL, *Opts, Val, false));
Hans Wennborged1d0722013-08-13 21:32:29 +0000367 continue;
368 }
369
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000370 DAL->append(A);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000371 }
Daniel Dunbar775d4062010-06-11 22:00:26 +0000372
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000373 // Enforce -static if -miamcu is present.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000374 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
375 DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000376
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000377// Add a default value of -mlinker-version=, if one was given and the user
378// didn't specify one.
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000379#if defined(HOST_LINK_VERSION)
Tim Northover018578c2015-06-12 19:21:35 +0000380 if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
381 strlen(HOST_LINK_VERSION) > 0) {
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000382 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
383 HOST_LINK_VERSION);
Daniel Dunbarb613ffc2010-08-17 22:32:45 +0000384 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000385 }
386#endif
387
Daniel Dunbar775d4062010-06-11 22:00:26 +0000388 return DAL;
389}
390
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000391/// Compute target triple from args.
Artem Belevich959e0542015-07-10 19:47:55 +0000392///
393/// This routine provides the logic to compute a target triple from various
394/// args passed to the driver and the default triple string.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000395static llvm::Triple computeTargetTriple(const Driver &D,
Petr Hosekdd38d932018-05-29 22:35:39 +0000396 StringRef TargetTriple,
Artem Belevich959e0542015-07-10 19:47:55 +0000397 const ArgList &Args,
398 StringRef DarwinArchName = "") {
399 // FIXME: Already done in Compilation *Driver::BuildCompilation
400 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +0000401 TargetTriple = A->getValue();
Artem Belevich959e0542015-07-10 19:47:55 +0000402
Petr Hosekdd38d932018-05-29 22:35:39 +0000403 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Artem Belevich959e0542015-07-10 19:47:55 +0000404
405 // Handle Apple-specific options available here.
406 if (Target.isOSBinFormatMachO()) {
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000407 // If an explicit Darwin arch name is given, that trumps all.
Artem Belevich959e0542015-07-10 19:47:55 +0000408 if (!DarwinArchName.empty()) {
409 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
410 return Target;
411 }
412
413 // Handle the Darwin '-arch' flag.
414 if (Arg *A = Args.getLastArg(options::OPT_arch)) {
415 StringRef ArchName = A->getValue();
416 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
417 }
418 }
419
420 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
421 // '-mbig-endian'/'-EB'.
422 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
423 options::OPT_mbig_endian)) {
424 if (A->getOption().matches(options::OPT_mlittle_endian)) {
425 llvm::Triple LE = Target.getLittleEndianArchVariant();
426 if (LE.getArch() != llvm::Triple::UnknownArch)
427 Target = std::move(LE);
428 } else {
429 llvm::Triple BE = Target.getBigEndianArchVariant();
430 if (BE.getArch() != llvm::Triple::UnknownArch)
431 Target = std::move(BE);
432 }
433 }
434
435 // Skip further flag support on OSes which don't support '-m32' or '-m64'.
Douglas Katzman15a63ed2015-08-12 18:36:12 +0000436 if (Target.getArch() == llvm::Triple::tce ||
437 Target.getOS() == llvm::Triple::Minix)
Artem Belevich959e0542015-07-10 19:47:55 +0000438 return Target;
439
440 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000441 Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
442 options::OPT_m32, options::OPT_m16);
443 if (A) {
Artem Belevich959e0542015-07-10 19:47:55 +0000444 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
445
446 if (A->getOption().matches(options::OPT_m64)) {
447 AT = Target.get64BitArchVariant().getArch();
448 if (Target.getEnvironment() == llvm::Triple::GNUX32)
449 Target.setEnvironment(llvm::Triple::GNU);
450 } else if (A->getOption().matches(options::OPT_mx32) &&
451 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
452 AT = llvm::Triple::x86_64;
453 Target.setEnvironment(llvm::Triple::GNUX32);
454 } else if (A->getOption().matches(options::OPT_m32)) {
455 AT = Target.get32BitArchVariant().getArch();
456 if (Target.getEnvironment() == llvm::Triple::GNUX32)
457 Target.setEnvironment(llvm::Triple::GNU);
458 } else if (A->getOption().matches(options::OPT_m16) &&
459 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
460 AT = llvm::Triple::x86;
461 Target.setEnvironment(llvm::Triple::CODE16);
462 }
463
464 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
465 Target.setArch(AT);
466 }
467
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000468 // Handle -miamcu flag.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000469 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
470 if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
471 D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
472 << Target.str();
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000473
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000474 if (A && !A->getOption().matches(options::OPT_m32))
475 D.Diag(diag::err_drv_argument_not_allowed_with)
476 << "-miamcu" << A->getBaseArg().getAsString(Args);
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000477
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000478 Target.setArch(llvm::Triple::x86);
479 Target.setArchName("i586");
480 Target.setEnvironment(llvm::Triple::UnknownEnvironment);
481 Target.setEnvironmentName("");
482 Target.setOS(llvm::Triple::ELFIAMCU);
483 Target.setVendor(llvm::Triple::UnknownVendor);
484 Target.setVendorName("intel");
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000485 }
486
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000487 // If target is MIPS adjust the target triple
488 // accordingly to provided ABI name.
489 A = Args.getLastArg(options::OPT_mabi_EQ);
Simon Atanasyane60eae42018-10-16 10:19:06 +0000490 if (A && Target.isMIPS()) {
491 StringRef ABIName = A->getValue();
492 if (ABIName == "32") {
493 Target = Target.get32BitArchVariant();
494 if (Target.getEnvironment() == llvm::Triple::GNUABI64 ||
495 Target.getEnvironment() == llvm::Triple::GNUABIN32)
496 Target.setEnvironment(llvm::Triple::GNU);
497 } else if (ABIName == "n32") {
498 Target = Target.get64BitArchVariant();
499 if (Target.getEnvironment() == llvm::Triple::GNU ||
500 Target.getEnvironment() == llvm::Triple::GNUABI64)
501 Target.setEnvironment(llvm::Triple::GNUABIN32);
502 } else if (ABIName == "64") {
503 Target = Target.get64BitArchVariant();
504 if (Target.getEnvironment() == llvm::Triple::GNU ||
505 Target.getEnvironment() == llvm::Triple::GNUABIN32)
506 Target.setEnvironment(llvm::Triple::GNUABI64);
507 }
508 }
Simon Atanasyan0c0fb4b2018-09-27 05:04:50 +0000509
Artem Belevich959e0542015-07-10 19:47:55 +0000510 return Target;
511}
512
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000513// Parse the LTO options and record the type of LTO compilation
Teresa Johnson945bc502015-10-15 20:35:53 +0000514// based on which -f(no-)?lto(=.*)? option occurs last.
515void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
516 LTOMode = LTOK_None;
517 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
518 options::OPT_fno_lto, false))
519 return;
520
521 StringRef LTOName("full");
522
523 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
Teresa Johnson6ef80dc2015-11-02 18:03:12 +0000524 if (A)
525 LTOName = A->getValue();
Teresa Johnson945bc502015-10-15 20:35:53 +0000526
527 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
528 .Case("full", LTOK_Full)
529 .Case("thin", LTOK_Thin)
530 .Default(LTOK_Unknown);
531
532 if (LTOMode == LTOK_Unknown) {
533 assert(A);
534 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
535 << A->getValue();
536 }
537}
538
Samuel Antao39f9da22016-10-27 16:38:05 +0000539/// Compute the desired OpenMP runtime from the flags provided.
540Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
541 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
542
543 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
544 if (A)
545 RuntimeName = A->getValue();
546
547 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
548 .Case("libomp", OMPRT_OMP)
549 .Case("libgomp", OMPRT_GOMP)
550 .Case("libiomp5", OMPRT_IOMP5)
551 .Default(OMPRT_Unknown);
552
553 if (RT == OMPRT_Unknown) {
554 if (A)
555 Diag(diag::err_drv_unsupported_option_argument)
556 << A->getOption().getName() << A->getValue();
557 else
558 // FIXME: We could use a nicer diagnostic here.
559 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
560 }
561
562 return RT;
563}
564
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000565void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
566 InputList &Inputs) {
567
568 //
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000569 // CUDA/HIP
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000570 //
Yaxun Liuf6144222018-05-30 00:53:50 +0000571 // We need to generate a CUDA/HIP toolchain if any of the inputs has a CUDA
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000572 // or HIP type. However, mixed CUDA/HIP compilation is not supported.
573 bool IsCuda =
574 llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000575 return types::isCuda(I.first);
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000576 });
577 bool IsHIP =
578 llvm::any_of(Inputs,
579 [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
580 return types::isHIP(I.first);
581 }) ||
582 C.getInputArgs().hasArg(options::OPT_hip_link);
583 if (IsCuda && IsHIP) {
584 Diag(clang::diag::err_drv_mix_cuda_hip);
585 return;
586 }
Yaxun Liuf6144222018-05-30 00:53:50 +0000587 if (IsCuda) {
Justin Lebar66c4fd72016-11-18 00:41:22 +0000588 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
589 const llvm::Triple &HostTriple = HostTC->getTriple();
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000590 StringRef DeviceTripleStr;
Yaxun Liuf6144222018-05-30 00:53:50 +0000591 auto OFK = Action::OFK_Cuda;
592 DeviceTripleStr =
593 HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda" : "nvptx-nvidia-cuda";
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000594 llvm::Triple CudaTriple(DeviceTripleStr);
Yaxun Liuf6144222018-05-30 00:53:50 +0000595 // Use the CUDA and host triples as the key into the ToolChains map,
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000596 // because the device toolchain we create depends on both.
David Blaikie6ad71012017-01-13 18:53:43 +0000597 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
Justin Lebar66c4fd72016-11-18 00:41:22 +0000598 if (!CudaTC) {
David Blaikie6ad71012017-01-13 18:53:43 +0000599 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000600 *this, CudaTriple, *HostTC, C.getInputArgs(), OFK);
Justin Lebar66c4fd72016-11-18 00:41:22 +0000601 }
Yaxun Liuf5a6b962018-05-11 19:21:39 +0000602 C.addOffloadDeviceToolChain(CudaTC.get(), OFK);
Yaxun Liuf6144222018-05-30 00:53:50 +0000603 } else if (IsHIP) {
604 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
605 const llvm::Triple &HostTriple = HostTC->getTriple();
606 StringRef DeviceTripleStr;
607 auto OFK = Action::OFK_HIP;
608 DeviceTripleStr = "amdgcn-amd-amdhsa";
609 llvm::Triple HIPTriple(DeviceTripleStr);
610 // Use the HIP and host triples as the key into the ToolChains map,
611 // because the device toolchain we create depends on both.
612 auto &HIPTC = ToolChains[HIPTriple.str() + "/" + HostTriple.str()];
613 if (!HIPTC) {
614 HIPTC = llvm::make_unique<toolchains::HIPToolChain>(
615 *this, HIPTriple, *HostTC, C.getInputArgs());
616 }
617 C.addOffloadDeviceToolChain(HIPTC.get(), OFK);
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000618 }
619
620 //
Samuel Antao39f9da22016-10-27 16:38:05 +0000621 // OpenMP
622 //
623 // We need to generate an OpenMP toolchain if the user specified targets with
624 // the -fopenmp-targets option.
625 if (Arg *OpenMPTargets =
626 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
627 if (OpenMPTargets->getNumValues()) {
628 // We expect that -fopenmp-targets is always used in conjunction with the
629 // option -fopenmp specifying a valid runtime with offloading support,
630 // i.e. libomp or libiomp.
631 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
632 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
633 options::OPT_fno_openmp, false);
634 if (HasValidOpenMPRuntime) {
635 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
636 HasValidOpenMPRuntime =
637 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
638 }
639
640 if (HasValidOpenMPRuntime) {
641 llvm::StringMap<const char *> FoundNormalizedTriples;
642 for (const char *Val : OpenMPTargets->getValues()) {
643 llvm::Triple TT(Val);
644 std::string NormalizedName = TT.normalize();
645
646 // Make sure we don't have a duplicate triple.
647 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
648 if (Duplicate != FoundNormalizedTriples.end()) {
649 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
650 << Val << Duplicate->second;
651 continue;
652 }
653
654 // Store the current triple so that we can check for duplicates in the
655 // following iterations.
656 FoundNormalizedTriples[NormalizedName] = Val;
657
658 // If the specified target is invalid, emit a diagnostic.
659 if (TT.getArch() == llvm::Triple::UnknownArch)
660 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
661 else {
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000662 const ToolChain *TC;
663 // CUDA toolchains have to be selected differently. They pair host
664 // and device in their implementation.
665 if (TT.isNVPTX()) {
666 const ToolChain *HostTC =
667 C.getSingleOffloadToolChain<Action::OFK_Host>();
668 assert(HostTC && "Host toolchain should be always defined.");
669 auto &CudaTC =
Gheorghe-Teodor Bercea52898432017-08-09 01:02:19 +0000670 ToolChains[TT.str() + "/" + HostTC->getTriple().normalize()];
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000671 if (!CudaTC)
672 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
Gheorghe-Teodor Bercea2c926932017-08-08 14:33:05 +0000673 *this, TT, *HostTC, C.getInputArgs(), Action::OFK_OpenMP);
Gheorghe-Teodor Bercea6a5df722017-07-06 16:08:15 +0000674 TC = CudaTC.get();
675 } else
676 TC = &getToolChain(C.getInputArgs(), TT);
677 C.addOffloadDeviceToolChain(TC, Action::OFK_OpenMP);
Samuel Antao39f9da22016-10-27 16:38:05 +0000678 }
679 }
680 } else
681 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
682 } else
683 Diag(clang::diag::warn_drv_empty_joined_argument)
684 << OpenMPTargets->getAsString(C.getInputArgs());
685 }
686
687 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000688 // TODO: Add support for other offloading programming models here.
689 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000690}
691
Serge Pavlov208ac652018-01-01 13:27:01 +0000692/// Looks the given directories for the specified file.
693///
694/// \param[out] FilePath File path, if the file was found.
695/// \param[in] Dirs Directories used for the search.
696/// \param[in] FileName Name of the file to search for.
697/// \return True if file was found.
698///
699/// Looks for file specified by FileName sequentially in directories specified
700/// by Dirs.
701///
702static bool searchForFile(SmallVectorImpl<char> &FilePath,
703 ArrayRef<std::string> Dirs,
704 StringRef FileName) {
705 SmallString<128> WPath;
706 for (const StringRef &Dir : Dirs) {
707 if (Dir.empty())
708 continue;
709 WPath.clear();
710 llvm::sys::path::append(WPath, Dir, FileName);
711 llvm::sys::path::native(WPath);
712 if (llvm::sys::fs::is_regular_file(WPath)) {
713 FilePath = std::move(WPath);
714 return true;
715 }
716 }
717 return false;
718}
719
720bool Driver::readConfigFile(StringRef FileName) {
721 // Try reading the given file.
722 SmallVector<const char *, 32> NewCfgArgs;
723 if (!llvm::cl::readConfigFile(FileName, Saver, NewCfgArgs)) {
724 Diag(diag::err_drv_cannot_read_config_file) << FileName;
725 return true;
726 }
727
728 // Read options from config file.
729 llvm::SmallString<128> CfgFileName(FileName);
730 llvm::sys::path::native(CfgFileName);
731 ConfigFile = CfgFileName.str();
732 bool ContainErrors;
733 CfgOptions = llvm::make_unique<InputArgList>(
Hans Wennborg797004d2018-11-08 11:27:04 +0000734 ParseArgStrings(NewCfgArgs, IsCLMode(), ContainErrors));
Serge Pavlov208ac652018-01-01 13:27:01 +0000735 if (ContainErrors) {
736 CfgOptions.reset();
737 return true;
738 }
739
740 if (CfgOptions->hasArg(options::OPT_config)) {
741 CfgOptions.reset();
742 Diag(diag::err_drv_nested_config_file);
743 return true;
744 }
745
746 // Claim all arguments that come from a configuration file so that the driver
747 // does not warn on any that is unused.
748 for (Arg *A : *CfgOptions)
749 A->claim();
750 return false;
751}
752
753bool Driver::loadConfigFile() {
754 std::string CfgFileName;
755 bool FileSpecifiedExplicitly = false;
756
757 // Process options that change search path for config files.
758 if (CLOptions) {
759 if (CLOptions->hasArg(options::OPT_config_system_dir_EQ)) {
760 SmallString<128> CfgDir;
761 CfgDir.append(
762 CLOptions->getLastArgValue(options::OPT_config_system_dir_EQ));
763 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000764 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000765 SystemConfigDir.clear();
766 else
767 SystemConfigDir = std::string(CfgDir.begin(), CfgDir.end());
768 }
769 }
770 if (CLOptions->hasArg(options::OPT_config_user_dir_EQ)) {
771 SmallString<128> CfgDir;
772 CfgDir.append(
773 CLOptions->getLastArgValue(options::OPT_config_user_dir_EQ));
774 if (!CfgDir.empty()) {
Sam McCall296d8322018-01-02 09:35:10 +0000775 if (llvm::sys::fs::make_absolute(CfgDir).value() != 0)
Serge Pavlov208ac652018-01-01 13:27:01 +0000776 UserConfigDir.clear();
777 else
778 UserConfigDir = std::string(CfgDir.begin(), CfgDir.end());
779 }
780 }
781 }
782
783 // First try to find config file specified in command line.
784 if (CLOptions) {
785 std::vector<std::string> ConfigFiles =
786 CLOptions->getAllArgValues(options::OPT_config);
787 if (ConfigFiles.size() > 1) {
788 Diag(diag::err_drv_duplicate_config);
789 return true;
790 }
791
792 if (!ConfigFiles.empty()) {
793 CfgFileName = ConfigFiles.front();
794 assert(!CfgFileName.empty());
795
796 // If argument contains directory separator, treat it as a path to
797 // configuration file.
798 if (llvm::sys::path::has_parent_path(CfgFileName)) {
799 SmallString<128> CfgFilePath;
800 if (llvm::sys::path::is_relative(CfgFileName))
801 llvm::sys::fs::current_path(CfgFilePath);
802 llvm::sys::path::append(CfgFilePath, CfgFileName);
803 if (!llvm::sys::fs::is_regular_file(CfgFilePath)) {
804 Diag(diag::err_drv_config_file_not_exist) << CfgFilePath;
805 return true;
806 }
807 return readConfigFile(CfgFilePath);
808 }
809
810 FileSpecifiedExplicitly = true;
811 }
812 }
813
814 // If config file is not specified explicitly, try to deduce configuration
815 // from executable name. For instance, an executable 'armv7l-clang' will
816 // search for config file 'armv7l-clang.cfg'.
817 if (CfgFileName.empty() && !ClangNameParts.TargetPrefix.empty())
818 CfgFileName = ClangNameParts.TargetPrefix + '-' + ClangNameParts.ModeSuffix;
819
820 if (CfgFileName.empty())
821 return false;
822
823 // Determine architecture part of the file name, if it is present.
824 StringRef CfgFileArch = CfgFileName;
825 size_t ArchPrefixLen = CfgFileArch.find('-');
826 if (ArchPrefixLen == StringRef::npos)
827 ArchPrefixLen = CfgFileArch.size();
828 llvm::Triple CfgTriple;
829 CfgFileArch = CfgFileArch.take_front(ArchPrefixLen);
830 CfgTriple = llvm::Triple(llvm::Triple::normalize(CfgFileArch));
831 if (CfgTriple.getArch() == llvm::Triple::ArchType::UnknownArch)
832 ArchPrefixLen = 0;
833
834 if (!StringRef(CfgFileName).endswith(".cfg"))
835 CfgFileName += ".cfg";
836
837 // If config file starts with architecture name and command line options
838 // redefine architecture (with options like -m32 -LE etc), try finding new
839 // config file with that architecture.
840 SmallString<128> FixedConfigFile;
841 size_t FixedArchPrefixLen = 0;
842 if (ArchPrefixLen) {
843 // Get architecture name from config file name like 'i386.cfg' or
844 // 'armv7l-clang.cfg'.
845 // Check if command line options changes effective triple.
846 llvm::Triple EffectiveTriple = computeTargetTriple(*this,
847 CfgTriple.getTriple(), *CLOptions);
848 if (CfgTriple.getArch() != EffectiveTriple.getArch()) {
849 FixedConfigFile = EffectiveTriple.getArchName();
850 FixedArchPrefixLen = FixedConfigFile.size();
851 // Append the rest of original file name so that file name transforms
852 // like: i386-clang.cfg -> x86_64-clang.cfg.
853 if (ArchPrefixLen < CfgFileName.size())
854 FixedConfigFile += CfgFileName.substr(ArchPrefixLen);
855 }
856 }
857
858 // Prepare list of directories where config file is searched for.
859 SmallVector<std::string, 3> CfgFileSearchDirs;
860 CfgFileSearchDirs.push_back(UserConfigDir);
861 CfgFileSearchDirs.push_back(SystemConfigDir);
862 CfgFileSearchDirs.push_back(Dir);
863
864 // Try to find config file. First try file with corrected architecture.
865 llvm::SmallString<128> CfgFilePath;
866 if (!FixedConfigFile.empty()) {
867 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
868 return readConfigFile(CfgFilePath);
869 // If 'x86_64-clang.cfg' was not found, try 'x86_64.cfg'.
870 FixedConfigFile.resize(FixedArchPrefixLen);
871 FixedConfigFile.append(".cfg");
872 if (searchForFile(CfgFilePath, CfgFileSearchDirs, FixedConfigFile))
873 return readConfigFile(CfgFilePath);
874 }
875
876 // Then try original file name.
877 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
878 return readConfigFile(CfgFilePath);
879
880 // Finally try removing driver mode part: 'x86_64-clang.cfg' -> 'x86_64.cfg'.
881 if (!ClangNameParts.ModeSuffix.empty() &&
882 !ClangNameParts.TargetPrefix.empty()) {
883 CfgFileName.assign(ClangNameParts.TargetPrefix);
884 CfgFileName.append(".cfg");
885 if (searchForFile(CfgFilePath, CfgFileSearchDirs, CfgFileName))
886 return readConfigFile(CfgFilePath);
887 }
888
889 // Report error but only if config file was specified explicitly, by option
890 // --config. If it was deduced from executable name, it is not an error.
891 if (FileSpecifiedExplicitly) {
892 Diag(diag::err_drv_config_file_not_found) << CfgFileName;
893 for (const std::string &SearchDir : CfgFileSearchDirs)
894 if (!SearchDir.empty())
895 Diag(diag::note_drv_config_file_searched_in) << SearchDir;
896 return true;
897 }
898
899 return false;
900}
901
Chris Lattner54b16772011-07-23 17:14:25 +0000902Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000903 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
904
Eric Christopherf901e852011-08-17 22:59:59 +0000905 // FIXME: Handle environment options which affect driver behavior, somewhere
Bill Wendlingadbeb9f2012-03-12 21:24:57 +0000906 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
Chad Rosier82301162011-09-14 00:47:55 +0000907
David Majnemer85c25b42016-07-24 17:44:03 +0000908 if (Optional<std::string> CompilerPathValue =
909 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
910 StringRef CompilerPath = *CompilerPathValue;
Chad Rosier82301162011-09-14 00:47:55 +0000911 while (!CompilerPath.empty()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000912 std::pair<StringRef, StringRef> Split =
913 CompilerPath.split(llvm::sys::EnvPathSeparator);
Chad Rosier82301162011-09-14 00:47:55 +0000914 PrefixDirs.push_back(Split.first);
915 CompilerPath = Split.second;
916 }
917 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000918
Hans Wennborg70850d82013-07-18 20:29:38 +0000919 // We look for the driver mode option early, because the mode can affect
920 // how other options are parsed.
Zachary Turneraff19c32016-08-12 17:47:52 +0000921 ParseDriverMode(ClangExecutable, ArgList.slice(1));
Hans Wennborg70850d82013-07-18 20:29:38 +0000922
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000923 // FIXME: What are we going to do with -V and -b?
924
Serge Pavlov208ac652018-01-01 13:27:01 +0000925 // Arguments specified in command line.
926 bool ContainsError;
927 CLOptions = llvm::make_unique<InputArgList>(
Hans Wennborg797004d2018-11-08 11:27:04 +0000928 ParseArgStrings(ArgList.slice(1), IsCLMode(), ContainsError));
Serge Pavlov208ac652018-01-01 13:27:01 +0000929
930 // Try parsing configuration file.
931 if (!ContainsError)
932 ContainsError = loadConfigFile();
933 bool HasConfigFile = !ContainsError && (CfgOptions.get() != nullptr);
934
935 // All arguments, from both config file and command line.
936 InputArgList Args = std::move(HasConfigFile ? std::move(*CfgOptions)
937 : std::move(*CLOptions));
Hans Wennborg797004d2018-11-08 11:27:04 +0000938
939 auto appendOneArg = [&Args](const Arg *Opt, const Arg *BaseArg) {
Serge Pavlovf015a562018-04-26 06:28:47 +0000940 unsigned Index = Args.MakeIndex(Opt->getSpelling());
Serge Pavlov208ac652018-01-01 13:27:01 +0000941 Arg *Copy = new llvm::opt::Arg(Opt->getOption(), Opt->getSpelling(),
Serge Pavlovf015a562018-04-26 06:28:47 +0000942 Index, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000943 Copy->getValues() = Opt->getValues();
944 if (Opt->isClaimed())
945 Copy->claim();
946 Args.append(Copy);
Hans Wennborg797004d2018-11-08 11:27:04 +0000947 };
948
949 if (HasConfigFile)
950 for (auto *Opt : *CLOptions) {
951 if (Opt->getOption().matches(options::OPT_config))
952 continue;
953 const Arg *BaseArg = &Opt->getBaseArg();
954 if (BaseArg == Opt)
955 BaseArg = nullptr;
956 appendOneArg(Opt, BaseArg);
Serge Pavlov208ac652018-01-01 13:27:01 +0000957 }
958
Hans Wennborg797004d2018-11-08 11:27:04 +0000959 // In CL mode, look for any pass-through arguments
960 if (IsCLMode() && !ContainsError) {
961 SmallVector<const char *, 16> CLModePassThroughArgList;
962 for (const auto *A : Args.filtered(options::OPT__SLASH_clang)) {
963 A->claim();
964 CLModePassThroughArgList.push_back(A->getValue());
965 }
966
967 if (!CLModePassThroughArgList.empty()) {
968 // Parse any pass through args using default clang processing rather
969 // than clang-cl processing.
970 auto CLModePassThroughOptions = llvm::make_unique<InputArgList>(
971 ParseArgStrings(CLModePassThroughArgList, false, ContainsError));
972
973 if (!ContainsError)
974 for (auto *Opt : *CLModePassThroughOptions) {
975 appendOneArg(Opt, nullptr);
976 }
977 }
978 }
979
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000980 // FIXME: This stuff needs to go into the Compilation, not the driver.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000981 bool CCCPrintPhases;
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000982
Filipe Cabecinhas136f35e2015-07-18 06:35:24 +0000983 // Silence driver warnings if requested
984 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
985
Rafael Espindola59ae7992009-12-07 18:28:29 +0000986 // -no-canonical-prefixes is used very early in main.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000987 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
Rafael Espindola59ae7992009-12-07 18:28:29 +0000988
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000989 // Ignore -pipe.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000990 Args.ClaimAllArgs(options::OPT_pipe);
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000991
Daniel Dunbaracd69572009-12-04 21:55:23 +0000992 // Extract -ccc args.
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000993 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000994 // FIXME: We need to figure out where this behavior should live. Most of it
995 // should be outside in the client; the parts that aren't should have proper
996 // options, either by introducing new ones or by overloading gcc ones like -V
997 // or -b.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000998 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
David Blaikie69a1d8c2015-06-22 22:07:27 +0000999 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
1000 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
Richard Smithbd55daf2012-11-01 04:30:05 +00001001 CCCGenericGCCName = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001002 CCCUsePCH =
1003 Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
Bruno Cardoso Lopes52dfe712017-04-12 21:46:20 +00001004 GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
1005 options::OPT_fno_crash_diagnostics,
1006 !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
Petr Hosekdd38d932018-05-29 22:35:39 +00001007 // FIXME: TargetTriple is used by the target-prefixed calls to as/ld
Joerg Sonnenberger17d75512012-02-22 19:15:16 +00001008 // and getToolChain is const.
Hans Wennborg2e274592013-08-13 23:38:57 +00001009 if (IsCLMode()) {
Hans Wennborg73609a02014-03-28 01:19:04 +00001010 // clang-cl targets MSVC-style Win32.
Petr Hosekdd38d932018-05-29 22:35:39 +00001011 llvm::Triple T(TargetTriple);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +00001012 T.setOS(llvm::Triple::Win32);
Hans Wennborg0f0e8d62015-09-18 17:11:50 +00001013 T.setVendor(llvm::Triple::PC);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +00001014 T.setEnvironment(llvm::Triple::MSVC);
Oleg Ranevskyy80523182017-08-31 20:31:30 +00001015 T.setObjectFormat(llvm::Triple::COFF);
Petr Hosekdd38d932018-05-29 22:35:39 +00001016 TargetTriple = T.str();
Hans Wennborg2e274592013-08-13 23:38:57 +00001017 }
David Blaikie69a1d8c2015-06-22 22:07:27 +00001018 if (const Arg *A = Args.getLastArg(options::OPT_target))
Petr Hosekdd38d932018-05-29 22:35:39 +00001019 TargetTriple = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001020 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
Richard Smithbd55daf2012-11-01 04:30:05 +00001021 Dir = InstalledDir = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001022 for (const Arg *A : Args.filtered(options::OPT_B)) {
Benjamin Kramer1a648d12011-02-08 20:31:42 +00001023 A->claim();
Richard Smithbd55daf2012-11-01 04:30:05 +00001024 PrefixDirs.push_back(A->getValue(0));
Benjamin Kramer1a648d12011-02-08 20:31:42 +00001025 }
David Blaikie69a1d8c2015-06-22 22:07:27 +00001026 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
Richard Smithbd55daf2012-11-01 04:30:05 +00001027 SysRoot = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +00001028 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
Peter Collingbourne9d9e1fc2013-05-27 21:40:20 +00001029 DyldPrefix = A->getValue();
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001030
David Blaikie69a1d8c2015-06-22 22:07:27 +00001031 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
Bob Wilsona20a1da2013-03-23 05:17:59 +00001032 ResourceDir = A->getValue();
Jim Grosbach061dabf2013-03-12 20:17:58 +00001033
David Blaikie69a1d8c2015-06-22 22:07:27 +00001034 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001035 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
1036 .Case("cwd", SaveTempsCwd)
1037 .Case("obj", SaveTempsObj)
1038 .Default(SaveTempsCwd);
1039 }
1040
Steven Wu1257cd82016-05-18 17:04:52 +00001041 setLTOMode(Args);
1042
Steven Wu844ab6a2016-11-16 06:06:44 +00001043 // Process -fembed-bitcode= flags.
1044 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
1045 StringRef Name = A->getValue();
1046 unsigned Model = llvm::StringSwitch<unsigned>(Name)
1047 .Case("off", EmbedNone)
1048 .Case("all", EmbedBitcode)
1049 .Case("bitcode", EmbedBitcode)
1050 .Case("marker", EmbedMarker)
1051 .Default(~0U);
1052 if (Model == ~0U) {
1053 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
1054 << Name;
1055 } else
1056 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
Steven Wu574b0f22016-03-01 01:07:58 +00001057 }
1058
David Blaikie69a1d8c2015-06-22 22:07:27 +00001059 std::unique_ptr<llvm::opt::InputArgList> UArgs =
1060 llvm::make_unique<InputArgList>(std::move(Args));
1061
Daniel Dunbar775d4062010-06-11 22:00:26 +00001062 // Perform the default argument translations.
David Blaikie69a1d8c2015-06-22 22:07:27 +00001063 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
Daniel Dunbar775d4062010-06-11 22:00:26 +00001064
Chandler Carruthcb916192012-01-25 08:49:21 +00001065 // Owned by the host.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00001066 const ToolChain &TC = getToolChain(
Petr Hosekdd38d932018-05-29 22:35:39 +00001067 *UArgs, computeTargetTriple(*this, TargetTriple, *UArgs));
Chandler Carruthcb916192012-01-25 08:49:21 +00001068
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00001069 // The compilation takes ownership of Args.
Benjamin Kramer43c0f482017-06-30 13:21:27 +00001070 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs,
1071 ContainsError);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001072
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001073 if (!HandleImmediateArgs(*C))
1074 return C;
1075
Chad Rosierecdede82011-08-12 22:08:57 +00001076 // Construct the list of inputs.
1077 InputList Inputs;
Hans Wennborged1d0722013-08-13 21:32:29 +00001078 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
Chad Rosierecdede82011-08-12 22:08:57 +00001079
Samuel Antaoc1ffba52016-06-13 18:10:57 +00001080 // Populate the tool chains for the offloading devices, if any.
1081 CreateOffloadingDeviceToolChains(*C, Inputs);
Justin Lebar0e450a52016-03-30 23:30:25 +00001082
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001083 // Construct the list of abstract actions to perform for this compilation. On
Tim Northover157d9112014-01-16 08:48:16 +00001084 // MachO targets this uses the driver-driver and universal actions.
1085 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001086 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001087 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001088 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001089
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001090 if (CCCPrintPhases) {
Daniel Dunbareb843be2009-03-18 03:13:20 +00001091 PrintActions(*C);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001092 return C;
1093 }
1094
1095 BuildJobs(*C);
Daniel Dunbaradc91e62009-03-15 01:38:15 +00001096
1097 return C;
Daniel Dunbaree66cf22009-03-10 20:52:46 +00001098}
1099
Justin Bognered9cbe02015-07-09 06:58:31 +00001100static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
1101 llvm::opt::ArgStringList ASL;
1102 for (const auto *A : Args)
1103 A->render(Args, ASL);
1104
1105 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
1106 if (I != ASL.begin())
1107 OS << ' ';
1108 Command::printArg(OS, *I, true);
1109 }
1110 OS << '\n';
1111}
1112
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001113bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
1114 SmallString<128> &CrashDiagDir) {
1115 using namespace llvm::sys;
1116 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
1117 "Only knows about .crash files on Darwin");
1118
1119 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
1120 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
1121 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
1122 path::home_directory(CrashDiagDir);
1123 if (CrashDiagDir.startswith("/var/root"))
1124 CrashDiagDir = "/";
1125 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
1126 int PID =
1127#if LLVM_ON_UNIX
1128 getpid();
1129#else
1130 0;
1131#endif
1132 std::error_code EC;
1133 fs::file_status FileStatus;
1134 TimePoint<> LastAccessTime;
1135 SmallString<128> CrashFilePath;
1136 // Lookup the .crash files and get the one generated by a subprocess spawned
1137 // by this driver invocation.
1138 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
1139 File != FileEnd && !EC; File.increment(EC)) {
1140 StringRef FileName = path::filename(File->path());
1141 if (!FileName.startswith(Name))
1142 continue;
1143 if (fs::status(File->path(), FileStatus))
1144 continue;
1145 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
1146 llvm::MemoryBuffer::getFile(File->path());
1147 if (!CrashFile)
1148 continue;
1149 // The first line should start with "Process:", otherwise this isn't a real
1150 // .crash file.
1151 StringRef Data = CrashFile.get()->getBuffer();
1152 if (!Data.startswith("Process:"))
1153 continue;
1154 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
1155 size_t ParentProcPos = Data.find("Parent Process:");
1156 if (ParentProcPos == StringRef::npos)
1157 continue;
1158 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
1159 if (LineEnd == StringRef::npos)
1160 continue;
1161 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
1162 int OpenBracket = -1, CloseBracket = -1;
1163 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
1164 if (ParentProcess[i] == '[')
1165 OpenBracket = i;
1166 if (ParentProcess[i] == ']')
1167 CloseBracket = i;
1168 }
1169 // Extract the parent process PID from the .crash file and check whether
1170 // it matches this driver invocation pid.
1171 int CrashPID;
1172 if (OpenBracket < 0 || CloseBracket < 0 ||
1173 ParentProcess.slice(OpenBracket + 1, CloseBracket)
1174 .getAsInteger(10, CrashPID) || CrashPID != PID) {
1175 continue;
1176 }
1177
1178 // Found a .crash file matching the driver pid. To avoid getting an older
1179 // and misleading crash file, continue looking for the most recent.
1180 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
1181 // multiple crashes poiting to the same parent process. Since the driver
1182 // does not collect pid information for the dispatched invocation there's
1183 // currently no way to distinguish among them.
1184 const auto FileAccessTime = FileStatus.getLastModificationTime();
1185 if (FileAccessTime > LastAccessTime) {
1186 CrashFilePath.assign(File->path());
1187 LastAccessTime = FileAccessTime;
1188 }
1189 }
1190
1191 // If found, copy it over to the location of other reproducer files.
1192 if (!CrashFilePath.empty()) {
1193 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
1194 if (EC)
1195 return false;
1196 return true;
1197 }
1198
1199 return false;
1200}
1201
Eric Christopherf901e852011-08-17 22:59:59 +00001202// When clang crashes, produce diagnostic information including the fully
1203// preprocessed source file(s). Request that the developer attach the
Chad Rosierbe10f982011-08-02 17:58:04 +00001204// diagnostic information to a bug report.
Alex Lorenz045c5142018-04-07 00:03:27 +00001205void Driver::generateCompilationDiagnostics(
1206 Compilation &C, const Command &FailingCommand,
1207 StringRef AdditionalInformation, CompilationDiagnosticReport *Report) {
Chad Rosier877c0a22012-02-22 00:30:39 +00001208 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
Chad Rosier62135492012-07-09 17:31:28 +00001209 return;
Chad Rosierbee5a1d2012-03-07 00:30:40 +00001210
Chad Rosierdbf46a12013-02-01 18:30:26 +00001211 // Don't try to generate diagnostics for link or dsymutil jobs.
Justin Bognere1a33d12014-10-20 21:02:05 +00001212 if (FailingCommand.getCreator().isLinkJob() ||
1213 FailingCommand.getCreator().isDsymutilJob())
Chad Rosier877c0a22012-02-22 00:30:39 +00001214 return;
1215
Chad Rosier8179f112012-06-19 17:51:34 +00001216 // Print the version of the compiler.
1217 PrintVersion(C, llvm::errs());
1218
Chad Rosierbe10f982011-08-02 17:58:04 +00001219 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001220 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
1221 "crash backtrace, preprocessed source, and associated run script.";
Chad Rosierbe10f982011-08-02 17:58:04 +00001222
1223 // Suppress driver output and emit preprocessor output to temp file.
Hans Wennborg70850d82013-07-18 20:29:38 +00001224 Mode = CPPMode;
Chad Rosierbe10f982011-08-02 17:58:04 +00001225 CCGenDiagnostics = true;
1226
Chad Rosiercdb008d2011-11-02 21:29:05 +00001227 // Save the original job command(s).
Justin Bogner25645152014-10-21 17:24:44 +00001228 Command Cmd = FailingCommand;
Chad Rosiercdb008d2011-11-02 21:29:05 +00001229
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001230 // Keep track of whether we produce any errors while trying to produce
1231 // preprocessed sources.
1232 DiagnosticErrorTrap Trap(Diags);
1233
1234 // Suppress tool output.
Chad Rosierbe10f982011-08-02 17:58:04 +00001235 C.initCompilationForDiagnostics();
Chad Rosierecdede82011-08-12 22:08:57 +00001236
1237 // Construct the list of inputs.
1238 InputList Inputs;
1239 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001240
Chad Rosier4f81fc22011-08-12 23:30:05 +00001241 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001242 bool IgnoreInput = false;
1243
1244 // Ignore input from stdin or any inputs that cannot be preprocessed.
Paul Robinsonf44157d2014-04-28 22:24:44 +00001245 // Check type first as not all linker inputs have a value.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001246 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
Paul Robinsonf44157d2014-04-28 22:24:44 +00001247 IgnoreInput = true;
1248 } else if (!strcmp(it->second->getValue(), "-")) {
Chad Rosierd57133d2011-08-18 00:22:25 +00001249 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001250 << "Error generating preprocessed source(s) - "
1251 "ignoring input from stdin.";
Chad Rosierd57133d2011-08-18 00:22:25 +00001252 IgnoreInput = true;
Chad Rosierd57133d2011-08-18 00:22:25 +00001253 }
1254
1255 if (IgnoreInput) {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001256 it = Inputs.erase(it);
1257 ie = Inputs.end();
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001258 } else {
Chad Rosier4f81fc22011-08-12 23:30:05 +00001259 ++it;
Chad Rosier6fdf38b2011-08-17 23:08:45 +00001260 }
Chad Rosier4f81fc22011-08-12 23:30:05 +00001261 }
Chad Rosierd57133d2011-08-18 00:22:25 +00001262
Chad Rosierc5103c32013-01-29 23:57:10 +00001263 if (Inputs.empty()) {
1264 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001265 << "Error generating preprocessed source(s) - "
1266 "no preprocessable inputs.";
Chad Rosierc5103c32013-01-29 23:57:10 +00001267 return;
1268 }
1269
Chad Rosiere75ef402011-09-06 23:52:36 +00001270 // Don't attempt to generate preprocessed files if multiple -arch options are
Chad Rosier636d2832012-02-13 18:16:28 +00001271 // used, unless they're all duplicates.
1272 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001273 for (const Arg *A : C.getArgs()) {
Chad Rosiere75ef402011-09-06 23:52:36 +00001274 if (A->getOption().matches(options::OPT_arch)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001275 StringRef ArchName = A->getValue();
Chad Rosier636d2832012-02-13 18:16:28 +00001276 ArchNames.insert(ArchName);
Chad Rosiere75ef402011-09-06 23:52:36 +00001277 }
1278 }
Chad Rosier636d2832012-02-13 18:16:28 +00001279 if (ArchNames.size() > 1) {
1280 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001281 << "Error generating preprocessed source(s) - cannot generate "
1282 "preprocessed source with multiple -arch options.";
Chad Rosier636d2832012-02-13 18:16:28 +00001283 return;
1284 }
Chad Rosiere75ef402011-09-06 23:52:36 +00001285
Chandler Carruth7f1417f2012-01-24 10:43:44 +00001286 // Construct the list of abstract actions to perform for this compilation. On
1287 // Darwin OSes this uses the driver-driver and builds universal actions.
Chandler Carruthcb916192012-01-25 08:49:21 +00001288 const ToolChain &TC = C.getDefaultToolChain();
Tim Northover157d9112014-01-16 08:48:16 +00001289 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001290 BuildUniversalActions(C, TC, Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +00001291 else
Justin Lebar0f3474c2016-02-11 02:00:50 +00001292 BuildActions(C, C.getArgs(), Inputs, C.getActions());
Chad Rosierbe10f982011-08-02 17:58:04 +00001293
1294 BuildJobs(C);
1295
1296 // If there were errors building the compilation, quit now.
Richard Smith5bb4cdf2012-12-20 02:22:15 +00001297 if (Trap.hasErrorOccurred()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001298 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001299 << "Error generating preprocessed source(s).";
Chad Rosierbe10f982011-08-02 17:58:04 +00001300 return;
1301 }
1302
1303 // Generate preprocessed output.
Chad Rosierdd60e092013-01-29 20:15:05 +00001304 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
Justin Bogner0cd92482015-07-02 22:52:08 +00001305 C.ExecuteJobs(C.getJobs(), FailingCommands);
Chad Rosierbe10f982011-08-02 17:58:04 +00001306
Justin Bognerbc89b182014-10-20 21:20:27 +00001307 // If any of the preprocessing commands failed, clean up and exit.
1308 if (!FailingCommands.empty()) {
Chad Rosierbe10f982011-08-02 17:58:04 +00001309 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001310 << "Error generating preprocessed source(s).";
Justin Bognerbc89b182014-10-20 21:20:27 +00001311 return;
Chad Rosierbe10f982011-08-02 17:58:04 +00001312 }
Justin Bognerbc89b182014-10-20 21:20:27 +00001313
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001314 const ArgStringList &TempFiles = C.getTempFiles();
1315 if (TempFiles.empty()) {
1316 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001317 << "Error generating preprocessed source(s).";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001318 return;
1319 }
1320
Justin Bognerbc89b182014-10-20 21:20:27 +00001321 Diag(clang::diag::note_drv_command_failed_diag_msg)
1322 << "\n********************\n\n"
1323 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
1324 "Preprocessed source(s) and associated run script(s) are located at:";
Justin Bognerbc89b182014-10-20 21:20:27 +00001325
Justin Bogner659ecc32014-10-20 22:47:23 +00001326 SmallString<128> VFS;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001327 SmallString<128> ReproCrashFilename;
Justin Bogner659ecc32014-10-20 22:47:23 +00001328 for (const char *TempFile : TempFiles) {
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001329 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
Alex Lorenz045c5142018-04-07 00:03:27 +00001330 if (Report)
1331 Report->TemporaryFiles.push_back(TempFile);
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001332 if (ReproCrashFilename.empty()) {
1333 ReproCrashFilename = TempFile;
1334 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
1335 }
Justin Bogner659ecc32014-10-20 22:47:23 +00001336 if (StringRef(TempFile).endswith(".cache")) {
1337 // In some cases (modules) we'll dump extra data to help with reproducing
1338 // the crash into a directory next to the output.
1339 VFS = llvm::sys::path::filename(TempFile);
1340 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
1341 }
1342 }
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001343
1344 // Assume associated files are based off of the first temporary file.
Justin Bogner25645152014-10-21 17:24:44 +00001345 CrashReportInfo CrashInfo(TempFiles[0], VFS);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001346
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001347 llvm::SmallString<128> Script(CrashInfo.Filename);
1348 llvm::sys::path::replace_extension(Script, "sh");
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001349 std::error_code EC;
Zachary Turner1f67a3c2018-06-07 19:58:58 +00001350 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::CD_CreateNew);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001351 if (EC) {
1352 Diag(clang::diag::note_drv_command_failed_diag_msg)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001353 << "Error generating run script: " << Script << " " << EC.message();
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001354 } else {
Justin Bogner42220ed2015-03-12 00:14:35 +00001355 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
Justin Bognered9cbe02015-07-09 06:58:31 +00001356 << "# Driver args: ";
1357 printArgList(ScriptOS, C.getInputArgs());
1358 ScriptOS << "# Original command: ";
Justin Bogner42220ed2015-03-12 00:14:35 +00001359 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
Justin Bogner33bdbc62014-10-21 18:03:08 +00001360 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
Alex Lorenz045c5142018-04-07 00:03:27 +00001361 if (!AdditionalInformation.empty())
1362 ScriptOS << "\n# Additional information: " << AdditionalInformation
1363 << "\n";
1364 if (Report)
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00001365 Report->TemporaryFiles.push_back(Script.str());
Justin Bognerc1fdf7f2014-10-20 21:47:56 +00001366 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
Justin Bognerbc89b182014-10-20 21:20:27 +00001367 }
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001368
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +00001369 // On darwin, provide information about the .crash diagnostic report.
1370 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
1371 SmallString<128> CrashDiagDir;
1372 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
1373 Diag(clang::diag::note_drv_command_failed_diag_msg)
1374 << ReproCrashFilename.str();
1375 } else { // Suggest a directory for the user to look for .crash files.
1376 llvm::sys::path::append(CrashDiagDir, Name);
1377 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
1378 Diag(clang::diag::note_drv_command_failed_diag_msg)
1379 << "Crash backtrace is located in";
1380 Diag(clang::diag::note_drv_command_failed_diag_msg)
1381 << CrashDiagDir.str();
1382 Diag(clang::diag::note_drv_command_failed_diag_msg)
1383 << "(choose the .crash file that corresponds to your crash)";
1384 }
1385 }
1386
Saleem Abdulrasool3661a822015-01-12 02:33:09 +00001387 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1388 options::OPT_frewrite_map_file_EQ))
1389 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1390
Justin Bognerbc89b182014-10-20 21:20:27 +00001391 Diag(clang::diag::note_drv_command_failed_diag_msg)
1392 << "\n\n********************";
Chad Rosierbe10f982011-08-02 17:58:04 +00001393}
1394
Justin Bogner0cd92482015-07-02 22:52:08 +00001395void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
Oleg Ranevskyycd516372016-01-05 19:54:39 +00001396 // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001397 // if the tool does not support response files, there is a chance/ that things
1398 // will just work without a response file, so we silently just skip it.
Justin Bogner0cd92482015-07-02 22:52:08 +00001399 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
Oleg Ranevskyycd516372016-01-05 19:54:39 +00001400 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001401 return;
1402
1403 std::string TmpName = GetTemporaryPath("response", "txt");
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00001404 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001405}
1406
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001407int Driver::ExecuteCompilation(
1408 Compilation &C,
1409 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001410 // Just print if -### was present.
1411 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Hans Wennborgb212b342013-09-12 18:23:34 +00001412 C.getJobs().Print(llvm::errs(), "\n", true);
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001413 return 0;
1414 }
1415
1416 // If there were errors building the compilation, quit now.
Chad Rosierbe10f982011-08-02 17:58:04 +00001417 if (Diags.hasErrorOccurred())
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001418 return 1;
1419
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001420 // Set up response file names for each command, if necessary
Justin Bogner0cd92482015-07-02 22:52:08 +00001421 for (auto &Job : C.getJobs())
1422 setUpResponseFiles(C, Job);
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001423
Justin Bogner0cd92482015-07-02 22:52:08 +00001424 C.ExecuteJobs(C.getJobs(), FailingCommands);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001425
Daniel Dunbar07494792010-05-22 00:37:20 +00001426 // If the command succeeded, we are done.
Chad Rosierdd60e092013-01-29 20:15:05 +00001427 if (FailingCommands.empty())
1428 return 0;
Daniel Dunbar07494792010-05-22 00:37:20 +00001429
Chad Rosierdd60e092013-01-29 20:15:05 +00001430 // Otherwise, remove result files and print extra information about abnormal
1431 // failures.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001432 int Res = 0;
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001433 for (const auto &CmdPair : FailingCommands) {
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001434 int CommandRes = CmdPair.first;
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001435 const Command *FailingCommand = CmdPair.second;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001436
Chad Rosierdd60e092013-01-29 20:15:05 +00001437 // Remove result files if we're not saving temps.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001438 if (!isSaveTempsEnabled()) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001439 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1440 C.CleanupFileMap(C.getResultFiles(), JA, true);
1441
1442 // Failure result files are valid unless we crashed.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001443 if (CommandRes < 0)
Chad Rosierdd60e092013-01-29 20:15:05 +00001444 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1445 }
1446
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001447#if LLVM_ON_UNIX
1448 // llvm/lib/Support/Unix/Signals.inc will exit with a special return code
1449 // for SIGPIPE. Do not print diagnostics for this case.
1450 if (CommandRes == EX_IOERR) {
1451 Res = CommandRes;
1452 continue;
1453 }
1454#endif
1455
Chad Rosierdd60e092013-01-29 20:15:05 +00001456 // Print extra information about abnormal failures, if possible.
1457 //
1458 // This is ad-hoc, but we don't want to be excessively noisy. If the result
Justin Bogner5aaf2e72014-06-26 20:59:36 +00001459 // status was 1, assume the command failed normally. In particular, if it
Chad Rosierdd60e092013-01-29 20:15:05 +00001460 // was the compiler then assume it gave a reasonable error code. Failures
1461 // in other tools are less common, and they generally have worse
1462 // diagnostics, so always print the diagnostic there.
1463 const Tool &FailingTool = FailingCommand->getCreator();
1464
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001465 if (!FailingCommand->getCreator().hasGoodDiagnostics() || CommandRes != 1) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001466 // FIXME: See FIXME above regarding result code interpretation.
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001467 if (CommandRes < 0)
Chad Rosierdd60e092013-01-29 20:15:05 +00001468 Diag(clang::diag::err_drv_command_signalled)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001469 << FailingTool.getShortName();
Chad Rosierdd60e092013-01-29 20:15:05 +00001470 else
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001471 Diag(clang::diag::err_drv_command_failed)
1472 << FailingTool.getShortName() << CommandRes;
Chad Rosierdd60e092013-01-29 20:15:05 +00001473 }
Peter Collingbourne119cfaa2011-11-21 00:01:05 +00001474 }
Nick Desaulniers9d0df312018-10-15 17:39:00 +00001475 return Res;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001476}
1477
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001478void Driver::PrintHelp(bool ShowHidden) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001479 unsigned IncludedFlagsBitmask;
1480 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001481 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Hans Wennborg797004d2018-11-08 11:27:04 +00001482 getIncludeExcludeOptionFlagMasks(IsCLMode());
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001483
1484 ExcludedFlagsBitmask |= options::NoDriverOption;
1485 if (!ShowHidden)
1486 ExcludedFlagsBitmask |= HelpHidden;
1487
Fangrui Songd0028232018-10-10 00:15:33 +00001488 std::string Usage = llvm::formatv("{0} [options] file...", Name).str();
1489 getOpts().PrintHelp(llvm::outs(), Usage.c_str(), DriverTitle.c_str(),
George Rimar5dbfa4e2017-07-26 09:10:17 +00001490 IncludedFlagsBitmask, ExcludedFlagsBitmask,
1491 /*ShowAllAliases=*/false);
Daniel Dunbar7c925282009-03-31 21:38:17 +00001492}
1493
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001494void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001495 // FIXME: The following handlers should use a callback mechanism, we don't
1496 // know what the client would like to do.
Ted Kremenek4c0df3d2010-01-23 02:11:34 +00001497 OS << getClangFullVersion() << '\n';
Daniel Dunbarb10248802009-03-26 16:09:13 +00001498 const ToolChain &TC = C.getDefaultToolChain();
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001499 OS << "Target: " << TC.getTripleString() << '\n';
Daniel Dunbar10978e42009-06-16 23:32:58 +00001500
1501 // Print the threading model.
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001502 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1503 // Don't print if the ToolChain would have barfed on it already
1504 if (TC.isThreadModelSupported(A->getValue()))
1505 OS << "Thread model: " << A->getValue();
1506 } else
1507 OS << "Thread model: " << TC.getThreadModel();
1508 OS << '\n';
Chandler Carruth9ade6a92015-08-05 17:07:33 +00001509
1510 // Print out the install directory.
1511 OS << "InstalledDir: " << InstalledDir << '\n';
Serge Pavlov208ac652018-01-01 13:27:01 +00001512
1513 // If configuration file was used, print its path.
1514 if (!ConfigFile.empty())
1515 OS << "Configuration file: " << ConfigFile << '\n';
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001516}
1517
Chris Lattner86ed5b02010-05-05 05:53:24 +00001518/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1519/// option.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001520static void PrintDiagnosticCategories(raw_ostream &OS) {
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001521 // Skip the empty category.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001522 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1523 ++i)
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001524 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
Chris Lattner86ed5b02010-05-05 05:53:24 +00001525}
1526
Yuka Takahashi41789e42018-03-05 08:54:20 +00001527void Driver::HandleAutocompletions(StringRef PassedFlags) const {
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001528 if (PassedFlags == "")
1529 return;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001530 // Print out all options that start with a given argument. This is used for
1531 // shell autocompletion.
1532 std::vector<std::string> SuggestedCompletions;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001533 std::vector<std::string> Flags;
Yuka Takahashi1a895202017-08-29 17:46:46 +00001534
1535 unsigned short DisableFlags =
1536 options::NoDriverOption | options::Unsupported | options::Ignored;
Yuka Takahashi41789e42018-03-05 08:54:20 +00001537
Yuka Takahashi46106f52018-10-24 12:43:25 +00001538 // Distinguish "--autocomplete=-someflag" and "--autocomplete=-someflag,"
1539 // because the latter indicates that the user put space before pushing tab
1540 // which should end up in a file completion.
1541 const bool HasSpace = PassedFlags.endswith(",");
1542
Yuka Takahashi41789e42018-03-05 08:54:20 +00001543 // Parse PassedFlags by "," as all the command-line flags are passed to this
1544 // function separated by ","
1545 StringRef TargetFlags = PassedFlags;
1546 while (TargetFlags != "") {
1547 StringRef CurFlag;
1548 std::tie(CurFlag, TargetFlags) = TargetFlags.split(",");
1549 Flags.push_back(std::string(CurFlag));
Yuka Takahashi1a895202017-08-29 17:46:46 +00001550 }
1551
Yuka Takahashi41789e42018-03-05 08:54:20 +00001552 // We want to show cc1-only options only when clang is invoked with -cc1 or
1553 // -Xclang.
Yuka Takahashi503da8f2018-03-05 09:01:31 +00001554 if (std::find(Flags.begin(), Flags.end(), "-Xclang") != Flags.end() ||
1555 std::find(Flags.begin(), Flags.end(), "-cc1") != Flags.end())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001556 DisableFlags &= ~options::NoDriverOption;
1557
1558 StringRef Cur;
1559 Cur = Flags.at(Flags.size() - 1);
1560 StringRef Prev;
1561 if (Flags.size() >= 2) {
1562 Prev = Flags.at(Flags.size() - 2);
1563 SuggestedCompletions = Opts->suggestValueCompletions(Prev, Cur);
1564 }
1565
1566 if (SuggestedCompletions.empty())
1567 SuggestedCompletions = Opts->suggestValueCompletions(Cur, "");
1568
Yuka Takahashi46106f52018-10-24 12:43:25 +00001569 // If Flags were empty, it means the user typed `clang [tab]` where we should
1570 // list all possible flags. If there was no value completion and the user
1571 // pressed tab after a space, we should fall back to a file completion.
1572 // We're printing a newline to be consistent with what we print at the end of
1573 // this function.
1574 if (SuggestedCompletions.empty() && HasSpace && !Flags.empty()) {
1575 llvm::outs() << '\n';
1576 return;
1577 }
1578
Yuka Takahashidf9c7e32018-10-24 08:24:16 +00001579 // When flag ends with '=' and there was no value completion, return empty
1580 // string and fall back to the file autocompletion.
1581 if (SuggestedCompletions.empty() && !Cur.endswith("=")) {
Yuka Takahashi1a895202017-08-29 17:46:46 +00001582 // If the flag is in the form of "--autocomplete=-foo",
1583 // we were requested to print out all option names that start with "-foo".
1584 // For example, "--autocomplete=-fsyn" is expanded to "-fsyntax-only".
Yuka Takahashi41789e42018-03-05 08:54:20 +00001585 SuggestedCompletions = Opts->findByPrefix(Cur, DisableFlags);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001586
1587 // We have to query the -W flags manually as they're not in the OptTable.
1588 // TODO: Find a good way to add them to OptTable instead and them remove
1589 // this code.
1590 for (StringRef S : DiagnosticIDs::getDiagnosticFlags())
Yuka Takahashi41789e42018-03-05 08:54:20 +00001591 if (S.startswith(Cur))
Yuka Takahashi1a895202017-08-29 17:46:46 +00001592 SuggestedCompletions.push_back(S);
Yuka Takahashi1a895202017-08-29 17:46:46 +00001593 }
1594
1595 // Sort the autocomplete candidates so that shells print them out in a
1596 // deterministic order. We could sort in any way, but we chose
1597 // case-insensitive sorting for consistency with the -help option
1598 // which prints out options in the case-insensitive alphabetical order.
Fangrui Song55fab262018-09-26 22:16:28 +00001599 llvm::sort(SuggestedCompletions, [](StringRef A, StringRef B) {
1600 if (int X = A.compare_lower(B))
1601 return X < 0;
1602 return A.compare(B) > 0;
1603 });
Yuka Takahashi1a895202017-08-29 17:46:46 +00001604
1605 llvm::outs() << llvm::join(SuggestedCompletions, "\n") << '\n';
1606}
1607
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001608bool Driver::HandleImmediateArgs(const Compilation &C) {
Daniel Dunbar18974bd2010-06-11 22:00:19 +00001609 // The order these options are handled in gcc is all over the place, but we
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001610 // don't expect inconsistencies w.r.t. that to matter in practice.
Daniel Dunbar7c925282009-03-31 21:38:17 +00001611
Daniel Dunbar1b09e042010-09-17 02:47:28 +00001612 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1613 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1614 return false;
1615 }
1616
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001617 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
Daniel Dunbare26e5002011-01-12 00:43:47 +00001618 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1619 // return an answer which matches our definition of __VERSION__.
1620 //
1621 // If we want to return a more correct answer some day, then we should
1622 // introduce a non-pedantically GCC compatible mode to Clang in which we
1623 // provide sensible definitions for -dumpversion, __VERSION__, etc.
1624 llvm::outs() << "4.2.1\n";
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001625 return false;
1626 }
Daniel Dunbarfb3d7472010-06-14 21:23:12 +00001627
Chris Lattner86ed5b02010-05-05 05:53:24 +00001628 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1629 PrintDiagnosticCategories(llvm::outs());
1630 return false;
1631 }
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001632
James Molloya3c85b82012-05-01 14:57:16 +00001633 if (C.getArgs().hasArg(options::OPT_help) ||
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001634 C.getArgs().hasArg(options::OPT__help_hidden)) {
1635 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
Daniel Dunbar7c925282009-03-31 21:38:17 +00001636 return false;
1637 }
1638
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001639 if (C.getArgs().hasArg(options::OPT__version)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001640 // Follow gcc behavior and use stdout for --version and stderr for -v.
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001641 PrintVersion(C, llvm::outs());
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001642 return false;
1643 }
1644
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001645 if (C.getArgs().hasArg(options::OPT_v) ||
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001646 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001647 PrintVersion(C, llvm::errs());
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001648 SuppressMissingInputWarning = true;
1649 }
1650
Serge Pavlov208ac652018-01-01 13:27:01 +00001651 if (C.getArgs().hasArg(options::OPT_v)) {
1652 if (!SystemConfigDir.empty())
1653 llvm::errs() << "System configuration file directory: "
1654 << SystemConfigDir << "\n";
1655 if (!UserConfigDir.empty())
1656 llvm::errs() << "User configuration file directory: "
1657 << UserConfigDir << "\n";
1658 }
1659
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001660 const ToolChain &TC = C.getDefaultToolChain();
Chandler Carruth0ae39aa2013-07-30 17:57:09 +00001661
1662 if (C.getArgs().hasArg(options::OPT_v))
1663 TC.printVerboseInfo(llvm::errs());
1664
Meador Inge51208a32017-04-04 21:46:50 +00001665 if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
Meador Ingea9113952017-04-05 22:27:20 +00001666 llvm::outs() << ResourceDir << '\n';
Meador Inge51208a32017-04-04 21:46:50 +00001667 return false;
1668 }
1669
Daniel Dunbard972e222009-03-20 04:37:21 +00001670 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1671 llvm::outs() << "programs: =";
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001672 bool separator = false;
1673 for (const std::string &Path : TC.getProgramPaths()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001674 if (separator)
1675 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001676 llvm::outs() << Path;
1677 separator = true;
Daniel Dunbard972e222009-03-20 04:37:21 +00001678 }
1679 llvm::outs() << "\n";
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001680 llvm::outs() << "libraries: =" << ResourceDir;
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001681
Sebastian Pop980920a2012-04-16 04:16:43 +00001682 StringRef sysroot = C.getSysRoot();
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001683
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001684 for (const std::string &Path : TC.getFilePaths()) {
1685 // Always print a separator. ResourceDir was the first item shown.
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001686 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001687 // Interpretation of leading '=' is needed only for NetBSD.
1688 if (Path[0] == '=')
Douglas Katzman26eabf62015-06-24 15:10:30 +00001689 llvm::outs() << sysroot << Path.substr(1);
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001690 else
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001691 llvm::outs() << Path;
Daniel Dunbard972e222009-03-20 04:37:21 +00001692 }
1693 llvm::outs() << "\n";
Daniel Dunbar7c925282009-03-31 21:38:17 +00001694 return false;
Daniel Dunbard972e222009-03-20 04:37:21 +00001695 }
1696
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001697 // FIXME: The following handlers should use a callback mechanism, we don't
1698 // know what the client would like to do.
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001699 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001700 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001701 return false;
1702 }
1703
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001704 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
Saleem Abdulrasoole5f3cf82018-05-01 18:40:42 +00001705 StringRef ProgName = A->getValue();
1706
1707 // Null program name cannot have a path.
1708 if (! ProgName.empty())
1709 llvm::outs() << GetProgramPath(ProgName, TC);
1710
1711 llvm::outs() << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001712 return false;
1713 }
1714
Yuka Takahashic8068db2017-05-23 18:39:08 +00001715 if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
Yuka Takahashiba5d4af2017-06-20 16:31:31 +00001716 StringRef PassedFlags = A->getValue();
Yuka Takahashi41789e42018-03-05 08:54:20 +00001717 HandleAutocompletions(PassedFlags);
Yuka Takahashic8068db2017-05-23 18:39:08 +00001718 return false;
1719 }
1720
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001721 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
Michal Gorny7cfe4802016-10-10 12:23:40 +00001722 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
Leo Li23bb21c2017-08-24 01:51:51 +00001723 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1724 RegisterEffectiveTriple TripleRAII(TC, Triple);
Michal Gorny7cfe4802016-10-10 12:23:40 +00001725 switch (RLT) {
1726 case ToolChain::RLT_CompilerRT:
1727 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1728 break;
1729 case ToolChain::RLT_Libgcc:
1730 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1731 break;
1732 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001733 return false;
1734 }
1735
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001736 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001737 for (const Multilib &Multilib : TC.getMultilibs())
1738 llvm::outs() << Multilib << "\n";
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001739 return false;
1740 }
1741
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001742 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
Christian Bruel6ccc4a72018-09-06 14:03:44 +00001743 const Multilib &Multilib = TC.getMultilib();
1744 if (Multilib.gccSuffix().empty())
1745 llvm::outs() << ".\n";
1746 else {
1747 StringRef Suffix(Multilib.gccSuffix());
1748 assert(Suffix.front() == '/');
1749 llvm::outs() << Suffix.substr(1) << "\n";
Jonathan Roelofs3fa96d82014-02-12 01:36:51 +00001750 }
Jonathan Roelofs0e7ec602014-02-12 01:29:25 +00001751 return false;
1752 }
Petr Hosekbc86a992018-08-16 00:22:03 +00001753
1754 if (C.getArgs().hasArg(options::OPT_print_target_triple)) {
1755 llvm::outs() << TC.getTripleString() << "\n";
1756 return false;
1757 }
1758
1759 if (C.getArgs().hasArg(options::OPT_print_effective_triple)) {
1760 const llvm::Triple Triple(TC.ComputeEffectiveClangTriple(C.getArgs()));
1761 llvm::outs() << Triple.getTriple() << "\n";
1762 return false;
1763 }
1764
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001765 return true;
1766}
1767
Douglas Katzmanfd528672015-06-11 15:05:22 +00001768// Display an action graph human-readably. Action A is the "sink" node
1769// and latest-occuring action. Traversal is in pre-order, visiting the
1770// inputs to each action before printing the action itself.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001771static unsigned PrintActions1(const Compilation &C, Action *A,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001772 std::map<Action *, unsigned> &Ids) {
Douglas Katzmanfd528672015-06-11 15:05:22 +00001773 if (Ids.count(A)) // A was already visited.
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001774 return Ids[A];
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001775
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001776 std::string str;
1777 llvm::raw_string_ostream os(str);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001778
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001779 os << Action::getClassName(A->getKind()) << ", ";
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001780 if (InputAction *IA = dyn_cast<InputAction>(A)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001781 os << "\"" << IA->getInputArg().getValue() << "\"";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001782 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001783 os << '"' << BIA->getArchName() << '"' << ", {"
Nico Weber5a459f82016-02-23 19:30:43 +00001784 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
Samuel Antaod06239d2016-07-15 23:13:27 +00001785 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1786 bool IsFirst = true;
1787 OA->doOnEachDependence(
1788 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1789 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1790 // sm_35 this will generate:
1791 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1792 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1793 if (!IsFirst)
1794 os << ", ";
1795 os << '"';
1796 if (TC)
1797 os << A->getOffloadingKindPrefix();
1798 else
1799 os << "host";
1800 os << " (";
1801 os << TC->getTriple().normalize();
1802
1803 if (BoundArch)
1804 os << ":" << BoundArch;
1805 os << ")";
1806 os << '"';
1807 os << " {" << PrintActions1(C, A, Ids) << "}";
1808 IsFirst = false;
1809 });
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001810 } else {
Samuel Antaod06239d2016-07-15 23:13:27 +00001811 const ActionList *AL = &A->getInputs();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00001812
Artem Belevich23256752015-09-22 17:23:09 +00001813 if (AL->size()) {
1814 const char *Prefix = "{";
1815 for (Action *PreRequisite : *AL) {
1816 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1817 Prefix = ", ";
1818 }
1819 os << "}";
1820 } else
1821 os << "{}";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001822 }
1823
Samuel Antaod06239d2016-07-15 23:13:27 +00001824 // Append offload info for all options other than the offloading action
1825 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1826 std::string offload_str;
1827 llvm::raw_string_ostream offload_os(offload_str);
1828 if (!isa<OffloadAction>(A)) {
1829 auto S = A->getOffloadingKindPrefix();
1830 if (!S.empty()) {
1831 offload_os << ", (" << S;
1832 if (A->getOffloadingArch())
1833 offload_os << ", " << A->getOffloadingArch();
1834 offload_os << ")";
1835 }
1836 }
1837
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001838 unsigned Id = Ids.size();
1839 Ids[A] = Id;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001840 llvm::errs() << Id << ": " << os.str() << ", "
Samuel Antaod06239d2016-07-15 23:13:27 +00001841 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001842
1843 return Id;
1844}
1845
Douglas Katzmanfd528672015-06-11 15:05:22 +00001846// Print the action graphs in a compilation C.
1847// For example "clang -c file1.c file2.c" is composed of two subgraphs.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001848void Driver::PrintActions(const Compilation &C) const {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001849 std::map<Action *, unsigned> Ids;
1850 for (Action *A : C.getActions())
1851 PrintActions1(C, A, Ids);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001852}
1853
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001854/// Check whether the given input tree contains any compilation or
Joerg Sonnenberger5fe4a7d2011-05-06 14:05:11 +00001855/// assembly actions.
1856static bool ContainsCompileOrAssembleAction(const Action *A) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001857 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
Bob Wilson23a55f12014-12-21 07:00:00 +00001858 isa<AssembleJobAction>(A))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001859 return true;
1860
Nico Weber5a459f82016-02-23 19:30:43 +00001861 for (const Action *Input : A->inputs())
Nico Weberfb80f962015-09-19 21:36:51 +00001862 if (ContainsCompileOrAssembleAction(Input))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001863 return true;
1864
1865 return false;
1866}
1867
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001868void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1869 const InputList &BAInputs) const {
1870 DerivedArgList &Args = C.getArgs();
1871 ActionList &Actions = C.getActions();
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001872 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1873 // Collect the list of architectures. Duplicates are allowed, but should only
1874 // be handled once (in the order seen).
Daniel Dunbare5dc4822009-03-13 20:33:35 +00001875 llvm::StringSet<> ArchNames;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001876 SmallVector<const char *, 4> Archs;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001877 for (Arg *A : Args) {
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001878 if (A->getOption().matches(options::OPT_arch)) {
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001879 // Validate the option here; we don't save the type here because its
1880 // particular spelling may participate in other driver choices.
1881 llvm::Triple::ArchType Arch =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001882 tools::darwin::getArchTypeForMachOArchName(A->getValue());
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001883 if (Arch == llvm::Triple::UnknownArch) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001884 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001885 continue;
1886 }
1887
Daniel Dunbar2da02722009-03-19 07:55:12 +00001888 A->claim();
David Blaikie61b86d42014-11-19 02:56:13 +00001889 if (ArchNames.insert(A->getValue()).second)
Richard Smithbd55daf2012-11-01 04:30:05 +00001890 Archs.push_back(A->getValue());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001891 }
1892 }
1893
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001894 // When there is no explicit arch for this platform, make sure we still bind
1895 // the architecture (to the default) so that -Xarch_ is handled correctly.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001896 if (!Archs.size())
Daniel Dunbarc3bd9f52012-11-08 03:38:26 +00001897 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001898
Daniel Dunbarf479c122009-03-12 18:40:18 +00001899 ActionList SingleActions;
Justin Lebar0f3474c2016-02-11 02:00:50 +00001900 BuildActions(C, Args, BAInputs, SingleActions);
Daniel Dunbarf479c122009-03-12 18:40:18 +00001901
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001902 // Add in arch bindings for every top level action, as well as lipo and
1903 // dsymutil steps if needed.
Nico Weberfb80f962015-09-19 21:36:51 +00001904 for (Action* Act : SingleActions) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001905 // Make sure we can lipo this kind of output. If not (and it is an actual
1906 // output) then we disallow, since we can't create an output file with the
1907 // right name without overwriting it. We could remove this oddity by just
1908 // changing the output names to include the arch, which would also fix
Daniel Dunbarf479c122009-03-12 18:40:18 +00001909 // -save-temps. Compatibility wins for now.
1910
Daniel Dunbare2ca3bd2009-03-13 17:46:02 +00001911 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
Daniel Dunbarf479c122009-03-12 18:40:18 +00001912 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001913 << types::getTypeName(Act->getType());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001914
1915 ActionList Inputs;
Justin Lebar41094612016-01-11 23:07:27 +00001916 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1917 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001918
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001919 // Lipo if necessary, we do it this way because we need to set the arch flag
1920 // so that -Xarch_ gets overwritten.
Daniel Dunbarf479c122009-03-12 18:40:18 +00001921 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1922 Actions.append(Inputs.begin(), Inputs.end());
1923 else
Justin Lebar41094612016-01-11 23:07:27 +00001924 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001925
Eric Christopher65c05fa2012-02-06 19:43:51 +00001926 // Handle debug info queries.
1927 Arg *A = Args.getLastArg(options::OPT_g_Group);
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001928 if (A && !A->getOption().matches(options::OPT_g0) &&
1929 !A->getOption().matches(options::OPT_gstabs) &&
1930 ContainsCompileOrAssembleAction(Actions.back())) {
Chad Rosier62135492012-07-09 17:31:28 +00001931
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001932 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1933 // have a compile input. We need to run 'dsymutil' ourselves in such cases
Eric Christopher776c26f2013-01-28 17:39:03 +00001934 // because the debug info will refer to a temporary object file which
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001935 // will be removed at the end of the compilation process.
1936 if (Act->getType() == types::TY_Image) {
1937 ActionList Inputs;
1938 Inputs.push_back(Actions.back());
1939 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001940 Actions.push_back(
1941 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001942 }
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001943
Ben Langmuir9b9a8d32014-02-06 18:53:25 +00001944 // Verify the debug info output.
Alp Tokere9d2bfc2014-01-17 02:06:23 +00001945 if (Args.hasArg(options::OPT_verify_debug_info)) {
Justin Lebar41094612016-01-11 23:07:27 +00001946 Action* LastAction = Actions.back();
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001947 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001948 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1949 LastAction, types::TY_Nothing));
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001950 }
1951 }
Daniel Dunbarf479c122009-03-12 18:40:18 +00001952 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001953}
1954
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001955/// Check that the file referenced by Value exists. If it doesn't,
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001956/// issue a diagnostic and return false.
Alp Toker8c8a8752013-12-03 06:53:35 +00001957static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001958 StringRef Value, types::ID Ty) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001959 if (!D.getCheckInputsExist())
1960 return true;
1961
1962 // stdin always exists.
1963 if (Value == "-")
1964 return true;
1965
1966 SmallString<64> Path(Value);
1967 if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
Yaron Keren92e1b622015-03-18 10:17:07 +00001968 if (!llvm::sys::path::is_absolute(Path)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001969 SmallString<64> Directory(WorkDir->getValue());
1970 llvm::sys::path::append(Directory, Value);
1971 Path.assign(Directory);
1972 }
1973 }
1974
Sam McCall2c782472018-11-08 16:57:01 +00001975 if (D.getVFS().exists(Path))
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001976 return true;
1977
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001978 if (D.IsCLMode()) {
1979 if (!llvm::sys::path::is_absolute(Twine(Path)) &&
1980 llvm::sys::Process::FindInEnvPath("LIB", Value))
1981 return true;
1982
1983 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
1984 // Arguments to the /link flag might cause the linker to search for object
1985 // and library files in paths we don't know about. Don't error in such
1986 // cases.
1987 return true;
1988 }
1989 }
Hans Wennborg23d26a32014-06-18 17:21:50 +00001990
Yaron Keren92e1b622015-03-18 10:17:07 +00001991 D.Diag(clang::diag::err_drv_no_such_file) << Path;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001992 return false;
1993}
1994
Chad Rosierecdede82011-08-12 22:08:57 +00001995// Construct a the list of inputs and their types.
Hans Wennborg55362852014-05-02 22:55:30 +00001996void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
Chad Rosierecdede82011-08-12 22:08:57 +00001997 InputList &Inputs) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001998 // Track the current user specified (-x) input. We also explicitly track the
1999 // argument used to set the type; we only want to claim the type when we
2000 // actually use it, so we warn about unused -x arguments.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002001 types::ID InputType = types::TY_Nothing;
Craig Topper92fc2df2014-05-17 16:56:41 +00002002 Arg *InputTypeArg = nullptr;
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002003
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002004 // The last /TC or /TP option sets the input type to C or C++ globally.
Ehsan Akhgaric249abb2014-09-12 21:44:24 +00002005 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
2006 options::OPT__SLASH_TP)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002007 InputTypeArg = TCTP;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002008 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002009 ? types::TY_C
2010 : types::TY_CXX;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002011
Richard Smith0aef3052017-02-18 01:14:43 +00002012 Arg *Previous = nullptr;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002013 bool ShowNote = false;
Richard Smith0aef3052017-02-18 01:14:43 +00002014 for (Arg *A : Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
2015 if (Previous) {
2016 Diag(clang::diag::warn_drv_overriding_flag_option)
2017 << Previous->getSpelling() << A->getSpelling();
2018 ShowNote = true;
2019 }
2020 Previous = A;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002021 }
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00002022 if (ShowNote)
2023 Diag(clang::diag::note_drv_t_option_is_global);
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002024
2025 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
2026 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
2027 }
2028
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00002029 for (Arg *A : Args) {
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00002030 if (A->getOption().getKind() == Option::InputClass) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002031 const char *Value = A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002032 types::ID Ty = types::TY_INVALID;
2033
2034 // Infer the input type if necessary.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00002035 if (InputType == types::TY_Nothing) {
2036 // If there was an explicit arg for this, claim it.
2037 if (InputTypeArg)
2038 InputTypeArg->claim();
2039
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002040 // stdin must be handled specially.
2041 if (memcmp(Value, "-", 2) == 0) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002042 // If running with -E, treat as a C input (this changes the builtin
2043 // macros, for example). This may be overridden by -ObjC below.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002044 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002045 // Otherwise emit an error but still use a valid type to avoid
2046 // spurious errors (e.g., no inputs).
Hans Wennborg70850d82013-07-18 20:29:38 +00002047 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
Hans Wennborgcfdd8b52014-01-29 01:04:40 +00002048 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
2049 : clang::diag::err_drv_unknown_stdin_type);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002050 Ty = types::TY_C;
2051 } else {
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002052 // Otherwise lookup by extension.
2053 // Fallback is C if invoked as C preprocessor or Object otherwise.
2054 // We use a host hook here because Darwin at least has its own
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002055 // idea of what .s is.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002056 if (const char *Ext = strrchr(Value, '.'))
Daniel Dunbarcc7df6c2010-08-02 05:43:56 +00002057 Ty = TC.LookupTypeForExtension(Ext + 1);
Daniel Dunbarea9f0322009-03-20 23:39:23 +00002058
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002059 if (Ty == types::TY_INVALID) {
Hans Wennborg70850d82013-07-18 20:29:38 +00002060 if (CCCIsCPP())
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00002061 Ty = types::TY_C;
2062 else
2063 Ty = types::TY_Object;
2064 }
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002065
2066 // If the driver is invoked as C++ compiler (like clang++ or c++) it
2067 // should autodetect some input files as C++ for g++ compatibility.
Hans Wennborg70850d82013-07-18 20:29:38 +00002068 if (CCCIsCXX()) {
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002069 types::ID OldTy = Ty;
2070 Ty = types::lookupCXXTypeForCType(Ty);
2071
2072 if (Ty != OldTy)
2073 Diag(clang::diag::warn_drv_treating_input_as_cxx)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002074 << getTypeName(OldTy) << getTypeName(Ty);
Daniel Dunbar0ac94452010-02-17 20:32:58 +00002075 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002076 }
2077
Daniel Dunbar82b22102009-05-18 21:47:54 +00002078 // -ObjC and -ObjC++ override the default language, but only for "source
2079 // files". We just treat everything that isn't a linker input as a
2080 // source file.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002081 //
Daniel Dunbar82b22102009-05-18 21:47:54 +00002082 // FIXME: Clean this up if we move the phase sequence into the type.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002083 if (Ty != types::TY_Object) {
2084 if (Args.hasArg(options::OPT_ObjC))
2085 Ty = types::TY_ObjC;
2086 else if (Args.hasArg(options::OPT_ObjCXX))
2087 Ty = types::TY_ObjCXX;
2088 }
2089 } else {
2090 assert(InputTypeArg && "InputType set w/o InputTypeArg");
Ehsan Akhgari7e954ea2014-09-12 18:15:10 +00002091 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
2092 // If emulating cl.exe, make sure that /TC and /TP don't affect input
2093 // object files.
2094 const char *Ext = strrchr(Value, '.');
2095 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
2096 Ty = types::TY_Object;
2097 }
2098 if (Ty == types::TY_INVALID) {
2099 Ty = InputType;
2100 InputTypeArg->claim();
2101 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002102 }
2103
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002104 if (DiagnoseInputExistence(*this, Args, Value, Ty))
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002105 Inputs.push_back(std::make_pair(Ty, A));
2106
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002107 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
2108 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002109 if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002110 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002111 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
2112 }
2113 A->claim();
2114 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
2115 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00002116 if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00002117 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00002118 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
2119 }
2120 A->claim();
Michael J. Spencer66e2b202012-10-19 22:37:06 +00002121 } else if (A->getOption().hasFlag(options::LinkerInput)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002122 // Just treat as object type, we could make a special type for this if
2123 // necessary.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002124 Inputs.push_back(std::make_pair(types::TY_Object, A));
2125
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00002126 } else if (A->getOption().matches(options::OPT_x)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002127 InputTypeArg = A;
Richard Smithbd55daf2012-11-01 04:30:05 +00002128 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
Chad Rosier706c2352012-04-07 00:01:31 +00002129 A->claim();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002130
2131 // Follow gcc behavior and treat as linker input for invalid -x
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002132 // options. Its not clear why we shouldn't just revert to unknown; but
Michael J. Spencer1a4fe8c2010-12-17 21:22:33 +00002133 // this isn't very important, we might as well be bug compatible.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002134 if (!InputType) {
Richard Smithbd55daf2012-11-01 04:30:05 +00002135 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002136 InputType = types::TY_Object;
2137 }
Hans Wennborg091f1b62017-01-27 17:09:41 +00002138 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
2139 assert(A->getNumValues() == 1 && "The /U option has one value.");
2140 StringRef Val = A->getValue(0);
2141 if (Val.find_first_of("/\\") != StringRef::npos) {
2142 // Warn about e.g. "/Users/me/myfile.c".
2143 Diag(diag::warn_slash_u_filename) << Val;
2144 Diag(diag::note_use_dashdash);
2145 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002146 }
2147 }
Hans Wennborg70850d82013-07-18 20:29:38 +00002148 if (CCCIsCPP() && Inputs.empty()) {
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002149 // If called as standalone preprocessor, stdin is processed
2150 // if no other input is present.
David Blaikie0aaa7622017-01-13 17:34:15 +00002151 Arg *A = MakeInputArg(Args, *Opts, "-");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002152 Inputs.push_back(std::make_pair(types::TY_C, A));
2153 }
Chad Rosierecdede82011-08-12 22:08:57 +00002154}
2155
Samuel Antao64e965e2016-09-30 15:34:19 +00002156namespace {
2157/// Provides a convenient interface for different programming models to generate
2158/// the required device actions.
2159class OffloadingActionBuilder final {
2160 /// Flag used to trace errors in the builder.
2161 bool IsValid = false;
2162
2163 /// The compilation that is using this builder.
2164 Compilation &C;
2165
Samuel Antao64e965e2016-09-30 15:34:19 +00002166 /// Map between an input argument and the offload kinds used to process it.
2167 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
2168
2169 /// Builder interface. It doesn't build anything or keep any state.
2170 class DeviceActionBuilder {
2171 public:
2172 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
2173
2174 enum ActionBuilderReturnCode {
2175 // The builder acted successfully on the current action.
2176 ABRT_Success,
2177 // The builder didn't have to act on the current action.
2178 ABRT_Inactive,
2179 // The builder was successful and requested the host action to not be
2180 // generated.
2181 ABRT_Ignore_Host,
2182 };
2183
2184 protected:
2185 /// Compilation associated with this builder.
2186 Compilation &C;
2187
2188 /// Tool chains associated with this builder. The same programming
2189 /// model may have associated one or more tool chains.
2190 SmallVector<const ToolChain *, 2> ToolChains;
2191
2192 /// The derived arguments associated with this builder.
2193 DerivedArgList &Args;
2194
2195 /// The inputs associated with this builder.
2196 const Driver::InputList &Inputs;
2197
2198 /// The associated offload kind.
2199 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
2200
2201 public:
2202 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
2203 const Driver::InputList &Inputs,
2204 Action::OffloadKind AssociatedOffloadKind)
2205 : C(C), Args(Args), Inputs(Inputs),
2206 AssociatedOffloadKind(AssociatedOffloadKind) {}
2207 virtual ~DeviceActionBuilder() {}
2208
2209 /// Fill up the array \a DA with all the device dependences that should be
2210 /// added to the provided host action \a HostAction. By default it is
2211 /// inactive.
2212 virtual ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002213 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2214 phases::ID CurPhase, phases::ID FinalPhase,
2215 PhasesTy &Phases) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002216 return ABRT_Inactive;
2217 }
2218
2219 /// Update the state to include the provided host action \a HostAction as a
2220 /// dependency of the current device action. By default it is inactive.
2221 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
2222 return ABRT_Inactive;
2223 }
2224
2225 /// Append top level actions generated by the builder. Return true if errors
2226 /// were found.
2227 virtual void appendTopLevelActions(ActionList &AL) {}
2228
2229 /// Append linker actions generated by the builder. Return true if errors
2230 /// were found.
2231 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
2232
2233 /// Initialize the builder. Return true if any initialization errors are
2234 /// found.
2235 virtual bool initialize() { return false; }
2236
Samuel Antao69d6f312016-10-27 17:50:43 +00002237 /// Return true if the builder can use bundling/unbundling.
2238 virtual bool canUseBundlerUnbundler() const { return false; }
2239
Samuel Antao64e965e2016-09-30 15:34:19 +00002240 /// Return true if this builder is valid. We have a valid builder if we have
2241 /// associated device tool chains.
2242 bool isValid() { return !ToolChains.empty(); }
2243
2244 /// Return the associated offload kind.
2245 Action::OffloadKind getAssociatedOffloadKind() {
2246 return AssociatedOffloadKind;
2247 }
2248 };
2249
Yaxun Liu3af038b2018-05-30 00:49:10 +00002250 /// Base class for CUDA/HIP action builder. It injects device code in
2251 /// the host backend action.
2252 class CudaActionBuilderBase : public DeviceActionBuilder {
2253 protected:
Samuel Antao64e965e2016-09-30 15:34:19 +00002254 /// Flags to signal if the user requested host-only or device-only
2255 /// compilation.
2256 bool CompileHostOnly = false;
2257 bool CompileDeviceOnly = false;
2258
2259 /// List of GPU architectures to use in this compilation.
2260 SmallVector<CudaArch, 4> GpuArchList;
2261
2262 /// The CUDA actions for the current input.
2263 ActionList CudaDeviceActions;
2264
2265 /// The CUDA fat binary if it was generated for the current input.
2266 Action *CudaFatBinary = nullptr;
2267
2268 /// Flag that is set to true if this builder acted on the current input.
2269 bool IsActive = false;
Yaxun Liu3af038b2018-05-30 00:49:10 +00002270 public:
2271 CudaActionBuilderBase(Compilation &C, DerivedArgList &Args,
2272 const Driver::InputList &Inputs,
2273 Action::OffloadKind OFKind)
2274 : DeviceActionBuilder(C, Args, Inputs, OFKind) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002275
Yaxun Liu3af038b2018-05-30 00:49:10 +00002276 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2277 // While generating code for CUDA, we only depend on the host input action
2278 // to trigger the creation of all the CUDA device actions.
2279
2280 // If we are dealing with an input action, replicate it for each GPU
2281 // architecture. If we are in host-only mode we return 'success' so that
2282 // the host uses the CUDA offload kind.
2283 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2284 assert(!GpuArchList.empty() &&
2285 "We should have at least one GPU architecture.");
2286
2287 // If the host input is not CUDA or HIP, we don't need to bother about
2288 // this input.
2289 if (IA->getType() != types::TY_CUDA &&
2290 IA->getType() != types::TY_HIP) {
2291 // The builder will ignore this input.
2292 IsActive = false;
2293 return ABRT_Inactive;
2294 }
2295
2296 // Set the flag to true, so that the builder acts on the current input.
2297 IsActive = true;
2298
2299 if (CompileHostOnly)
2300 return ABRT_Success;
2301
2302 // Replicate inputs for each GPU architecture.
2303 auto Ty = IA->getType() == types::TY_HIP ? types::TY_HIP_DEVICE
2304 : types::TY_CUDA_DEVICE;
2305 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2306 CudaDeviceActions.push_back(
2307 C.MakeAction<InputAction>(IA->getInputArg(), Ty));
2308 }
2309
2310 return ABRT_Success;
2311 }
2312
2313 // If this is an unbundling action use it as is for each CUDA toolchain.
2314 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2315 CudaDeviceActions.clear();
2316 for (auto Arch : GpuArchList) {
2317 CudaDeviceActions.push_back(UA);
2318 UA->registerDependentActionInfo(ToolChains[0], CudaArchToString(Arch),
2319 AssociatedOffloadKind);
2320 }
2321 return ABRT_Success;
2322 }
2323
2324 return IsActive ? ABRT_Success : ABRT_Inactive;
2325 }
2326
2327 void appendTopLevelActions(ActionList &AL) override {
2328 // Utility to append actions to the top level list.
2329 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
2330 OffloadAction::DeviceDependences Dep;
2331 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
2332 AssociatedOffloadKind);
2333 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2334 };
2335
2336 // If we have a fat binary, add it to the list.
2337 if (CudaFatBinary) {
2338 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
2339 CudaDeviceActions.clear();
2340 CudaFatBinary = nullptr;
2341 return;
2342 }
2343
2344 if (CudaDeviceActions.empty())
2345 return;
2346
2347 // If we have CUDA actions at this point, that's because we have a have
2348 // partial compilation, so we should have an action for each GPU
2349 // architecture.
2350 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2351 "Expecting one action per GPU architecture.");
2352 assert(ToolChains.size() == 1 &&
2353 "Expecting to have a sing CUDA toolchain.");
2354 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
2355 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
2356
2357 CudaDeviceActions.clear();
2358 }
2359
2360 bool initialize() override {
2361 assert(AssociatedOffloadKind == Action::OFK_Cuda ||
2362 AssociatedOffloadKind == Action::OFK_HIP);
2363
2364 // We don't need to support CUDA.
2365 if (AssociatedOffloadKind == Action::OFK_Cuda &&
2366 !C.hasOffloadToolChain<Action::OFK_Cuda>())
2367 return false;
2368
2369 // We don't need to support HIP.
2370 if (AssociatedOffloadKind == Action::OFK_HIP &&
2371 !C.hasOffloadToolChain<Action::OFK_HIP>())
2372 return false;
2373
2374 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
2375 assert(HostTC && "No toolchain for host compilation.");
2376 if (HostTC->getTriple().isNVPTX() ||
2377 HostTC->getTriple().getArch() == llvm::Triple::amdgcn) {
2378 // We do not support targeting NVPTX/AMDGCN for host compilation. Throw
2379 // an error and abort pipeline construction early so we don't trip
2380 // asserts that assume device-side compilation.
2381 C.getDriver().Diag(diag::err_drv_cuda_host_arch)
2382 << HostTC->getTriple().getArchName();
2383 return true;
2384 }
2385
2386 ToolChains.push_back(
2387 AssociatedOffloadKind == Action::OFK_Cuda
2388 ? C.getSingleOffloadToolChain<Action::OFK_Cuda>()
2389 : C.getSingleOffloadToolChain<Action::OFK_HIP>());
2390
2391 Arg *PartialCompilationArg = Args.getLastArg(
2392 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
2393 options::OPT_cuda_compile_host_device);
2394 CompileHostOnly = PartialCompilationArg &&
2395 PartialCompilationArg->getOption().matches(
2396 options::OPT_cuda_host_only);
2397 CompileDeviceOnly = PartialCompilationArg &&
2398 PartialCompilationArg->getOption().matches(
2399 options::OPT_cuda_device_only);
2400
2401 // Collect all cuda_gpu_arch parameters, removing duplicates.
2402 std::set<CudaArch> GpuArchs;
2403 bool Error = false;
2404 for (Arg *A : Args) {
2405 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
2406 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
2407 continue;
2408 A->claim();
2409
2410 const StringRef ArchStr = A->getValue();
2411 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
2412 ArchStr == "all") {
2413 GpuArchs.clear();
2414 continue;
2415 }
2416 CudaArch Arch = StringToCudaArch(ArchStr);
2417 if (Arch == CudaArch::UNKNOWN) {
2418 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
2419 Error = true;
2420 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
2421 GpuArchs.insert(Arch);
2422 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
2423 GpuArchs.erase(Arch);
2424 else
2425 llvm_unreachable("Unexpected option.");
2426 }
2427
2428 // Collect list of GPUs remaining in the set.
2429 for (CudaArch Arch : GpuArchs)
2430 GpuArchList.push_back(Arch);
2431
2432 // Default to sm_20 which is the lowest common denominator for
2433 // supported GPUs. sm_20 code should work correctly, if
2434 // suboptimally, on all newer GPUs.
2435 if (GpuArchList.empty())
2436 GpuArchList.push_back(CudaArch::SM_20);
2437
2438 return Error;
2439 }
2440 };
2441
2442 /// \brief CUDA action builder. It injects device code in the host backend
2443 /// action.
2444 class CudaActionBuilder final : public CudaActionBuilderBase {
Samuel Antao64e965e2016-09-30 15:34:19 +00002445 public:
2446 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
2447 const Driver::InputList &Inputs)
Yaxun Liu3af038b2018-05-30 00:49:10 +00002448 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_Cuda) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002449
2450 ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00002451 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2452 phases::ID CurPhase, phases::ID FinalPhase,
2453 PhasesTy &Phases) override {
Samuel Antao64e965e2016-09-30 15:34:19 +00002454 if (!IsActive)
2455 return ABRT_Inactive;
2456
2457 // If we don't have more CUDA actions, we don't have any dependences to
2458 // create for the host.
2459 if (CudaDeviceActions.empty())
2460 return ABRT_Success;
2461
2462 assert(CudaDeviceActions.size() == GpuArchList.size() &&
2463 "Expecting one action per GPU architecture.");
2464 assert(!CompileHostOnly &&
2465 "Not expecting CUDA actions in host-only compilation.");
2466
2467 // If we are generating code for the device or we are in a backend phase,
2468 // we attempt to generate the fat binary. We compile each arch to ptx and
2469 // assemble to cubin, then feed the cubin *and* the ptx into a device
2470 // "link" action, which uses fatbinary to combine these cubins into one
2471 // fatbin. The fatbin is then an input to the host action if not in
2472 // device-only mode.
2473 if (CompileDeviceOnly || CurPhase == phases::Backend) {
2474 ActionList DeviceActions;
2475 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2476 // Produce the device action from the current phase up to the assemble
2477 // phase.
2478 for (auto Ph : Phases) {
2479 // Skip the phases that were already dealt with.
2480 if (Ph < CurPhase)
2481 continue;
2482 // We have to be consistent with the host final phase.
2483 if (Ph > FinalPhase)
2484 break;
2485
2486 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
Artem Belevichecb178b2018-03-21 22:22:59 +00002487 C, Args, Ph, CudaDeviceActions[I], Action::OFK_Cuda);
Samuel Antao64e965e2016-09-30 15:34:19 +00002488
2489 if (Ph == phases::Assemble)
2490 break;
2491 }
2492
2493 // If we didn't reach the assemble phase, we can't generate the fat
2494 // binary. We don't need to generate the fat binary if we are not in
2495 // device-only mode.
2496 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
2497 CompileDeviceOnly)
2498 continue;
2499
2500 Action *AssembleAction = CudaDeviceActions[I];
2501 assert(AssembleAction->getType() == types::TY_Object);
2502 assert(AssembleAction->getInputs().size() == 1);
2503
2504 Action *BackendAction = AssembleAction->getInputs()[0];
2505 assert(BackendAction->getType() == types::TY_PP_Asm);
2506
2507 for (auto &A : {AssembleAction, BackendAction}) {
2508 OffloadAction::DeviceDependences DDep;
2509 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
2510 Action::OFK_Cuda);
2511 DeviceActions.push_back(
2512 C.MakeAction<OffloadAction>(DDep, A->getType()));
2513 }
2514 }
2515
2516 // We generate the fat binary if we have device input actions.
2517 if (!DeviceActions.empty()) {
2518 CudaFatBinary =
2519 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
2520
2521 if (!CompileDeviceOnly) {
2522 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2523 Action::OFK_Cuda);
2524 // Clear the fat binary, it is already a dependence to an host
2525 // action.
2526 CudaFatBinary = nullptr;
2527 }
2528
2529 // Remove the CUDA actions as they are already connected to an host
2530 // action or fat binary.
2531 CudaDeviceActions.clear();
2532 }
2533
2534 // We avoid creating host action in device-only mode.
2535 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Samuel Antao5b1a89a2016-10-27 00:53:34 +00002536 } else if (CurPhase > phases::Backend) {
2537 // If we are past the backend phase and still have a device action, we
2538 // don't have to do anything as this action is already a device
2539 // top-level action.
2540 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002541 }
2542
2543 assert(CurPhase < phases::Backend && "Generating single CUDA "
2544 "instructions should only occur "
2545 "before the backend phase!");
2546
2547 // By default, we produce an action for each device arch.
2548 for (Action *&A : CudaDeviceActions)
2549 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2550
2551 return ABRT_Success;
2552 }
Yaxun Liu3af038b2018-05-30 00:49:10 +00002553 };
2554 /// \brief HIP action builder. It injects device code in the host backend
2555 /// action.
2556 class HIPActionBuilder final : public CudaActionBuilderBase {
2557 /// The linker inputs obtained for each device arch.
2558 SmallVector<ActionList, 8> DeviceLinkerInputs;
Yaxun Liu97670892018-10-02 17:48:54 +00002559 bool Relocatable;
Samuel Antao64e965e2016-09-30 15:34:19 +00002560
Yaxun Liu3af038b2018-05-30 00:49:10 +00002561 public:
2562 HIPActionBuilder(Compilation &C, DerivedArgList &Args,
2563 const Driver::InputList &Inputs)
Yaxun Liu97670892018-10-02 17:48:54 +00002564 : CudaActionBuilderBase(C, Args, Inputs, Action::OFK_HIP),
2565 Relocatable(false) {}
Samuel Antao64e965e2016-09-30 15:34:19 +00002566
Yaxun Liu3af038b2018-05-30 00:49:10 +00002567 bool canUseBundlerUnbundler() const override { return true; }
Samuel Antao64e965e2016-09-30 15:34:19 +00002568
Yaxun Liu3af038b2018-05-30 00:49:10 +00002569 ActionBuilderReturnCode
2570 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2571 phases::ID CurPhase, phases::ID FinalPhase,
2572 PhasesTy &Phases) override {
2573 // amdgcn does not support linking of object files, therefore we skip
Yaxun Liu97670892018-10-02 17:48:54 +00002574 // backend and assemble phases to output LLVM IR. Except for generating
2575 // non-relocatable device coee, where we generate fat binary for device
2576 // code and pass to host in Backend phase.
2577 if (CudaDeviceActions.empty() ||
2578 (CurPhase == phases::Backend && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002579 CurPhase == phases::Assemble)
2580 return ABRT_Success;
2581
Yaxun Liu97670892018-10-02 17:48:54 +00002582 assert(((CurPhase == phases::Link && Relocatable) ||
Yaxun Liu3af038b2018-05-30 00:49:10 +00002583 CudaDeviceActions.size() == GpuArchList.size()) &&
2584 "Expecting one action per GPU architecture.");
2585 assert(!CompileHostOnly &&
2586 "Not expecting CUDA actions in host-only compilation.");
2587
Yaxun Liu97670892018-10-02 17:48:54 +00002588 if (!Relocatable && CurPhase == phases::Backend) {
2589 // If we are in backend phase, we attempt to generate the fat binary.
2590 // We compile each arch to IR and use a link action to generate code
2591 // object containing ISA. Then we use a special "link" action to create
2592 // a fat binary containing all the code objects for different GPU's.
2593 // The fat binary is then an input to the host action.
2594 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
2595 // Create a link action to link device IR with device library
2596 // and generate ISA.
2597 ActionList AL;
2598 AL.push_back(CudaDeviceActions[I]);
2599 CudaDeviceActions[I] =
2600 C.MakeAction<LinkJobAction>(AL, types::TY_Image);
2601
2602 // OffloadingActionBuilder propagates device arch until an offload
2603 // action. Since the next action for creating fatbin does
2604 // not have device arch, whereas the above link action and its input
2605 // have device arch, an offload action is needed to stop the null
2606 // device arch of the next action being propagated to the above link
2607 // action.
2608 OffloadAction::DeviceDependences DDep;
2609 DDep.add(*CudaDeviceActions[I], *ToolChains.front(),
2610 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2611 CudaDeviceActions[I] = C.MakeAction<OffloadAction>(
2612 DDep, CudaDeviceActions[I]->getType());
2613 }
2614 // Create HIP fat binary with a special "link" action.
2615 CudaFatBinary =
2616 C.MakeAction<LinkJobAction>(CudaDeviceActions,
2617 types::TY_HIP_FATBIN);
2618
Yaxun Liu2bcc9512018-11-14 04:47:31 +00002619 if (!CompileDeviceOnly) {
2620 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
2621 AssociatedOffloadKind);
2622 // Clear the fat binary, it is already a dependence to an host
2623 // action.
2624 CudaFatBinary = nullptr;
2625 }
Yaxun Liu97670892018-10-02 17:48:54 +00002626
2627 // Remove the CUDA actions as they are already connected to an host
2628 // action or fat binary.
2629 CudaDeviceActions.clear();
2630
Yaxun Liu2bcc9512018-11-14 04:47:31 +00002631 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Yaxun Liu97670892018-10-02 17:48:54 +00002632 } else if (CurPhase == phases::Link) {
2633 // Save CudaDeviceActions to DeviceLinkerInputs for each GPU subarch.
2634 // This happens to each device action originated from each input file.
2635 // Later on, device actions in DeviceLinkerInputs are used to create
2636 // device link actions in appendLinkDependences and the created device
2637 // link actions are passed to the offload action as device dependence.
Yaxun Liu3af038b2018-05-30 00:49:10 +00002638 DeviceLinkerInputs.resize(CudaDeviceActions.size());
2639 auto LI = DeviceLinkerInputs.begin();
2640 for (auto *A : CudaDeviceActions) {
2641 LI->push_back(A);
2642 ++LI;
Samuel Antao64e965e2016-09-30 15:34:19 +00002643 }
2644
Yaxun Liu3af038b2018-05-30 00:49:10 +00002645 // We will pass the device action as a host dependence, so we don't
2646 // need to do anything else with them.
2647 CudaDeviceActions.clear();
Samuel Antao64e965e2016-09-30 15:34:19 +00002648 return ABRT_Success;
2649 }
2650
Yaxun Liu3af038b2018-05-30 00:49:10 +00002651 // By default, we produce an action for each device arch.
2652 for (Action *&A : CudaDeviceActions)
2653 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A,
2654 AssociatedOffloadKind);
2655
2656 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00002657 }
2658
Yaxun Liu3af038b2018-05-30 00:49:10 +00002659 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2660 // Append a new link action for each device.
2661 unsigned I = 0;
2662 for (auto &LI : DeviceLinkerInputs) {
2663 auto *DeviceLinkAction =
2664 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2665 DA.add(*DeviceLinkAction, *ToolChains[0],
2666 CudaArchToString(GpuArchList[I]), AssociatedOffloadKind);
2667 ++I;
Samuel Antao64e965e2016-09-30 15:34:19 +00002668 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002669 }
Yaxun Liu97670892018-10-02 17:48:54 +00002670
2671 bool initialize() override {
2672 Relocatable = Args.hasFlag(options::OPT_fgpu_rdc,
2673 options::OPT_fno_gpu_rdc, /*Default=*/false);
2674
2675 return CudaActionBuilderBase::initialize();
2676 }
Samuel Antao64e965e2016-09-30 15:34:19 +00002677 };
2678
Samuel Antao28c4f182016-10-27 17:08:03 +00002679 /// OpenMP action builder. The host bitcode is passed to the device frontend
2680 /// and all the device linked images are passed to the host link phase.
2681 class OpenMPActionBuilder final : public DeviceActionBuilder {
2682 /// The OpenMP actions for the current input.
2683 ActionList OpenMPDeviceActions;
2684
2685 /// The linker inputs obtained for each toolchain.
2686 SmallVector<ActionList, 8> DeviceLinkerInputs;
2687
2688 public:
2689 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2690 const Driver::InputList &Inputs)
2691 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2692
2693 ActionBuilderReturnCode
2694 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2695 phases::ID CurPhase, phases::ID FinalPhase,
2696 PhasesTy &Phases) override {
Alexey Bataeva5178f52018-09-28 16:17:59 +00002697 if (OpenMPDeviceActions.empty())
2698 return ABRT_Inactive;
Samuel Antao28c4f182016-10-27 17:08:03 +00002699
2700 // We should always have an action for each input.
2701 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2702 "Number of OpenMP actions and toolchains do not match.");
2703
2704 // The host only depends on device action in the linking phase, when all
2705 // the device images have to be embedded in the host image.
2706 if (CurPhase == phases::Link) {
2707 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2708 "Toolchains and linker inputs sizes do not match.");
2709 auto LI = DeviceLinkerInputs.begin();
2710 for (auto *A : OpenMPDeviceActions) {
2711 LI->push_back(A);
2712 ++LI;
2713 }
2714
2715 // We passed the device action as a host dependence, so we don't need to
2716 // do anything else with them.
2717 OpenMPDeviceActions.clear();
2718 return ABRT_Success;
2719 }
2720
2721 // By default, we produce an action for each device arch.
2722 for (Action *&A : OpenMPDeviceActions)
2723 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2724
2725 return ABRT_Success;
2726 }
2727
2728 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2729
2730 // If this is an input action replicate it for each OpenMP toolchain.
2731 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2732 OpenMPDeviceActions.clear();
2733 for (unsigned I = 0; I < ToolChains.size(); ++I)
2734 OpenMPDeviceActions.push_back(
2735 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2736 return ABRT_Success;
2737 }
2738
Samuel Antaofab4f372016-10-27 18:00:51 +00002739 // If this is an unbundling action use it as is for each OpenMP toolchain.
2740 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2741 OpenMPDeviceActions.clear();
Alexey Bataeva5178f52018-09-28 16:17:59 +00002742 auto *IA = cast<InputAction>(UA->getInputs().back());
2743 std::string FileName = IA->getInputArg().getAsString(Args);
2744 // Check if the type of the file is the same as the action. Do not
2745 // unbundle it if it is not. Do not unbundle .so files, for example,
2746 // which are not object files.
2747 if (IA->getType() == types::TY_Object &&
2748 (!llvm::sys::path::has_extension(FileName) ||
2749 types::lookupTypeForExtension(
2750 llvm::sys::path::extension(FileName).drop_front()) !=
2751 types::TY_Object))
2752 return ABRT_Inactive;
Samuel Antaofab4f372016-10-27 18:00:51 +00002753 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2754 OpenMPDeviceActions.push_back(UA);
2755 UA->registerDependentActionInfo(
2756 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2757 }
2758 return ABRT_Success;
2759 }
2760
Samuel Antao28c4f182016-10-27 17:08:03 +00002761 // When generating code for OpenMP we use the host compile phase result as
2762 // a dependence to the device compile phase so that it can learn what
2763 // declarations should be emitted. However, this is not the only use for
2764 // the host action, so we prevent it from being collapsed.
2765 if (isa<CompileJobAction>(HostAction)) {
2766 HostAction->setCannotBeCollapsedWithNextDependentAction();
2767 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2768 "Toolchains and device action sizes do not match.");
2769 OffloadAction::HostDependence HDep(
2770 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2771 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2772 auto TC = ToolChains.begin();
2773 for (Action *&A : OpenMPDeviceActions) {
2774 assert(isa<CompileJobAction>(A));
2775 OffloadAction::DeviceDependences DDep;
2776 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2777 A = C.MakeAction<OffloadAction>(HDep, DDep);
2778 ++TC;
2779 }
2780 }
2781 return ABRT_Success;
2782 }
2783
Samuel Antao69d6f312016-10-27 17:50:43 +00002784 void appendTopLevelActions(ActionList &AL) override {
2785 if (OpenMPDeviceActions.empty())
2786 return;
2787
2788 // We should always have an action for each input.
2789 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2790 "Number of OpenMP actions and toolchains do not match.");
2791
2792 // Append all device actions followed by the proper offload action.
2793 auto TI = ToolChains.begin();
2794 for (auto *A : OpenMPDeviceActions) {
2795 OffloadAction::DeviceDependences Dep;
2796 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2797 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2798 ++TI;
2799 }
2800 // We no longer need the action stored in this builder.
2801 OpenMPDeviceActions.clear();
2802 }
2803
Samuel Antao28c4f182016-10-27 17:08:03 +00002804 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2805 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2806 "Toolchains and linker inputs sizes do not match.");
2807
2808 // Append a new link action for each device.
2809 auto TC = ToolChains.begin();
2810 for (auto &LI : DeviceLinkerInputs) {
2811 auto *DeviceLinkAction =
2812 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2813 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2814 Action::OFK_OpenMP);
2815 ++TC;
2816 }
2817 }
2818
2819 bool initialize() override {
2820 // Get the OpenMP toolchains. If we don't get any, the action builder will
2821 // know there is nothing to do related to OpenMP offloading.
2822 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2823 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2824 ++TI)
2825 ToolChains.push_back(TI->second);
2826
2827 DeviceLinkerInputs.resize(ToolChains.size());
2828 return false;
2829 }
Samuel Antao69d6f312016-10-27 17:50:43 +00002830
2831 bool canUseBundlerUnbundler() const override {
2832 // OpenMP should use bundled files whenever possible.
2833 return true;
2834 }
Samuel Antao28c4f182016-10-27 17:08:03 +00002835 };
2836
2837 ///
2838 /// TODO: Add the implementation for other specialized builders here.
2839 ///
Samuel Antao64e965e2016-09-30 15:34:19 +00002840
2841 /// Specialized builders being used by this offloading action builder.
2842 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2843
Samuel Antao69d6f312016-10-27 17:50:43 +00002844 /// Flag set to true if all valid builders allow file bundling/unbundling.
2845 bool CanUseBundler;
2846
Samuel Antao64e965e2016-09-30 15:34:19 +00002847public:
2848 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2849 const Driver::InputList &Inputs)
Samuel Antao10e905c2016-10-27 01:08:58 +00002850 : C(C) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002851 // Create a specialized builder for each device toolchain.
2852
2853 IsValid = true;
2854
2855 // Create a specialized builder for CUDA.
2856 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2857
Yaxun Liu3af038b2018-05-30 00:49:10 +00002858 // Create a specialized builder for HIP.
2859 SpecializedBuilders.push_back(new HIPActionBuilder(C, Args, Inputs));
2860
Samuel Antao28c4f182016-10-27 17:08:03 +00002861 // Create a specialized builder for OpenMP.
2862 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2863
Samuel Antao64e965e2016-09-30 15:34:19 +00002864 //
2865 // TODO: Build other specialized builders here.
2866 //
2867
Samuel Antao69d6f312016-10-27 17:50:43 +00002868 // Initialize all the builders, keeping track of errors. If all valid
2869 // builders agree that we can use bundling, set the flag to true.
2870 unsigned ValidBuilders = 0u;
2871 unsigned ValidBuildersSupportingBundling = 0u;
2872 for (auto *SB : SpecializedBuilders) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002873 IsValid = IsValid && !SB->initialize();
Samuel Antao69d6f312016-10-27 17:50:43 +00002874
2875 // Update the counters if the builder is valid.
2876 if (SB->isValid()) {
2877 ++ValidBuilders;
2878 if (SB->canUseBundlerUnbundler())
2879 ++ValidBuildersSupportingBundling;
2880 }
2881 }
2882 CanUseBundler =
2883 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
Artem Belevichf981e30b2016-08-02 22:37:47 +00002884 }
Justin Lebardc3c5042016-04-19 02:27:07 +00002885
Samuel Antao64e965e2016-09-30 15:34:19 +00002886 ~OffloadingActionBuilder() {
2887 for (auto *SB : SpecializedBuilders)
2888 delete SB;
Samuel Antaod06239d2016-07-15 23:13:27 +00002889 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002890
Samuel Antao64e965e2016-09-30 15:34:19 +00002891 /// Generate an action that adds device dependences (if any) to a host action.
2892 /// If no device dependence actions exist, just return the host action \a
2893 /// HostAction. If an error is found or if no builder requires the host action
2894 /// to be generated, return nullptr.
2895 Action *
2896 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2897 phases::ID CurPhase, phases::ID FinalPhase,
2898 DeviceActionBuilder::PhasesTy &Phases) {
2899 if (!IsValid)
2900 return nullptr;
Justin Lebar7bf77982016-01-11 23:27:13 +00002901
Samuel Antao64e965e2016-09-30 15:34:19 +00002902 if (SpecializedBuilders.empty())
2903 return HostAction;
2904
2905 assert(HostAction && "Invalid host action!");
2906
2907 OffloadAction::DeviceDependences DDeps;
2908 // Check if all the programming models agree we should not emit the host
2909 // action. Also, keep track of the offloading kinds employed.
2910 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2911 unsigned InactiveBuilders = 0u;
2912 unsigned IgnoringBuilders = 0u;
2913 for (auto *SB : SpecializedBuilders) {
2914 if (!SB->isValid()) {
2915 ++InactiveBuilders;
2916 continue;
2917 }
2918
Samuel Antao28c4f182016-10-27 17:08:03 +00002919 auto RetCode =
2920 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
Samuel Antao64e965e2016-09-30 15:34:19 +00002921
2922 // If the builder explicitly says the host action should be ignored,
2923 // we need to increment the variable that tracks the builders that request
2924 // the host object to be ignored.
2925 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2926 ++IgnoringBuilders;
2927
2928 // Unless the builder was inactive for this action, we have to record the
2929 // offload kind because the host will have to use it.
2930 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2931 OffloadKind |= SB->getAssociatedOffloadKind();
2932 }
2933
2934 // If all builders agree that the host object should be ignored, just return
2935 // nullptr.
2936 if (IgnoringBuilders &&
2937 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2938 return nullptr;
2939
2940 if (DDeps.getActions().empty())
2941 return HostAction;
2942
2943 // We have dependences we need to bundle together. We use an offload action
2944 // for that.
2945 OffloadAction::HostDependence HDep(
2946 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2947 /*BoundArch=*/nullptr, DDeps);
2948 return C.MakeAction<OffloadAction>(HDep, DDeps);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002949 }
2950
Samuel Antao64e965e2016-09-30 15:34:19 +00002951 /// Generate an action that adds a host dependence to a device action. The
2952 /// results will be kept in this action builder. Return true if an error was
2953 /// found.
Samuel Antaofab4f372016-10-27 18:00:51 +00002954 bool addHostDependenceToDeviceActions(Action *&HostAction,
Samuel Antao64e965e2016-09-30 15:34:19 +00002955 const Arg *InputArg) {
2956 if (!IsValid)
2957 return true;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002958
Samuel Antaofab4f372016-10-27 18:00:51 +00002959 // If we are supporting bundling/unbundling and the current action is an
2960 // input action of non-source file, we replace the host action by the
2961 // unbundling action. The bundler tool has the logic to detect if an input
2962 // is a bundle or not and if the input is not a bundle it assumes it is a
2963 // host file. Therefore it is safe to create an unbundling action even if
2964 // the input is not a bundle.
2965 if (CanUseBundler && isa<InputAction>(HostAction) &&
2966 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
2967 !types::isSrcFile(HostAction->getType())) {
2968 auto UnbundlingHostAction =
2969 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
2970 UnbundlingHostAction->registerDependentActionInfo(
2971 C.getSingleOffloadToolChain<Action::OFK_Host>(),
Yaxun Liuf37b50a2018-07-24 01:03:44 +00002972 /*BoundArch=*/StringRef(), Action::OFK_Host);
Samuel Antaofab4f372016-10-27 18:00:51 +00002973 HostAction = UnbundlingHostAction;
2974 }
2975
Samuel Antao64e965e2016-09-30 15:34:19 +00002976 assert(HostAction && "Invalid host action!");
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002977
Samuel Antao64e965e2016-09-30 15:34:19 +00002978 // Register the offload kinds that are used.
2979 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2980 for (auto *SB : SpecializedBuilders) {
2981 if (!SB->isValid())
2982 continue;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002983
Samuel Antao64e965e2016-09-30 15:34:19 +00002984 auto RetCode = SB->addDeviceDepences(HostAction);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002985
Samuel Antao64e965e2016-09-30 15:34:19 +00002986 // Host dependences for device actions are not compatible with that same
2987 // action being ignored.
2988 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
2989 "Host dependence not expected to be ignored.!");
Samuel Antaod06239d2016-07-15 23:13:27 +00002990
Samuel Antao64e965e2016-09-30 15:34:19 +00002991 // Unless the builder was inactive for this action, we have to record the
2992 // offload kind because the host will have to use it.
2993 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2994 OffloadKind |= SB->getAssociatedOffloadKind();
2995 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002996
Alexey Bataeva5178f52018-09-28 16:17:59 +00002997 // Do not use unbundler if the Host does not depend on device action.
2998 if (OffloadKind == Action::OFK_None && CanUseBundler)
2999 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction))
3000 HostAction = UA->getInputs().back();
3001
Samuel Antao64e965e2016-09-30 15:34:19 +00003002 return false;
3003 }
3004
Samuel Antao69d6f312016-10-27 17:50:43 +00003005 /// Add the offloading top level actions to the provided action list. This
3006 /// function can replace the host action by a bundling action if the
3007 /// programming models allow it.
Samuel Antao64e965e2016-09-30 15:34:19 +00003008 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
3009 const Arg *InputArg) {
Samuel Antao69d6f312016-10-27 17:50:43 +00003010 // Get the device actions to be appended.
3011 ActionList OffloadAL;
Samuel Antao64e965e2016-09-30 15:34:19 +00003012 for (auto *SB : SpecializedBuilders) {
3013 if (!SB->isValid())
3014 continue;
Samuel Antao69d6f312016-10-27 17:50:43 +00003015 SB->appendTopLevelActions(OffloadAL);
Samuel Antao64e965e2016-09-30 15:34:19 +00003016 }
3017
Samuel Antao69d6f312016-10-27 17:50:43 +00003018 // If we can use the bundler, replace the host action by the bundling one in
Yaxun Liu2bcc9512018-11-14 04:47:31 +00003019 // the resulting list. Otherwise, just append the device actions. For
3020 // device only compilation, HostAction is a null pointer, therefore only do
3021 // this when HostAction is not a null pointer.
3022 if (CanUseBundler && HostAction && !OffloadAL.empty()) {
Samuel Antao69d6f312016-10-27 17:50:43 +00003023 // Add the host action to the list in order to create the bundling action.
3024 OffloadAL.push_back(HostAction);
3025
3026 // We expect that the host action was just appended to the action list
3027 // before this method was called.
3028 assert(HostAction == AL.back() && "Host action not in the list??");
3029 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
3030 AL.back() = HostAction;
3031 } else
3032 AL.append(OffloadAL.begin(), OffloadAL.end());
3033
Samuel Antao64e965e2016-09-30 15:34:19 +00003034 // Propagate to the current host action (if any) the offload information
3035 // associated with the current input.
3036 if (HostAction)
3037 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
3038 /*BoundArch=*/nullptr);
Samuel Antao64e965e2016-09-30 15:34:19 +00003039 return false;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003040 }
Artem Belevich5bde4e02015-07-20 20:02:54 +00003041
Samuel Antao64e965e2016-09-30 15:34:19 +00003042 /// Processes the host linker action. This currently consists of replacing it
3043 /// with an offload action if there are device link objects and propagate to
3044 /// the host action all the offload kinds used in the current compilation. The
3045 /// resulting action is returned.
3046 Action *processHostLinkAction(Action *HostAction) {
3047 // Add all the dependences from the device linking actions.
3048 OffloadAction::DeviceDependences DDeps;
3049 for (auto *SB : SpecializedBuilders) {
3050 if (!SB->isValid())
3051 continue;
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003052
Samuel Antao64e965e2016-09-30 15:34:19 +00003053 SB->appendLinkDependences(DDeps);
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003054 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003055
Samuel Antao64e965e2016-09-30 15:34:19 +00003056 // Calculate all the offload kinds used in the current compilation.
3057 unsigned ActiveOffloadKinds = 0u;
3058 for (auto &I : InputArgToOffloadKindMap)
3059 ActiveOffloadKinds |= I.second;
3060
3061 // If we don't have device dependencies, we don't have to create an offload
3062 // action.
3063 if (DDeps.getActions().empty()) {
3064 // Propagate all the active kinds to host action. Given that it is a link
3065 // action it is assumed to depend on all actions generated so far.
3066 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
3067 /*BoundArch=*/nullptr);
3068 return HostAction;
3069 }
3070
3071 // Create the offload action with all dependences. When an offload action
3072 // is created the kinds are propagated to the host action, so we don't have
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003073 // to do that explicitly here.
Samuel Antao64e965e2016-09-30 15:34:19 +00003074 OffloadAction::HostDependence HDep(
3075 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
3076 /*BoundArch*/ nullptr, ActiveOffloadKinds);
3077 return C.MakeAction<OffloadAction>(HDep, DDeps);
3078 }
3079};
3080} // anonymous namespace.
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003081
Justin Lebar0f3474c2016-02-11 02:00:50 +00003082void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
3083 const InputList &Inputs, ActionList &Actions) const {
Chad Rosierecdede82011-08-12 22:08:57 +00003084 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00003085
Daniel Dunbar34c41872009-03-13 00:17:48 +00003086 if (!SuppressMissingInputWarning && Inputs.empty()) {
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003087 Diag(clang::diag::err_drv_no_input_files);
3088 return;
3089 }
3090
Chad Rosier7742b5d2011-07-27 23:36:45 +00003091 Arg *FinalPhaseArg;
3092 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003093
Bob Haarmanaaf51912017-02-27 19:40:19 +00003094 if (FinalPhase == phases::Link) {
3095 if (Args.hasArg(options::OPT_emit_llvm))
3096 Diag(clang::diag::err_drv_emit_llvm_link);
3097 if (IsCLMode() && LTOMode != LTOK_None &&
3098 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
3099 Diag(clang::diag::err_drv_lto_without_lld);
Rafael Espindolae8025642013-08-25 14:27:09 +00003100 }
3101
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003102 // Reject -Z* at the top level, these options should never have been exposed
3103 // by gcc.
Daniel Dunbardd765242009-03-26 16:12:09 +00003104 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
Daniel Dunbar0e759942009-03-20 06:14:23 +00003105 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00003106
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003107 // Diagnose misuse of /Fo.
3108 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003109 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003110 if (Inputs.size() > 1 && !V.empty() &&
3111 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003112 // Check whether /Fo tries to name an output file for multiple inputs.
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003113 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003114 << A->getSpelling() << V;
Hans Wennborg13b7fe72013-08-12 23:26:25 +00003115 Args.eraseArg(options::OPT__SLASH_Fo);
3116 }
3117 }
3118
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003119 // Diagnose misuse of /Fa.
3120 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
3121 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00003122 if (Inputs.size() > 1 && !V.empty() &&
3123 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003124 // Check whether /Fa tries to name an asm file for multiple inputs.
3125 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003126 << A->getSpelling() << V;
Hans Wennborg9c1659b2013-10-18 22:49:04 +00003127 Args.eraseArg(options::OPT__SLASH_Fa);
3128 }
3129 }
3130
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00003131 // Diagnose misuse of /o.
3132 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
3133 if (A->getValue()[0] == '\0') {
3134 // It has to have a value.
3135 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
3136 Args.eraseArg(options::OPT__SLASH_o);
3137 }
3138 }
3139
Mike Rice58df1af2018-09-11 17:10:44 +00003140 // Ignore /Yc/Yu if both /Yc and /Yu passed but with different filenames.
Nico Weber2ca4be92016-03-01 23:16:44 +00003141 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
3142 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
Nico Weber2ca4be92016-03-01 23:16:44 +00003143 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
3144 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
3145 Args.eraseArg(options::OPT__SLASH_Yc);
3146 Args.eraseArg(options::OPT__SLASH_Yu);
3147 YcArg = YuArg = nullptr;
3148 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003149 if (YcArg && Inputs.size() > 1) {
3150 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
3151 Args.eraseArg(options::OPT__SLASH_Yc);
3152 YcArg = nullptr;
3153 }
Erich Keaneeaca3882018-08-17 13:43:39 +00003154 if (FinalPhase == phases::Preprocess || Args.hasArg(options::OPT__SLASH_Y_)) {
3155 // If only preprocessing or /Y- is used, all pch handling is disabled.
3156 // Rather than check for it everywhere, just remove clang-cl pch-related
3157 // flags here.
Nico Weber2ca4be92016-03-01 23:16:44 +00003158 Args.eraseArg(options::OPT__SLASH_Fp);
3159 Args.eraseArg(options::OPT__SLASH_Yc);
3160 Args.eraseArg(options::OPT__SLASH_Yu);
3161 YcArg = YuArg = nullptr;
3162 }
Nico Weber2ca4be92016-03-01 23:16:44 +00003163
Samuel Antao64e965e2016-09-30 15:34:19 +00003164 // Builder to be used to build offloading actions.
3165 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
Samuel Antaod06239d2016-07-15 23:13:27 +00003166
Daniel Dunbar65229332009-03-13 11:38:42 +00003167 // Construct the actions to perform.
Richard Smithcd35eff2018-09-15 01:21:16 +00003168 HeaderModulePrecompileJobAction *HeaderModuleAction = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003169 ActionList LinkerInputs;
Alp Toker965f8822013-11-27 05:22:15 +00003170
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003171 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
Artem Belevich5bde4e02015-07-20 20:02:54 +00003172 for (auto &I : Inputs) {
3173 types::ID InputType = I.first;
3174 const Arg *InputArg = I.second;
Daniel Dunbar65229332009-03-13 11:38:42 +00003175
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003176 PL.clear();
3177 types::getCompilationPhases(InputType, PL);
Daniel Dunbar65229332009-03-13 11:38:42 +00003178
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003179 // If the first step comes after the final phase we are doing as part of
3180 // this compilation, warn the user about it.
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003181 phases::ID InitialPhase = PL[0];
Daniel Dunbar65229332009-03-13 11:38:42 +00003182 if (InitialPhase > FinalPhase) {
Martin Storsjo665c7a42018-05-04 06:05:58 +00003183 if (InputArg->isClaimed())
3184 continue;
3185
Daniel Dunbaradc5c7c2009-03-19 07:57:08 +00003186 // Claim here to avoid the more general unused warning.
3187 InputArg->claim();
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003188
Daniel Dunbar2db3e732011-04-20 15:44:48 +00003189 // Suppress all unused style warnings with -Qunused-arguments
3190 if (Args.hasArg(options::OPT_Qunused_arguments))
3191 continue;
3192
Richard Smith403f76e2012-08-06 04:09:06 +00003193 // Special case when final phase determined by binary name, rather than
3194 // by a command-line argument with a corresponding Arg.
Hans Wennborg70850d82013-07-18 20:29:38 +00003195 if (CCCIsCPP())
Richard Smith403f76e2012-08-06 04:09:06 +00003196 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003197 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003198 // Special case '-E' warning on a previously preprocessed file to make
3199 // more sense.
Richard Smith403f76e2012-08-06 04:09:06 +00003200 else if (InitialPhase == phases::Compile &&
3201 FinalPhase == phases::Preprocess &&
3202 getPreprocessedType(InputType) == types::TY_INVALID)
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003203 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003204 << InputArg->getAsString(Args) << !!FinalPhaseArg
3205 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar07806ca2009-09-17 04:13:26 +00003206 else
3207 Diag(clang::diag::warn_drv_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003208 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
3209 << !!FinalPhaseArg
3210 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar65229332009-03-13 11:38:42 +00003211 continue;
3212 }
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003213
Nico Weberad2d8f32016-04-21 19:59:10 +00003214 if (YcArg) {
3215 // Add a separate precompile phase for the compile phase.
3216 if (FinalPhase >= phases::Compile) {
Richard Smith8cd452d2016-08-30 18:55:16 +00003217 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003218 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
Richard Smith8cd452d2016-08-30 18:55:16 +00003219 types::getCompilationPhases(HeaderType, PCHPL);
Nico Weberad2d8f32016-04-21 19:59:10 +00003220 // Build the pipeline for the pch file.
Richard Smith8cd452d2016-08-30 18:55:16 +00003221 Action *ClangClPch =
Erich Keane76675de2018-07-05 17:22:13 +00003222 C.MakeAction<InputAction>(*InputArg, HeaderType);
Nico Weberad2d8f32016-04-21 19:59:10 +00003223 for (phases::ID Phase : PCHPL)
3224 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
3225 assert(ClangClPch);
3226 Actions.push_back(ClangClPch);
3227 // The driver currently exits after the first failed command. This
3228 // relies on that behavior, to make sure if the pch generation fails,
3229 // the main compilation won't run.
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00003230 // FIXME: If the main compilation fails, the PCH generation should
3231 // probably not be considered successful either.
Nico Weberad2d8f32016-04-21 19:59:10 +00003232 }
3233 }
3234
Daniel Dunbar65229332009-03-13 11:38:42 +00003235 // Build the pipeline for this file.
Justin Lebar41094612016-01-11 23:07:27 +00003236 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
Samuel Antao64e965e2016-09-30 15:34:19 +00003237
3238 // Use the current host action in any of the offloading actions, if
3239 // required.
3240 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3241 break;
3242
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003243 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
3244 i != e; ++i) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003245 phases::ID Phase = *i;
Daniel Dunbar65229332009-03-13 11:38:42 +00003246
3247 // We are done if this step is past what the user requested.
3248 if (Phase > FinalPhase)
3249 break;
3250
Samuel Antao64e965e2016-09-30 15:34:19 +00003251 // Add any offload action the host action depends on.
3252 Current = OffloadBuilder.addDeviceDependencesToHostAction(
3253 Current, InputArg, Phase, FinalPhase, PL);
3254 if (!Current)
3255 break;
3256
Daniel Dunbar65229332009-03-13 11:38:42 +00003257 // Queue linker inputs.
3258 if (Phase == phases::Link) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00003259 assert((i + 1) == e && "linking must be final compilation step.");
Justin Lebar41094612016-01-11 23:07:27 +00003260 LinkerInputs.push_back(Current);
3261 Current = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00003262 break;
3263 }
3264
Richard Smithcd35eff2018-09-15 01:21:16 +00003265 // Each precompiled header file after a module file action is a module
3266 // header of that same module file, rather than being compiled to a
3267 // separate PCH.
3268 if (Phase == phases::Precompile && HeaderModuleAction &&
3269 getPrecompiledType(InputType) == types::TY_PCH) {
3270 HeaderModuleAction->addModuleHeaderInput(Current);
3271 Current = nullptr;
3272 break;
3273 }
3274
3275 // FIXME: Should we include any prior module file outputs as inputs of
3276 // later actions in the same command line?
3277
Samuel Antao64e965e2016-09-30 15:34:19 +00003278 // Otherwise construct the appropriate action.
Richard Smithcd35eff2018-09-15 01:21:16 +00003279 Action *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003280
3281 // We didn't create a new action, so we will just move to the next phase.
3282 if (NewCurrent == Current)
Daniel Dunbar13864952009-03-24 20:17:30 +00003283 continue;
3284
Richard Smithcd35eff2018-09-15 01:21:16 +00003285 if (auto *HMA = dyn_cast<HeaderModulePrecompileJobAction>(NewCurrent))
3286 HeaderModuleAction = HMA;
3287
Samuel Antao64e965e2016-09-30 15:34:19 +00003288 Current = NewCurrent;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003289
Samuel Antao64e965e2016-09-30 15:34:19 +00003290 // Use the current host action in any of the offloading actions, if
3291 // required.
3292 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
3293 break;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003294
Daniel Dunbar65229332009-03-13 11:38:42 +00003295 if (Current->getType() == types::TY_Nothing)
3296 break;
3297 }
3298
Samuel Antao64e965e2016-09-30 15:34:19 +00003299 // If we ended with something, add to the output list.
3300 if (Current)
Justin Lebar41094612016-01-11 23:07:27 +00003301 Actions.push_back(Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00003302
3303 // Add any top level actions generated for offloading.
3304 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003305 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003306
Samuel Antao64e965e2016-09-30 15:34:19 +00003307 // Add a link action if necessary.
Samuel Antaod06239d2016-07-15 23:13:27 +00003308 if (!LinkerInputs.empty()) {
Samuel Antao64e965e2016-09-30 15:34:19 +00003309 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
3310 LA = OffloadBuilder.processHostLinkAction(LA);
3311 Actions.push_back(LA);
Samuel Antaod06239d2016-07-15 23:13:27 +00003312 }
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003313
3314 // If we are linking, claim any options which are obviously only used for
3315 // compilation.
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003316 if (FinalPhase == phases::Link && PL.size() == 1) {
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00003317 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
Hans Wennborga8ef14f2013-09-17 00:03:41 +00003318 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
3319 }
3320
3321 // Claim ignored clang-cl options.
3322 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
Artem Belevichbaae0932015-07-28 21:01:30 +00003323
Justin Lebardc3c5042016-04-19 02:27:07 +00003324 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
3325 // to non-CUDA compilations and should not trigger warnings there.
Artem Belevichbaae0932015-07-28 21:01:30 +00003326 Args.ClaimAllArgs(options::OPT_cuda_host_only);
Justin Lebardc3c5042016-04-19 02:27:07 +00003327 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
Daniel Dunbar65229332009-03-13 11:38:42 +00003328}
3329
Artem Belevichecb178b2018-03-21 22:22:59 +00003330Action *Driver::ConstructPhaseAction(
3331 Compilation &C, const ArgList &Args, phases::ID Phase, Action *Input,
3332 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003333 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
Samuel Antao64e965e2016-09-30 15:34:19 +00003334
3335 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
3336 // encode this in the steps because the intermediate type depends on
3337 // arguments. Just special case here.
3338 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
3339 return Input;
3340
Daniel Dunbar65229332009-03-13 11:38:42 +00003341 // Build the appropriate action.
3342 switch (Phase) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003343 case phases::Link:
3344 llvm_unreachable("link action invalid here.");
Daniel Dunbar65229332009-03-13 11:38:42 +00003345 case phases::Preprocess: {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003346 types::ID OutputTy;
3347 // -{M, MM} alter the output type.
Daniel Dunbar86aed7d2010-12-08 21:33:40 +00003348 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
Daniel Dunbard67a3222009-03-30 06:36:42 +00003349 OutputTy = types::TY_Dependencies;
3350 } else {
David Blaikie5d577a22012-06-29 22:03:56 +00003351 OutputTy = Input->getType();
3352 if (!Args.hasFlag(options::OPT_frewrite_includes,
Justin Bognerce8245b2014-06-24 08:01:01 +00003353 options::OPT_fno_rewrite_includes, false) &&
Richard Smith86a3ef52017-06-09 21:24:02 +00003354 !Args.hasFlag(options::OPT_frewrite_imports,
3355 options::OPT_fno_rewrite_imports, false) &&
Justin Bognerce8245b2014-06-24 08:01:01 +00003356 !CCGenDiagnostics)
David Blaikie5d577a22012-06-29 22:03:56 +00003357 OutputTy = types::getPreprocessedType(OutputTy);
Daniel Dunbard67a3222009-03-30 06:36:42 +00003358 assert(OutputTy != types::TY_INVALID &&
3359 "Cannot preprocess this input type!");
3360 }
Justin Lebar41094612016-01-11 23:07:27 +00003361 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
Daniel Dunbar65229332009-03-13 11:38:42 +00003362 }
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003363 case phases::Precompile: {
Richard Smithdd4ad3d2016-08-30 19:06:26 +00003364 types::ID OutputTy = getPrecompiledType(Input->getType());
3365 assert(OutputTy != types::TY_INVALID &&
3366 "Cannot precompile this input type!");
Richard Smithcd35eff2018-09-15 01:21:16 +00003367
3368 // If we're given a module name, precompile header file inputs as a
3369 // module, not as a precompiled header.
3370 const char *ModName = nullptr;
3371 if (OutputTy == types::TY_PCH) {
3372 if (Arg *A = Args.getLastArg(options::OPT_fmodule_name_EQ))
3373 ModName = A->getValue();
3374 if (ModName)
3375 OutputTy = types::TY_ModuleFile;
3376 }
3377
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003378 if (Args.hasArg(options::OPT_fsyntax_only)) {
3379 // Syntax checks should not emit a PCH file
3380 OutputTy = types::TY_Nothing;
3381 }
Richard Smithcd35eff2018-09-15 01:21:16 +00003382
3383 if (ModName)
3384 return C.MakeAction<HeaderModulePrecompileJobAction>(Input, OutputTy,
3385 ModName);
Justin Lebar41094612016-01-11 23:07:27 +00003386 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
Aaron Ballman1f10cc52012-07-31 01:21:00 +00003387 }
Daniel Dunbar65229332009-03-13 11:38:42 +00003388 case phases::Compile: {
David Blaikie486f4402014-08-29 07:25:23 +00003389 if (Args.hasArg(options::OPT_fsyntax_only))
Justin Lebar41094612016-01-11 23:07:27 +00003390 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
David Blaikie486f4402014-08-29 07:25:23 +00003391 if (Args.hasArg(options::OPT_rewrite_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003392 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003393 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
Justin Lebar41094612016-01-11 23:07:27 +00003394 return C.MakeAction<CompileJobAction>(Input,
3395 types::TY_RewrittenLegacyObjC);
David Blaikie486f4402014-08-29 07:25:23 +00003396 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
Justin Lebar41094612016-01-11 23:07:27 +00003397 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
David Blaikie486f4402014-08-29 07:25:23 +00003398 if (Args.hasArg(options::OPT__migrate))
Justin Lebar41094612016-01-11 23:07:27 +00003399 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
David Blaikie486f4402014-08-29 07:25:23 +00003400 if (Args.hasArg(options::OPT_emit_ast))
Justin Lebar41094612016-01-11 23:07:27 +00003401 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
David Blaikie486f4402014-08-29 07:25:23 +00003402 if (Args.hasArg(options::OPT_module_file_info))
Justin Lebar41094612016-01-11 23:07:27 +00003403 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
David Blaikie486f4402014-08-29 07:25:23 +00003404 if (Args.hasArg(options::OPT_verify_pch))
Justin Lebar41094612016-01-11 23:07:27 +00003405 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
3406 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
Bob Wilson23a55f12014-12-21 07:00:00 +00003407 }
3408 case phases::Backend: {
Artem Belevichecb178b2018-03-21 22:22:59 +00003409 if (isUsingLTO() && TargetDeviceOffloadKind == Action::OFK_None) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003410 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003411 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003412 return C.MakeAction<BackendJobAction>(Input, Output);
David Blaikie486f4402014-08-29 07:25:23 +00003413 }
3414 if (Args.hasArg(options::OPT_emit_llvm)) {
Shuxin Yang4b3c7ff2013-08-23 21:34:57 +00003415 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003416 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
Justin Lebar41094612016-01-11 23:07:27 +00003417 return C.MakeAction<BackendJobAction>(Input, Output);
Daniel Dunbar65229332009-03-13 11:38:42 +00003418 }
Justin Lebar41094612016-01-11 23:07:27 +00003419 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
Daniel Dunbar65229332009-03-13 11:38:42 +00003420 }
3421 case phases::Assemble:
Justin Lebar21e5d4f2016-01-14 21:41:27 +00003422 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
Daniel Dunbar65229332009-03-13 11:38:42 +00003423 }
3424
David Blaikie83d382b2011-09-23 05:06:16 +00003425 llvm_unreachable("invalid phase in ConstructPhaseAction");
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00003426}
3427
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00003428void Driver::BuildJobs(Compilation &C) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003429 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003430
3431 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3432
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003433 // It is an error to provide a -o option if we are making multiple output
3434 // files.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003435 if (FinalOutput) {
3436 unsigned NumOutputs = 0;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003437 for (const Action *A : C.getActions())
3438 if (A->getType() != types::TY_Nothing)
Daniel Dunbare75d8342009-03-16 06:56:51 +00003439 ++NumOutputs;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003440
Daniel Dunbare75d8342009-03-16 06:56:51 +00003441 if (NumOutputs > 1) {
3442 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
Craig Topper92fc2df2014-05-17 16:56:41 +00003443 FinalOutput = nullptr;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003444 }
3445 }
3446
Chad Rosier35767232013-04-30 22:01:21 +00003447 // Collect the list of architectures.
3448 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003449 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
3450 for (const Arg *A : C.getArgs())
Chad Rosier35767232013-04-30 22:01:21 +00003451 if (A->getOption().matches(options::OPT_arch))
3452 ArchNames.insert(A->getValue());
Chad Rosier35767232013-04-30 22:01:21 +00003453
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003454 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
3455 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003456 for (Action *A : C.getActions()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003457 // If we are linking an image for multiple archs then the linker wants
3458 // -arch_multiple and -final_output <final image name>. Unfortunately, this
3459 // doesn't fit in cleanly because we have to pass this information down.
Daniel Dunbare75d8342009-03-16 06:56:51 +00003460 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003461 // FIXME: This is a hack; find a cleaner way to integrate this into the
3462 // process.
Craig Topper92fc2df2014-05-17 16:56:41 +00003463 const char *LinkingOutput = nullptr;
Daniel Dunbardd765242009-03-26 16:12:09 +00003464 if (isa<LipoJobAction>(A)) {
Daniel Dunbare75d8342009-03-16 06:56:51 +00003465 if (FinalOutput)
Richard Smithbd55daf2012-11-01 04:30:05 +00003466 LinkingOutput = FinalOutput->getValue();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003467 else
Hans Wennborga7707222015-01-09 17:38:53 +00003468 LinkingOutput = getDefaultImageName();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003469 }
3470
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003471 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003472 /*BoundArch*/ StringRef(),
Daniel Dunbare75d8342009-03-16 06:56:51 +00003473 /*AtTopLevel*/ true,
Chad Rosier35767232013-04-30 22:01:21 +00003474 /*MultipleArchs*/ ArchNames.size() > 1,
Samuel Antaod06239d2016-07-15 23:13:27 +00003475 /*LinkingOutput*/ LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003476 /*TargetDeviceOffloadKind*/ Action::OFK_None);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003477 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003478
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003479 // If the user passed -Qunused-arguments or there were errors, don't warn
3480 // about any unused arguments.
Argyrios Kyrtzidis31448a42010-11-18 21:47:07 +00003481 if (Diags.hasErrorOccurred() ||
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003482 C.getArgs().hasArg(options::OPT_Qunused_arguments))
Daniel Dunbard175d972009-03-18 18:03:46 +00003483 return;
3484
Daniel Dunbar58399ae2009-03-29 22:24:54 +00003485 // Claim -### here.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003486 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003487
Nico Weber47bf5052016-04-25 21:15:49 +00003488 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003489 (void)C.getArgs().hasArg(options::OPT_driver_mode);
Nico Weber47bf5052016-04-25 21:15:49 +00003490 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
Hans Wennborg70850d82013-07-18 20:29:38 +00003491
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00003492 for (Arg *A : C.getArgs()) {
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003493 // FIXME: It would be nice to be able to send the argument to the
David Blaikie9c902b52011-09-25 23:23:43 +00003494 // DiagnosticsEngine, so that extra values, position, and so on could be
3495 // printed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003496 if (!A->isClaimed()) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +00003497 if (A->getOption().hasFlag(options::NoArgumentUnused))
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00003498 continue;
3499
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003500 // Suppress the warning automatically if this is just a flag, and it is an
3501 // instance of an argument we already claimed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003502 const Option &Opt = A->getOption();
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00003503 if (Opt.getKind() == Option::FlagClass) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003504 bool DuplicateClaimed = false;
3505
Sean Silva14facf32015-06-09 01:57:17 +00003506 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
3507 if (AA->isClaimed()) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003508 DuplicateClaimed = true;
3509 break;
3510 }
3511 }
3512
3513 if (DuplicateClaimed)
3514 continue;
3515 }
3516
Ehsan Akhgarid8518332016-01-25 21:14:52 +00003517 // In clang-cl, don't mention unknown arguments here since they have
3518 // already been warned about.
3519 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
3520 Diag(clang::diag::warn_drv_unused_argument)
3521 << A->getAsString(C.getArgs());
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00003522 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00003523 }
Daniel Dunbar95e6b192009-03-13 22:12:33 +00003524}
Daniel Dunbarc4343942010-02-03 03:07:56 +00003525
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003526namespace {
3527/// Utility class to control the collapse of dependent actions and select the
3528/// tools accordingly.
3529class ToolSelector final {
3530 /// The tool chain this selector refers to.
3531 const ToolChain &TC;
Daniel Dunbarf9ff3502010-05-14 02:03:00 +00003532
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003533 /// The compilation this selector refers to.
3534 const Compilation &C;
Samuel Antaod06239d2016-07-15 23:13:27 +00003535
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003536 /// The base action this selector refers to.
3537 const JobAction *BaseAction;
Samuel Antaod06239d2016-07-15 23:13:27 +00003538
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003539 /// Set to true if the current toolchain refers to host actions.
3540 bool IsHostSelector;
Samuel Antaod06239d2016-07-15 23:13:27 +00003541
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003542 /// Set to true if save-temps and embed-bitcode functionalities are active.
3543 bool SaveTemps;
3544 bool EmbedBitcode;
3545
3546 /// Get previous dependent action or null if that does not exist. If
3547 /// \a CanBeCollapsed is false, that action must be legal to collapse or
3548 /// null will be returned.
3549 const JobAction *getPrevDependentAction(const ActionList &Inputs,
3550 ActionList &SavedOffloadAction,
3551 bool CanBeCollapsed = true) {
3552 // An option can be collapsed only if it has a single input.
3553 if (Inputs.size() != 1)
Craig Topper92fc2df2014-05-17 16:56:41 +00003554 return nullptr;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003555
3556 Action *CurAction = *Inputs.begin();
3557 if (CanBeCollapsed &&
3558 !CurAction->isCollapsingWithNextDependentActionLegal())
3559 return nullptr;
3560
3561 // If the input action is an offload action. Look through it and save any
3562 // offload action that can be dropped in the event of a collapse.
3563 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
3564 // If the dependent action is a device action, we will attempt to collapse
3565 // only with other device actions. Otherwise, we would do the same but
3566 // with host actions only.
3567 if (!IsHostSelector) {
3568 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
3569 CurAction =
3570 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
3571 if (CanBeCollapsed &&
3572 !CurAction->isCollapsingWithNextDependentActionLegal())
3573 return nullptr;
3574 SavedOffloadAction.push_back(OA);
3575 return dyn_cast<JobAction>(CurAction);
3576 }
3577 } else if (OA->hasHostDependence()) {
3578 CurAction = OA->getHostDependence();
3579 if (CanBeCollapsed &&
3580 !CurAction->isCollapsingWithNextDependentActionLegal())
3581 return nullptr;
3582 SavedOffloadAction.push_back(OA);
3583 return dyn_cast<JobAction>(CurAction);
3584 }
3585 return nullptr;
3586 }
3587
3588 return dyn_cast<JobAction>(CurAction);
3589 }
3590
3591 /// Return true if an assemble action can be collapsed.
3592 bool canCollapseAssembleAction() const {
3593 return TC.useIntegratedAs() && !SaveTemps &&
3594 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
3595 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
3596 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
3597 }
3598
3599 /// Return true if a preprocessor action can be collapsed.
3600 bool canCollapsePreprocessorAction() const {
3601 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
3602 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
3603 !C.getArgs().hasArg(options::OPT_rewrite_objc);
3604 }
3605
3606 /// Struct that relates an action with the offload actions that would be
3607 /// collapsed with it.
3608 struct JobActionInfo final {
3609 /// The action this info refers to.
3610 const JobAction *JA = nullptr;
3611 /// The offload actions we need to take care off if this action is
3612 /// collapsed.
3613 ActionList SavedOffloadAction;
3614 };
3615
3616 /// Append collapsed offload actions from the give nnumber of elements in the
3617 /// action info array.
3618 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
3619 ArrayRef<JobActionInfo> &ActionInfo,
3620 unsigned ElementNum) {
3621 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
3622 for (unsigned I = 0; I < ElementNum; ++I)
3623 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
3624 ActionInfo[I].SavedOffloadAction.end());
3625 }
3626
3627 /// Functions that attempt to perform the combining. They detect if that is
3628 /// legal, and if so they update the inputs \a Inputs and the offload action
3629 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
3630 /// the combined action is returned. If the combining is not legal or if the
3631 /// tool does not exist, null is returned.
3632 /// Currently three kinds of collapsing are supported:
3633 /// - Assemble + Backend + Compile;
3634 /// - Assemble + Backend ;
3635 /// - Backend + Compile.
3636 const Tool *
3637 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003638 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003639 ActionList &CollapsedOffloadAction) {
3640 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
3641 return nullptr;
3642 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3643 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3644 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
3645 if (!AJ || !BJ || !CJ)
3646 return nullptr;
3647
3648 // Get compiler tool.
3649 const Tool *T = TC.SelectTool(*CJ);
3650 if (!T)
3651 return nullptr;
3652
Steven Wu574b0f22016-03-01 01:07:58 +00003653 // When using -fembed-bitcode, it is required to have the same tool (clang)
3654 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
3655 if (EmbedBitcode) {
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003656 const Tool *BT = TC.SelectTool(*BJ);
3657 if (BT == T)
3658 return nullptr;
Steven Wu574b0f22016-03-01 01:07:58 +00003659 }
Bob Wilson23a55f12014-12-21 07:00:00 +00003660
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003661 if (!T->hasIntegratedAssembler())
Bob Wilson23a55f12014-12-21 07:00:00 +00003662 return nullptr;
Samuel Antaod06239d2016-07-15 23:13:27 +00003663
Richard Smithcd35eff2018-09-15 01:21:16 +00003664 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003665 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3666 /*NumElements=*/3);
3667 return T;
3668 }
3669 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003670 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003671 ActionList &CollapsedOffloadAction) {
3672 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
3673 return nullptr;
3674 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3675 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3676 if (!AJ || !BJ)
3677 return nullptr;
3678
3679 // Retrieve the compile job, backend action must always be preceded by one.
3680 ActionList CompileJobOffloadActions;
3681 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
3682 /*CanBeCollapsed=*/false);
3683 if (!AJ || !BJ || !CJ)
3684 return nullptr;
3685
3686 assert(isa<CompileJobAction>(CJ) &&
3687 "Expecting compile job preceding backend job.");
3688
3689 // Get compiler tool.
3690 const Tool *T = TC.SelectTool(*CJ);
3691 if (!T)
3692 return nullptr;
3693
3694 if (!T->hasIntegratedAssembler())
3695 return nullptr;
3696
Richard Smithcd35eff2018-09-15 01:21:16 +00003697 Inputs = BJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003698 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3699 /*NumElements=*/2);
3700 return T;
3701 }
3702 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
Richard Smithcd35eff2018-09-15 01:21:16 +00003703 ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003704 ActionList &CollapsedOffloadAction) {
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003705 if (ActionInfo.size() < 2)
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003706 return nullptr;
3707 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3708 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3709 if (!BJ || !CJ)
3710 return nullptr;
3711
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003712 // Check if the initial input (to the compile job or its predessor if one
3713 // exists) is LLVM bitcode. In that case, no preprocessor step is required
3714 // and we can still collapse the compile and backend jobs when we have
3715 // -save-temps. I.e. there is no need for a separate compile job just to
3716 // emit unoptimized bitcode.
3717 bool InputIsBitcode = true;
3718 for (size_t i = 1; i < ActionInfo.size(); i++)
3719 if (ActionInfo[i].JA->getType() != types::TY_LLVM_BC &&
3720 ActionInfo[i].JA->getType() != types::TY_LTO_BC) {
3721 InputIsBitcode = false;
3722 break;
3723 }
3724 if (!InputIsBitcode && !canCollapsePreprocessorAction())
3725 return nullptr;
3726
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003727 // Get compiler tool.
3728 const Tool *T = TC.SelectTool(*CJ);
3729 if (!T)
3730 return nullptr;
3731
Teresa Johnson9e4321c2018-04-17 16:39:25 +00003732 if (T->canEmitIR() && ((SaveTemps && !InputIsBitcode) || EmbedBitcode))
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003733 return nullptr;
3734
Richard Smithcd35eff2018-09-15 01:21:16 +00003735 Inputs = CJ->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003736 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3737 /*NumElements=*/2);
3738 return T;
3739 }
3740
3741 /// Updates the inputs if the obtained tool supports combining with
3742 /// preprocessor action, and the current input is indeed a preprocessor
3743 /// action. If combining results in the collapse of offloading actions, those
3744 /// are appended to \a CollapsedOffloadAction.
Richard Smithcd35eff2018-09-15 01:21:16 +00003745 void combineWithPreprocessor(const Tool *T, ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003746 ActionList &CollapsedOffloadAction) {
3747 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3748 return;
3749
3750 // Attempt to get a preprocessor action dependence.
3751 ActionList PreprocessJobOffloadActions;
Richard Smithcd35eff2018-09-15 01:21:16 +00003752 ActionList NewInputs;
3753 for (Action *A : Inputs) {
3754 auto *PJ = getPrevDependentAction({A}, PreprocessJobOffloadActions);
3755 if (!PJ || !isa<PreprocessJobAction>(PJ)) {
3756 NewInputs.push_back(A);
3757 continue;
3758 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003759
Richard Smithcd35eff2018-09-15 01:21:16 +00003760 // This is legal to combine. Append any offload action we found and add the
3761 // current input to preprocessor inputs.
3762 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3763 PreprocessJobOffloadActions.end());
3764 NewInputs.append(PJ->input_begin(), PJ->input_end());
3765 }
3766 Inputs = NewInputs;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003767 }
3768
3769public:
3770 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3771 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3772 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3773 EmbedBitcode(EmbedBitcode) {
3774 assert(BaseAction && "Invalid base action.");
3775 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3776 }
3777
3778 /// Check if a chain of actions can be combined and return the tool that can
3779 /// handle the combination of actions. The pointer to the current inputs \a
3780 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3781 /// connected to collapsed actions are updated accordingly. The latter enables
3782 /// the caller of the selector to process them afterwards instead of just
3783 /// dropping them. If no suitable tool is found, null will be returned.
Richard Smithcd35eff2018-09-15 01:21:16 +00003784 const Tool *getTool(ActionList &Inputs,
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003785 ActionList &CollapsedOffloadAction) {
3786 //
3787 // Get the largest chain of actions that we could combine.
3788 //
3789
3790 SmallVector<JobActionInfo, 5> ActionChain(1);
3791 ActionChain.back().JA = BaseAction;
3792 while (ActionChain.back().JA) {
3793 const Action *CurAction = ActionChain.back().JA;
3794
3795 // Grow the chain by one element.
3796 ActionChain.resize(ActionChain.size() + 1);
3797 JobActionInfo &AI = ActionChain.back();
3798
3799 // Attempt to fill it with the
3800 AI.JA =
3801 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
Daniel Dunbarc4343942010-02-03 03:07:56 +00003802 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003803
3804 // Pop the last action info as it could not be filled.
3805 ActionChain.pop_back();
3806
3807 //
3808 // Attempt to combine actions. If all combining attempts failed, just return
3809 // the tool of the provided action. At the end we attempt to combine the
3810 // action with any preprocessor action it may depend on.
3811 //
3812
3813 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3814 CollapsedOffloadAction);
3815 if (!T)
3816 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3817 if (!T)
3818 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3819 if (!T) {
Richard Smithcd35eff2018-09-15 01:21:16 +00003820 Inputs = BaseAction->getInputs();
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003821 T = TC.SelectTool(*BaseAction);
3822 }
3823
3824 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3825 return T;
Daniel Dunbarc4343942010-02-03 03:07:56 +00003826 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003827};
Daniel Dunbarc4343942010-02-03 03:07:56 +00003828}
3829
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003830/// Return a string that uniquely identifies the result of a job. The bound arch
3831/// is not necessarily represented in the toolchain's triple -- for example,
3832/// armv7 and armv7s both map to the same triple -- so we need both in our map.
3833/// Also, we need to add the offloading device kind, as the same tool chain can
3834/// be used for host and device for some programming models, e.g. OpenMP.
3835static std::string GetTriplePlusArchString(const ToolChain *TC,
3836 StringRef BoundArch,
3837 Action::OffloadKind OffloadKind) {
Justin Lebar55c83322016-01-16 03:30:08 +00003838 std::string TriplePlusArch = TC->getTriple().normalize();
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003839 if (!BoundArch.empty()) {
Justin Lebar55c83322016-01-16 03:30:08 +00003840 TriplePlusArch += "-";
3841 TriplePlusArch += BoundArch;
3842 }
Samuel Antao59efaed2016-10-27 17:31:22 +00003843 TriplePlusArch += "-";
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003844 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3845 return TriplePlusArch;
3846}
3847
3848InputInfo Driver::BuildJobsForAction(
3849 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3850 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3851 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3852 Action::OffloadKind TargetDeviceOffloadKind) const {
3853 std::pair<const Action *, std::string> ActionTC = {
3854 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003855 auto CachedResult = CachedResults.find(ActionTC);
3856 if (CachedResult != CachedResults.end()) {
3857 return CachedResult->second;
3858 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003859 InputInfo Result = BuildJobsForActionNoCache(
3860 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003861 CachedResults, TargetDeviceOffloadKind);
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003862 CachedResults[ActionTC] = Result;
3863 return Result;
3864}
3865
3866InputInfo Driver::BuildJobsForActionNoCache(
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003867 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003868 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
Samuel Antaod06239d2016-07-15 23:13:27 +00003869 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003870 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003871 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbarc4acf9d2009-03-18 23:18:19 +00003872
Samuel Antaod06239d2016-07-15 23:13:27 +00003873 InputInfoList OffloadDependencesInputInfo;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003874 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
Samuel Antaod06239d2016-07-15 23:13:27 +00003875 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
Alex Lorenz4003a982017-08-08 11:22:21 +00003876 // The 'Darwin' toolchain is initialized only when its arguments are
3877 // computed. Get the default arguments for OFK_None to ensure that
3878 // initialization is performed before processing the offload action.
3879 // FIXME: Remove when darwin's toolchain is initialized during construction.
3880 C.getArgsForToolChain(TC, BoundArch, Action::OFK_None);
3881
Samuel Antaod06239d2016-07-15 23:13:27 +00003882 // The offload action is expected to be used in four different situations.
3883 //
3884 // a) Set a toolchain/architecture/kind for a host action:
3885 // Host Action 1 -> OffloadAction -> Host Action 2
3886 //
3887 // b) Set a toolchain/architecture/kind for a device action;
3888 // Device Action 1 -> OffloadAction -> Device Action 2
3889 //
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003890 // c) Specify a device dependence to a host action;
Samuel Antaod06239d2016-07-15 23:13:27 +00003891 // Device Action 1 _
3892 // \
3893 // Host Action 1 ---> OffloadAction -> Host Action 2
3894 //
3895 // d) Specify a host dependence to a device action.
3896 // Host Action 1 _
3897 // \
3898 // Device Action 1 ---> OffloadAction -> Device Action 2
3899 //
3900 // For a) and b), we just return the job generated for the dependence. For
3901 // c) and d) we override the current action with the host/device dependence
3902 // if the current toolchain is host/device and set the offload dependences
3903 // info with the jobs obtained from the device/host dependence(s).
3904
3905 // If there is a single device option, just generate the job for it.
3906 if (OA->hasSingleDeviceDependence()) {
3907 InputInfo DevA;
3908 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3909 const char *DepBoundArch) {
3910 DevA =
3911 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3912 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003913 CachedResults, DepA->getOffloadingDeviceKind());
Samuel Antaod06239d2016-07-15 23:13:27 +00003914 });
3915 return DevA;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003916 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003917
3918 // If 'Action 2' is host, we generate jobs for the device dependences and
3919 // override the current action with the host dependence. Otherwise, we
3920 // generate the host dependences and override the action with the device
3921 // dependence. The dependences can't therefore be a top-level action.
3922 OA->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003923 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003924 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3925 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3926 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3927 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003928 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003929 });
3930
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003931 A = BuildingForOffloadDevice
Samuel Antaod06239d2016-07-15 23:13:27 +00003932 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3933 : OA->getHostDependence();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003934 }
3935
Daniel Dunbare75d8342009-03-16 06:56:51 +00003936 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003937 // FIXME: It would be nice to not claim this here; maybe the old scheme of
3938 // just using Args was better?
Daniel Dunbar5cdf3e02009-03-19 07:29:38 +00003939 const Arg &Input = IA->getInputArg();
3940 Input.claim();
Daniel Dunbar35cbfeb2010-06-09 22:31:08 +00003941 if (Input.getOption().matches(options::OPT_INPUT)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00003942 const char *Name = Input.getValue();
Justin Lebard98cea82016-01-11 23:15:21 +00003943 return InputInfo(A, Name, /* BaseInput = */ Name);
Douglas Katzman678d0cb2015-06-16 18:01:24 +00003944 }
Justin Lebard98cea82016-01-11 23:15:21 +00003945 return InputInfo(A, &Input, /* BaseInput = */ "");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003946 }
3947
3948 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003949 const ToolChain *TC;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003950 StringRef ArchName = BAA->getArchName();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003951
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003952 if (!ArchName.empty())
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003953 TC = &getToolChain(C.getArgs(),
Petr Hosekdd38d932018-05-29 22:35:39 +00003954 computeTargetTriple(*this, TargetTriple,
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003955 C.getArgs(), ArchName));
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003956 else
3957 TC = &C.getDefaultToolChain();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003958
Nico Weber5a459f82016-02-23 19:30:43 +00003959 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00003960 MultipleArchs, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003961 TargetDeviceOffloadKind);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003962 }
3963
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003964
Richard Smithcd35eff2018-09-15 01:21:16 +00003965 ActionList Inputs = A->getInputs();
Daniel Dunbarc4343942010-02-03 03:07:56 +00003966
3967 const JobAction *JA = cast<JobAction>(A);
Samuel Antaod06239d2016-07-15 23:13:27 +00003968 ActionList CollapsedOffloadActions;
3969
Mehdi Amini6683e222017-01-24 18:12:25 +00003970 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
3971 embedBitcodeInObject() && !isUsingLTO());
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003972 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
3973
Rafael Espindola79764462013-03-24 15:06:53 +00003974 if (!T)
Justin Lebar9eaa4892016-01-11 23:09:32 +00003975 return InputInfo();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003976
Samuel Antaod06239d2016-07-15 23:13:27 +00003977 // If we've collapsed action list that contained OffloadAction we
3978 // need to build jobs for host/device-side inputs it may have held.
3979 for (const auto *OA : CollapsedOffloadActions)
3980 cast<OffloadAction>(OA)->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003981 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003982 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3983 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
Artem Belevichbee2f412016-08-22 18:50:34 +00003984 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
Samuel Antaod06239d2016-07-15 23:13:27 +00003985 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003986 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003987 });
Artem Belevichf8144ab2015-08-27 18:10:41 +00003988
Daniel Dunbare75d8342009-03-16 06:56:51 +00003989 // Only use pipes when there is exactly one input.
Daniel Dunbar1a093d22009-03-18 06:00:36 +00003990 InputInfoList InputInfos;
Richard Smithcd35eff2018-09-15 01:21:16 +00003991 for (const Action *Input : Inputs) {
Eric Christopher14668dd2013-02-18 00:38:25 +00003992 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
3993 // shouldn't get temporary output names.
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003994 // FIXME: Clean this up.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003995 bool SubJobAtTopLevel =
3996 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
Samuel Antaod06239d2016-07-15 23:13:27 +00003997 InputInfos.push_back(BuildJobsForAction(
3998 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003999 CachedResults, A->getOffloadingDeviceKind()));
Daniel Dunbare75d8342009-03-16 06:56:51 +00004000 }
4001
Daniel Dunbare75d8342009-03-16 06:56:51 +00004002 // Always use the first input as the base input.
4003 const char *BaseInput = InputInfos[0].getBaseInput();
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004004
Daniel Dunbar6beaf512010-06-04 18:28:41 +00004005 // ... except dsymutil actions, which use their actual input as the base
4006 // input.
4007 if (JA->getType() == types::TY_dSYM)
4008 BaseInput = InputInfos[0].getFilename();
4009
Richard Smithcd35eff2018-09-15 01:21:16 +00004010 // ... and in header module compilations, which use the module name.
4011 if (auto *ModuleJA = dyn_cast<HeaderModulePrecompileJobAction>(JA))
4012 BaseInput = ModuleJA->getModuleName();
4013
Samuel Antaod06239d2016-07-15 23:13:27 +00004014 // Append outputs of offload device jobs to the input list
4015 if (!OffloadDependencesInputInfo.empty())
4016 InputInfos.append(OffloadDependencesInputInfo.begin(),
4017 OffloadDependencesInputInfo.end());
Artem Belevich0ff05cd2015-07-13 23:27:56 +00004018
Vedant Kumar18286cf2016-07-27 23:02:20 +00004019 // Set the effective triple of the toolchain for the duration of this job.
4020 llvm::Triple EffectiveTriple;
4021 const ToolChain &ToolTC = T->getToolChain();
Samuel Antao31fef982016-10-27 17:39:44 +00004022 const ArgList &Args =
4023 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
Vedant Kumar18286cf2016-07-27 23:02:20 +00004024 if (InputInfos.size() != 1) {
4025 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
4026 } else {
4027 // Pass along the input type if it can be unambiguously determined.
4028 EffectiveTriple = llvm::Triple(
4029 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
4030 }
4031 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
4032
Daniel Dunbard00272f2010-08-02 02:38:15 +00004033 // Determine the place to write output to, if any.
Justin Lebar9eaa4892016-01-11 23:09:32 +00004034 InputInfo Result;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004035 InputInfoList UnbundlingResults;
4036 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
4037 // If we have an unbundling job, we need to create results for all the
4038 // outputs. We also update the results cache so that other actions using
4039 // this unbundling action can get the right results.
4040 for (auto &UI : UA->getDependentActionsInfo()) {
4041 assert(UI.DependentOffloadKind != Action::OFK_None &&
4042 "Unbundling with no offloading??");
4043
4044 // Unbundling actions are never at the top level. When we generate the
4045 // offloading prefix, we also do that for the host file because the
4046 // unbundling action does not change the type of the output which can
4047 // cause a overwrite.
4048 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4049 UI.DependentOffloadKind,
4050 UI.DependentToolChain->getTriple().normalize(),
4051 /*CreatePrefixForHost=*/true);
4052 auto CurI = InputInfo(
Yaxun Liu609f7522018-05-11 19:02:18 +00004053 UA,
4054 GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
4055 /*AtTopLevel=*/false,
4056 MultipleArchs ||
4057 UI.DependentOffloadKind == Action::OFK_HIP,
4058 OffloadingPrefix),
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004059 BaseInput);
4060 // Save the unbundling result.
4061 UnbundlingResults.push_back(CurI);
4062
4063 // Get the unique string identifier for this dependence and cache the
4064 // result.
Yaxun Liu470b8332018-06-06 19:44:10 +00004065 StringRef Arch;
4066 if (TargetDeviceOffloadKind == Action::OFK_HIP) {
4067 if (UI.DependentOffloadKind == Action::OFK_Host)
Yaxun Liuf37b50a2018-07-24 01:03:44 +00004068 Arch = StringRef();
Yaxun Liu470b8332018-06-06 19:44:10 +00004069 else
4070 Arch = UI.DependentBoundArch;
4071 } else
4072 Arch = BoundArch;
4073
4074 CachedResults[{A, GetTriplePlusArchString(UI.DependentToolChain, Arch,
4075 UI.DependentOffloadKind)}] =
4076 CurI;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004077 }
4078
4079 // Now that we have all the results generated, select the one that should be
4080 // returned for the current depending action.
4081 std::pair<const Action *, std::string> ActionTC = {
4082 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
4083 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
4084 "Result does not exist??");
4085 Result = CachedResults[ActionTC];
4086 } else if (JA->getType() == types::TY_Nothing)
Justin Lebard98cea82016-01-11 23:15:21 +00004087 Result = InputInfo(A, BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004088 else {
4089 // We only have to generate a prefix for the host if this is not a top-level
4090 // action.
4091 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
4092 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
4093 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
4094 !AtTopLevel);
Justin Lebard98cea82016-01-11 23:15:21 +00004095 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
Samuel Antaod06239d2016-07-15 23:13:27 +00004096 AtTopLevel, MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004097 OffloadingPrefix),
Justin Lebard98cea82016-01-11 23:15:21 +00004098 BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004099 }
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004100
Chad Rosierbe10f982011-08-02 17:58:04 +00004101 if (CCCPrintBindings && !CCGenDiagnostics) {
Rafael Espindola79764462013-03-24 15:06:53 +00004102 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
4103 << " - \"" << T->getName() << "\", inputs: [";
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004104 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
4105 llvm::errs() << InputInfos[i].getAsString();
4106 if (i + 1 != e)
4107 llvm::errs() << ", ";
4108 }
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004109 if (UnbundlingResults.empty())
4110 llvm::errs() << "], output: " << Result.getAsString() << "\n";
4111 else {
4112 llvm::errs() << "], outputs: [";
4113 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
4114 llvm::errs() << UnbundlingResults[i].getAsString();
4115 if (i + 1 != e)
4116 llvm::errs() << ", ";
4117 }
4118 llvm::errs() << "] \n";
4119 }
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004120 } else {
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004121 if (UnbundlingResults.empty())
4122 T->ConstructJob(
4123 C, *JA, Result, InputInfos,
4124 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4125 LinkingOutput);
4126 else
Samuel Antao7108bf32016-11-03 15:41:50 +00004127 T->ConstructJobMultipleOutputs(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004128 C, *JA, UnbundlingResults, InputInfos,
4129 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
4130 LinkingOutput);
Daniel Dunbarb39cc522009-03-17 22:47:06 +00004131 }
Justin Lebar9eaa4892016-01-11 23:09:32 +00004132 return Result;
Daniel Dunbare75d8342009-03-16 06:56:51 +00004133}
4134
Hans Wennborga7707222015-01-09 17:38:53 +00004135const char *Driver::getDefaultImageName() const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004136 llvm::Triple Target(llvm::Triple::normalize(TargetTriple));
Hans Wennborga7707222015-01-09 17:38:53 +00004137 return Target.isOSWindows() ? "a.exe" : "a.out";
4138}
4139
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004140/// Create output filename based on ArgValue, which could either be a
Hans Wennborg2c21f742013-10-17 16:16:23 +00004141/// full filename, filename without extension, or a directory. If ArgValue
4142/// does not provide a filename, then use BaseName, and use the extension
4143/// suitable for FileType.
Hans Wennborg207fcf02013-08-12 21:56:42 +00004144static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004145 StringRef BaseName,
4146 types::ID FileType) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004147 SmallString<128> Filename = ArgValue;
Justin Bogner5aaf2e72014-06-26 20:59:36 +00004148
Hans Wennborgf1a74252013-09-10 20:18:04 +00004149 if (ArgValue.empty()) {
4150 // If the argument is empty, output to BaseName in the current dir.
4151 Filename = BaseName;
4152 } else if (llvm::sys::path::is_separator(Filename.back())) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004153 // If the argument is a directory, output to BaseName in that dir.
4154 llvm::sys::path::append(Filename, BaseName);
4155 }
4156
4157 if (!llvm::sys::path::has_extension(ArgValue)) {
4158 // If the argument didn't provide an extension, then set it.
4159 const char *Extension = types::getTypeTempSuffix(FileType, true);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004160
4161 if (FileType == types::TY_Image &&
4162 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
4163 // The output file is a dll.
4164 Extension = "dll";
4165 }
4166
Hans Wennborg207fcf02013-08-12 21:56:42 +00004167 llvm::sys::path::replace_extension(Filename, Extension);
4168 }
4169
4170 return Args.MakeArgString(Filename.c_str());
4171}
4172
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004173const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004174 const char *BaseInput,
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004175 StringRef BoundArch, bool AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00004176 bool MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004177 StringRef OffloadingPrefix) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00004178 llvm::PrettyStackTraceString CrashInfo("Computing output path");
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004179 // Output to a user requested destination?
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004180 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004181 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
Chad Rosier633dcdc2013-01-24 19:14:47 +00004182 return C.addResultFile(FinalOutput->getValue(), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004183 }
4184
Hans Wennborge0053472013-12-20 18:40:46 +00004185 // For /P, preprocess to file named after BaseInput.
4186 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
4187 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
4188 StringRef BaseName = llvm::sys::path::filename(BaseInput);
Hans Wennborg04c764f2014-06-17 00:19:12 +00004189 StringRef NameArg;
Greg Bedwell065f70a2015-06-09 10:24:06 +00004190 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
Hans Wennborg04c764f2014-06-17 00:19:12 +00004191 NameArg = A->getValue();
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004192 return C.addResultFile(
4193 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
4194 &JA);
Hans Wennborge0053472013-12-20 18:40:46 +00004195 }
4196
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004197 // Default to writing to stdout?
David Blaikiebc023c92018-06-14 23:09:06 +00004198 if (AtTopLevel && !CCGenDiagnostics && isa<PreprocessJobAction>(JA))
Nick Lewycky6e1ce292010-09-24 00:46:53 +00004199 return "-";
4200
Hans Wennborg2c21f742013-10-17 16:16:23 +00004201 // Is this the assembly listing for /FA?
4202 if (JA.getType() == types::TY_PP_Asm &&
4203 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
4204 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
4205 // Use /Fa and the input filename to determine the asm file name.
4206 StringRef BaseName = llvm::sys::path::filename(BaseInput);
4207 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004208 return C.addResultFile(
4209 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
4210 &JA);
Hans Wennborg2c21f742013-10-17 16:16:23 +00004211 }
4212
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004213 // Output to a temporary file?
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004214 if ((!AtTopLevel && !isSaveTempsEnabled() &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004215 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
Chad Rosierbe10f982011-08-02 17:58:04 +00004216 CCGenDiagnostics) {
Chad Rosier97c37372011-08-26 22:27:02 +00004217 StringRef Name = llvm::sys::path::filename(BaseInput);
4218 std::pair<StringRef, StringRef> Split = Name.split('.');
Bob Haarman7e4d3ff2018-07-09 21:07:20 +00004219 SmallString<128> TmpName;
4220 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
4221 Arg *A = C.getArgs().getLastArg(options::OPT_fcrash_diagnostics_dir);
4222 if (CCGenDiagnostics && A) {
4223 SmallString<128> CrashDirectory(A->getValue());
4224 llvm::sys::path::append(CrashDirectory, Split.first);
4225 const char *Middle = Suffix ? "-%%%%%%." : "-%%%%%%";
4226 std::error_code EC =
4227 llvm::sys::fs::createUniqueFile(CrashDirectory + Middle + Suffix, TmpName);
4228 if (EC) {
4229 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
4230 return "";
4231 }
4232 } else {
4233 TmpName = GetTemporaryPath(Split.first, Suffix);
4234 }
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004235 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004236 }
4237
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004238 SmallString<128> BasePath(BaseInput);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004239 StringRef BaseName;
Daniel Dunbar67fea712011-03-25 18:16:51 +00004240
4241 // Dsymutil actions should use the full path.
Eric Christopher551ef452011-08-23 17:56:55 +00004242 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
Daniel Dunbar67fea712011-03-25 18:16:51 +00004243 BaseName = BasePath;
4244 else
4245 BaseName = llvm::sys::path::filename(BasePath);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004246
4247 // Determine what the derived output name should be.
4248 const char *NamedOutput;
Hans Wennborg2b89a262013-08-06 22:11:28 +00004249
Hans Wennborg625fba82016-10-04 21:01:04 +00004250 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004251 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
4252 // The /Fo or /o flag decides the object filename.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004253 StringRef Val =
4254 C.getArgs()
4255 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
4256 ->getValue();
4257 NamedOutput =
4258 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
Hans Wennborg207fcf02013-08-12 21:56:42 +00004259 } else if (JA.getType() == types::TY_Image &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004260 C.getArgs().hasArg(options::OPT__SLASH_Fe,
4261 options::OPT__SLASH_o)) {
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00004262 // The /Fe or /o flag names the linked file.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004263 StringRef Val =
4264 C.getArgs()
4265 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
4266 ->getValue();
4267 NamedOutput =
4268 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
Hans Wennborgf1a74252013-09-10 20:18:04 +00004269 } else if (JA.getType() == types::TY_Image) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00004270 if (IsCLMode()) {
4271 // clang-cl uses BaseName for the executable name.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004272 NamedOutput =
4273 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
Samuel Antao59efaed2016-10-27 17:31:22 +00004274 } else {
Hans Wennborga7707222015-01-09 17:38:53 +00004275 SmallString<128> Output(getDefaultImageName());
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004276 Output += OffloadingPrefix;
Samuel Antao59efaed2016-10-27 17:31:22 +00004277 if (MultipleArchs && !BoundArch.empty()) {
4278 Output += "-";
4279 Output.append(BoundArch);
4280 }
Chad Rosier35767232013-04-30 22:01:21 +00004281 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
Nico Weber2ca4be92016-03-01 23:16:44 +00004282 }
4283 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004284 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004285 } else {
Hans Wennborg0a096a02013-09-05 17:05:56 +00004286 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004287 assert(Suffix && "All types used for output should have a suffix.");
4288
4289 std::string::size_type End = std::string::npos;
4290 if (!types::appendSuffixForType(JA.getType()))
4291 End = BaseName.rfind('.');
Chad Rosier35767232013-04-30 22:01:21 +00004292 SmallString<128> Suffixed(BaseName.substr(0, End));
Samuel Antao3b7e38b2016-10-27 18:14:55 +00004293 Suffixed += OffloadingPrefix;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00004294 if (MultipleArchs && !BoundArch.empty()) {
Chad Rosier35767232013-04-30 22:01:21 +00004295 Suffixed += "-";
4296 Suffixed.append(BoundArch);
4297 }
Bob Wilson23a55f12014-12-21 07:00:00 +00004298 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
4299 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
4300 // optimized bitcode output.
4301 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
4302 JA.getType() == types::TY_LLVM_BC)
4303 Suffixed += ".tmp";
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004304 Suffixed += '.';
4305 Suffixed += Suffix;
4306 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
4307 }
4308
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004309 // Prepend object file path if -save-temps=obj
4310 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
4311 JA.getType() != types::TY_PCH) {
4312 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
4313 SmallString<128> TempPath(FinalOutput->getValue());
4314 llvm::sys::path::remove_filename(TempPath);
4315 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
4316 llvm::sys::path::append(TempPath, OutputFileName);
4317 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
4318 }
4319
Chad Rosier62135492012-07-09 17:31:28 +00004320 // If we're saving temps and the temp file conflicts with the input file,
Chad Rosier5b58af02012-04-20 20:05:08 +00004321 // then avoid overwriting input file.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00004322 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
Chad Rosier5b58af02012-04-20 20:05:08 +00004323 bool SameFile = false;
4324 SmallString<256> Result;
4325 llvm::sys::fs::current_path(Result);
4326 llvm::sys::path::append(Result, BaseName);
4327 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
4328 // Must share the same path to conflict.
4329 if (SameFile) {
4330 StringRef Name = llvm::sys::path::filename(BaseInput);
4331 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004332 std::string TmpName = GetTemporaryPath(
4333 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00004334 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Chad Rosier5b58af02012-04-20 20:05:08 +00004335 }
Chad Rosierf8412cd2011-07-15 21:54:29 +00004336 }
4337
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004338 // As an annoying special case, PCH generation doesn't strip the pathname.
Nico Weber8ab92192016-03-02 23:29:29 +00004339 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
Michael J. Spencere1696752010-12-18 00:19:12 +00004340 llvm::sys::path::remove_filename(BasePath);
4341 if (BasePath.empty())
Daniel Dunbare6c83192009-03-18 09:58:30 +00004342 BasePath = NamedOutput;
4343 else
Michael J. Spencere1696752010-12-18 00:19:12 +00004344 llvm::sys::path::append(BasePath, NamedOutput);
Chad Rosier633dcdc2013-01-24 19:14:47 +00004345 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004346 } else {
Chad Rosier633dcdc2013-01-24 19:14:47 +00004347 return C.addResultFile(NamedOutput, &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00004348 }
4349}
4350
Mehdi Amini12011172016-10-06 05:11:48 +00004351std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
Petr Hosek8f2499f2018-09-12 03:26:10 +00004352 // Seach for Name in a list of paths.
4353 auto SearchPaths = [&](const llvm::SmallVectorImpl<std::string> &P)
4354 -> llvm::Optional<std::string> {
4355 // Respect a limited subset of the '-Bprefix' functionality in GCC by
4356 // attempting to use this prefix when looking for file paths.
4357 for (const auto &Dir : P) {
4358 if (Dir.empty())
4359 continue;
4360 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
4361 llvm::sys::path::append(P, Name);
4362 if (llvm::sys::fs::exists(Twine(P)))
Simon Pilgrim4588fc82018-09-13 10:10:18 +00004363 return P.str().str();
Petr Hosek8f2499f2018-09-12 03:26:10 +00004364 }
4365 return None;
4366 };
4367
4368 if (auto P = SearchPaths(PrefixDirs))
4369 return *P;
Chandler Carruth84559242010-03-22 01:52:07 +00004370
Petr Hosek916a4672017-08-10 04:16:38 +00004371 SmallString<128> R(ResourceDir);
4372 llvm::sys::path::append(R, Name);
4373 if (llvm::sys::fs::exists(Twine(R)))
4374 return R.str();
4375
4376 SmallString<128> P(TC.getCompilerRTPath());
Rafael Espindola609a6642013-06-24 18:33:43 +00004377 llvm::sys::path::append(P, Name);
4378 if (llvm::sys::fs::exists(Twine(P)))
Peter Collingbournefa9771f2011-09-06 02:08:31 +00004379 return P.str();
4380
Petr Hosek8f2499f2018-09-12 03:26:10 +00004381 if (auto P = SearchPaths(TC.getLibraryPaths()))
4382 return *P;
4383
4384 if (auto P = SearchPaths(TC.getFilePaths()))
4385 return *P;
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004386
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004387 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004388}
4389
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004390void Driver::generatePrefixedToolNames(
Mehdi Amini12011172016-10-06 05:11:48 +00004391 StringRef Tool, const ToolChain &TC,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00004392 SmallVectorImpl<std::string> &Names) const {
Petr Hosekdd38d932018-05-29 22:35:39 +00004393 // FIXME: Needs a better variable than TargetTriple
4394 Names.emplace_back((TargetTriple + "-" + Tool).str());
Benjamin Kramer3204b152015-05-29 19:42:19 +00004395 Names.emplace_back(Tool);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004396
4397 // Allow the discovery of tools prefixed with LLVM's default target triple.
Petr Hosekdd38d932018-05-29 22:35:39 +00004398 std::string DefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
4399 if (DefaultTargetTriple != TargetTriple)
4400 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004401}
4402
Benjamin Kramer7111b912014-11-04 20:26:01 +00004403static bool ScanDirForExecutable(SmallString<128> &Dir,
4404 ArrayRef<std::string> Names) {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004405 for (const auto &Name : Names) {
4406 llvm::sys::path::append(Dir, Name);
4407 if (llvm::sys::fs::can_execute(Twine(Dir)))
4408 return true;
4409 llvm::sys::path::remove_filename(Dir);
4410 }
4411 return false;
4412}
4413
Mehdi Amini12011172016-10-06 05:11:48 +00004414std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004415 SmallVector<std::string, 2> TargetSpecificExecutables;
4416 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
4417
Chandler Carruth84559242010-03-22 01:52:07 +00004418 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00004419 // attempting to use this prefix when looking for program paths.
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004420 for (const auto &PrefixDir : PrefixDirs) {
4421 if (llvm::sys::fs::is_directory(PrefixDir)) {
4422 SmallString<128> P(PrefixDir);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004423 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004424 return P.str();
Simon Atanasyana47ba292012-10-31 14:39:28 +00004425 } else {
Mehdi Amini12011172016-10-06 05:11:48 +00004426 SmallString<128> P((PrefixDir + Name).str());
Rafael Espindola609a6642013-06-24 18:33:43 +00004427 if (llvm::sys::fs::can_execute(Twine(P)))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004428 return P.str();
Simon Atanasyan86bdab72012-10-31 12:01:53 +00004429 }
Chandler Carruth84559242010-03-22 01:52:07 +00004430 }
4431
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004432 const ToolChain::path_list &List = TC.getProgramPaths();
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00004433 for (const auto &Path : List) {
4434 SmallString<128> P(Path);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00004435 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00004436 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00004437 }
4438
Daniel Dunbar76ce7412009-03-23 16:15:50 +00004439 // If all else failed, search the path.
Michael J. Spencerb011d482014-11-07 21:30:32 +00004440 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
4441 if (llvm::ErrorOr<std::string> P =
4442 llvm::sys::findProgramByName(TargetSpecificExecutable))
Michael J. Spencer04162ea2014-11-04 01:30:55 +00004443 return *P;
Daniel Dunbar6f668772009-03-18 21:34:08 +00004444
Daniel Dunbar1ce81532009-09-09 22:33:00 +00004445 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00004446}
4447
Mehdi Amini12011172016-10-06 05:11:48 +00004448std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
Rafael Espindola37d229d2013-06-25 04:26:55 +00004449 SmallString<128> Path;
Rafael Espindolac0809172014-06-12 14:02:15 +00004450 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
Rafael Espindola37d229d2013-06-25 04:26:55 +00004451 if (EC) {
4452 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004453 return "";
4454 }
4455
Rafael Espindola37d229d2013-06-25 04:26:55 +00004456 return Path.str();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00004457}
4458
Nico Weber2ca4be92016-03-01 23:16:44 +00004459std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
4460 SmallString<128> Output;
4461 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
4462 // FIXME: If anybody needs it, implement this obscure rule:
4463 // "If you specify a directory without a file name, the default file name
4464 // is VCx0.pch., where x is the major version of Visual C++ in use."
4465 Output = FpArg->getValue();
4466
4467 // "If you do not specify an extension as part of the path name, an
4468 // extension of .pch is assumed. "
4469 if (!llvm::sys::path::has_extension(Output))
4470 Output += ".pch";
4471 } else {
Mike Rice58df1af2018-09-11 17:10:44 +00004472 if (Arg *YcArg = C.getArgs().getLastArg(options::OPT__SLASH_Yc))
4473 Output = YcArg->getValue();
4474 if (Output.empty())
4475 Output = BaseName;
Nico Weber2ca4be92016-03-01 23:16:44 +00004476 llvm::sys::path::replace_extension(Output, ".pch");
4477 }
4478 return Output.str();
4479}
4480
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004481const ToolChain &Driver::getToolChain(const ArgList &Args,
Artem Belevich959e0542015-07-10 19:47:55 +00004482 const llvm::Triple &Target) const {
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004483
David Blaikie6ad71012017-01-13 18:53:43 +00004484 auto &TC = ToolChains[Target.str()];
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004485 if (!TC) {
4486 switch (Target.getOS()) {
Reid Kleckner330fb172016-05-11 16:19:05 +00004487 case llvm::Triple::Haiku:
David Blaikie6ad71012017-01-13 18:53:43 +00004488 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
Reid Kleckner330fb172016-05-11 16:19:05 +00004489 break;
Ed Schouten4dabea22017-06-25 08:29:09 +00004490 case llvm::Triple::Ananas:
4491 TC = llvm::make_unique<toolchains::Ananas>(*this, Target, Args);
4492 break;
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004493 case llvm::Triple::CloudABI:
David Blaikie6ad71012017-01-13 18:53:43 +00004494 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
Ed Schouten3c3e58c2015-03-26 11:13:44 +00004495 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004496 case llvm::Triple::Darwin:
4497 case llvm::Triple::MacOSX:
4498 case llvm::Triple::IOS:
Tim Northover6f3ff222015-10-30 16:30:27 +00004499 case llvm::Triple::TvOS:
4500 case llvm::Triple::WatchOS:
David Blaikie6ad71012017-01-13 18:53:43 +00004501 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004502 break;
4503 case llvm::Triple::DragonFly:
David Blaikie6ad71012017-01-13 18:53:43 +00004504 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004505 break;
4506 case llvm::Triple::OpenBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004507 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004508 break;
4509 case llvm::Triple::NetBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004510 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004511 break;
4512 case llvm::Triple::FreeBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00004513 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004514 break;
4515 case llvm::Triple::Minix:
David Blaikie6ad71012017-01-13 18:53:43 +00004516 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004517 break;
4518 case llvm::Triple::Linux:
Andrey Turetskiy4798eb62016-06-16 10:36:09 +00004519 case llvm::Triple::ELFIAMCU:
Chandler Carruthcf705b22012-01-25 21:03:58 +00004520 if (Target.getArch() == llvm::Triple::hexagon)
David Blaikie6ad71012017-01-13 18:53:43 +00004521 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4522 Args);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00004523 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
4524 !Target.hasEnvironment())
David Blaikie6ad71012017-01-13 18:53:43 +00004525 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
4526 Args);
Chandler Carruthcf705b22012-01-25 21:03:58 +00004527 else
David Blaikie6ad71012017-01-13 18:53:43 +00004528 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004529 break;
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004530 case llvm::Triple::NaCl:
David Blaikie6ad71012017-01-13 18:53:43 +00004531 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
Derek Schuff6ab52fa2015-03-30 20:31:33 +00004532 break;
Petr Hosek62e1d232016-10-06 06:08:09 +00004533 case llvm::Triple::Fuchsia:
David Blaikie6ad71012017-01-13 18:53:43 +00004534 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
Petr Hosek62e1d232016-10-06 06:08:09 +00004535 break;
David Chisnallf571cde2012-02-15 13:39:01 +00004536 case llvm::Triple::Solaris:
David Blaikie6ad71012017-01-13 18:53:43 +00004537 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
David Chisnallf571cde2012-02-15 13:39:01 +00004538 break;
Tom Stellard8fa33092015-07-18 01:49:05 +00004539 case llvm::Triple::AMDHSA:
David Blaikie6ad71012017-01-13 18:53:43 +00004540 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
Tom Stellard8fa33092015-07-18 01:49:05 +00004541 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004542 case llvm::Triple::Win32:
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004543 switch (Target.getEnvironment()) {
4544 default:
4545 if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004546 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004547 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004548 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004549 else
David Blaikie6ad71012017-01-13 18:53:43 +00004550 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004551 break;
4552 case llvm::Triple::GNU:
David Blaikie6ad71012017-01-13 18:53:43 +00004553 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004554 break;
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004555 case llvm::Triple::Itanium:
David Blaikie6ad71012017-01-13 18:53:43 +00004556 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
4557 Args);
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00004558 break;
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004559 case llvm::Triple::MSVC:
4560 case llvm::Triple::UnknownEnvironment:
Dave Leef96bedf2017-11-06 21:18:05 +00004561 if (Args.getLastArgValue(options::OPT_fuse_ld_EQ)
4562 .startswith_lower("bfd"))
4563 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(
4564 *this, Target, Args);
4565 else
4566 TC =
4567 llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00004568 break;
4569 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004570 break;
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004571 case llvm::Triple::PS4:
David Blaikie6ad71012017-01-13 18:53:43 +00004572 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00004573 break;
David L Kreitzerd397ea42016-10-14 20:44:33 +00004574 case llvm::Triple::Contiki:
David Blaikie6ad71012017-01-13 18:53:43 +00004575 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
David L Kreitzerd397ea42016-10-14 20:44:33 +00004576 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004577 default:
Douglas Katzman9f5e70e2015-05-26 18:01:33 +00004578 // Of these targets, Hexagon is the only one that might have
4579 // an OS of Linux, in which case it got handled above already.
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004580 switch (Target.getArch()) {
4581 case llvm::Triple::tce:
David Blaikie6ad71012017-01-13 18:53:43 +00004582 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004583 break;
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004584 case llvm::Triple::tcele:
David Blaikie6ad71012017-01-13 18:53:43 +00004585 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00004586 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004587 case llvm::Triple::hexagon:
David Blaikie6ad71012017-01-13 18:53:43 +00004588 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
4589 Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004590 break;
Jacques Pienaard964cc22016-03-28 21:02:54 +00004591 case llvm::Triple::lanai:
David Blaikie6ad71012017-01-13 18:53:43 +00004592 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
Jacques Pienaard964cc22016-03-28 21:02:54 +00004593 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004594 case llvm::Triple::xcore:
David Blaikie6ad71012017-01-13 18:53:43 +00004595 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004596 break;
Dan Gohmanc2853072015-09-03 22:51:53 +00004597 case llvm::Triple::wasm32:
4598 case llvm::Triple::wasm64:
David Blaikie6ad71012017-01-13 18:53:43 +00004599 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
Dan Gohmanc2853072015-09-03 22:51:53 +00004600 break;
Dylan McKay924fa3a2017-01-05 05:20:27 +00004601 case llvm::Triple::avr:
David Blaikie6ad71012017-01-13 18:53:43 +00004602 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
Dylan McKay924fa3a2017-01-05 05:20:27 +00004603 break;
David Bolvanskyf4be2532018-07-31 14:21:46 +00004604 case llvm::Triple::riscv32:
4605 case llvm::Triple::riscv64:
4606 TC = llvm::make_unique<toolchains::RISCVToolChain>(*this, Target, Args);
4607 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004608 default:
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004609 if (Target.getVendor() == llvm::Triple::Myriad)
David Blaikie6ad71012017-01-13 18:53:43 +00004610 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
4611 Args);
Jonathan Roelofs901c7762017-05-25 15:42:13 +00004612 else if (toolchains::BareMetal::handlesTarget(Target))
4613 TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
Douglas Katzmand6e597c2015-09-17 19:56:40 +00004614 else if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00004615 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004616 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00004617 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004618 else
David Blaikie6ad71012017-01-13 18:53:43 +00004619 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00004620 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004621 }
4622 }
Justin Lebar66c4fd72016-11-18 00:41:22 +00004623
4624 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
4625 // compiles always need two toolchains, the CUDA toolchain and the host
4626 // toolchain. So the only valid way to create a CUDA toolchain is via
4627 // CreateOffloadingDeviceToolChains.
4628
Chandler Carruth2ad5de12012-01-25 11:01:57 +00004629 return *TC;
Daniel Dunbar4dff6a42009-03-10 23:41:59 +00004630}
Daniel Dunbar8fa879d2009-03-24 18:57:02 +00004631
Rafael Espindola2f69d402013-03-18 15:33:26 +00004632bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
Douglas Katzman00249092015-06-12 15:45:21 +00004633 // Say "no" if there is not exactly one input of a type clang understands.
Nico Weber5a459f82016-02-23 19:30:43 +00004634 if (JA.size() != 1 ||
4635 !types::isAcceptedByClang((*JA.input_begin())->getType()))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004636 return false;
4637
Douglas Katzman00249092015-06-12 15:45:21 +00004638 // And say "no" if this is not a kind of action clang understands.
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004639 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
Bob Wilson23a55f12014-12-21 07:00:00 +00004640 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00004641 return false;
4642
4643 return true;
4644}
4645
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004646/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
4647/// grouped values as integers. Numbers which are not provided are set to 0.
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004648///
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004649/// \return True if the entire string was parsed (9.2), or all groups were
4650/// parsed (10.3.5extrastuff).
Mehdi Amini12011172016-10-06 05:11:48 +00004651bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
4652 unsigned &Micro, bool &HadExtra) {
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004653 HadExtra = false;
4654
4655 Major = Minor = Micro = 0;
Mehdi Amini12011172016-10-06 05:11:48 +00004656 if (Str.empty())
Bob Wilson433cb312015-04-07 01:03:35 +00004657 return false;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004658
Mehdi Amini12011172016-10-06 05:11:48 +00004659 if (Str.consumeInteger(10, Major))
4660 return false;
4661 if (Str.empty())
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004662 return true;
Mehdi Amini12011172016-10-06 05:11:48 +00004663 if (Str[0] != '.')
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004664 return false;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00004665
Mehdi Amini12011172016-10-06 05:11:48 +00004666 Str = Str.drop_front(1);
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004667
Mehdi Amini12011172016-10-06 05:11:48 +00004668 if (Str.consumeInteger(10, Minor))
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004669 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004670 if (Str.empty())
4671 return true;
4672 if (Str[0] != '.')
4673 return false;
4674 Str = Str.drop_front(1);
4675
4676 if (Str.consumeInteger(10, Micro))
4677 return false;
4678 if (!Str.empty())
4679 HadExtra = true;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00004680 return true;
4681}
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004682
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004683/// Parse digits from a string \p Str and fulfill \p Digits with
4684/// the parsed numbers. This method assumes that the max number of
4685/// digits to look for is equal to Digits.size().
4686///
4687/// \return True if the entire string was parsed and there are
4688/// no extra characters remaining at the end.
Mehdi Amini12011172016-10-06 05:11:48 +00004689bool Driver::GetReleaseVersion(StringRef Str,
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004690 MutableArrayRef<unsigned> Digits) {
Mehdi Amini12011172016-10-06 05:11:48 +00004691 if (Str.empty())
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004692 return false;
4693
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004694 unsigned CurDigit = 0;
4695 while (CurDigit < Digits.size()) {
Mehdi Amini12011172016-10-06 05:11:48 +00004696 unsigned Digit;
4697 if (Str.consumeInteger(10, Digit))
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004698 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00004699 Digits[CurDigit] = Digit;
4700 if (Str.empty())
4701 return true;
4702 if (Str[0] != '.')
4703 return false;
4704 Str = Str.drop_front(1);
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00004705 CurDigit++;
4706 }
4707
4708 // More digits than requested, bail out...
4709 return false;
4710}
4711
Hans Wennborg797004d2018-11-08 11:27:04 +00004712std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks(bool IsClCompatMode) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004713 unsigned IncludedFlagsBitmask = 0;
Rafael Espindolacc707bc2013-09-25 15:54:41 +00004714 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004715
Hans Wennborg797004d2018-11-08 11:27:04 +00004716 if (IsClCompatMode) {
Hans Wennborg19076102013-07-31 20:51:53 +00004717 // Include CL and Core options.
4718 IncludedFlagsBitmask |= options::CLOption;
4719 IncludedFlagsBitmask |= options::CoreOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00004720 } else {
4721 ExcludedFlagsBitmask |= options::CLOption;
4722 }
4723
4724 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
4725}
Benjamin Kramerab88f622014-03-25 18:02:07 +00004726
Douglas Katzmanf08fadf2015-06-04 14:40:44 +00004727bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
Benjamin Kramerab88f622014-03-25 18:02:07 +00004728 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
4729}