blob: 78e99d43ddb0807d11d67cda70fc624ba3bd8123 [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"
12#include "ToolChains.h"
13#include "clang/Basic/Version.h"
Benjamin Kramerd45b2052015-10-07 15:48:01 +000014#include "clang/Basic/VirtualFileSystem.h"
Alp Toker1d257e12014-06-04 03:28:55 +000015#include "clang/Config/config.h"
Daniel Dunbar1688f1a2009-03-12 07:58:46 +000016#include "clang/Driver/Action.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000017#include "clang/Driver/Compilation.h"
Daniel Dunbarc0b3e952009-03-12 08:55:43 +000018#include "clang/Driver/DriverDiagnostic.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000019#include "clang/Driver/Job.h"
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000020#include "clang/Driver/Options.h"
Peter Collingbournea4ccff32015-02-20 20:30:56 +000021#include "clang/Driver/SanitizerArgs.h"
Daniel Dunbare75d8342009-03-16 06:56:51 +000022#include "clang/Driver/Tool.h"
23#include "clang/Driver/ToolChain.h"
Chris Lattnerce6c42f2011-03-23 04:04:01 +000024#include "llvm/ADT/ArrayRef.h"
Hans Wennborg6ddc6902013-07-27 00:23:45 +000025#include "llvm/ADT/STLExtras.h"
Justin Lebar62907612016-07-06 21:21:39 +000026#include "llvm/ADT/SmallSet.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000027#include "llvm/ADT/StringExtras.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "llvm/ADT/StringSet.h"
Hans Wennborg70850d82013-07-18 20:29:38 +000029#include "llvm/ADT/StringSwitch.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000030#include "llvm/Option/Arg.h"
31#include "llvm/Option/ArgList.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000032#include "llvm/Option/OptSpecifier.h"
Reid Kleckner898229a2013-06-14 17:17:23 +000033#include "llvm/Option/OptTable.h"
34#include "llvm/Option/Option.h"
David Blaikie79000202011-09-23 05:57:42 +000035#include "llvm/Support/ErrorHandling.h"
Michael J. Spencerf28df4c2010-12-17 21:22:22 +000036#include "llvm/Support/FileSystem.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000037#include "llvm/Support/Path.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/Support/PrettyStackTrace.h"
Hans Wennborg23d26a32014-06-18 17:21:50 +000039#include "llvm/Support/Process.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000040#include "llvm/Support/Program.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000041#include "llvm/Support/raw_ostream.h"
Dylan Noblesmith4f4e7452012-02-02 00:40:14 +000042#include <map>
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000043#include <memory>
Benjamin Kramercfeacf52016-05-27 14:27:13 +000044#include <utility>
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +000045#if LLVM_ON_UNIX
46#include <unistd.h> // getpid
47#endif
Dylan Noblesmith86780e92012-02-01 14:25:28 +000048
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000049using namespace clang::driver;
Chris Lattnerada1c912009-03-26 05:56:24 +000050using namespace clang;
Reid Kleckner898229a2013-06-14 17:17:23 +000051using namespace llvm::opt;
Daniel Dunbarb2cd66b2009-03-04 20:49:20 +000052
Reid Kleckner68eb60b2015-02-02 22:41:48 +000053Driver::Driver(StringRef ClangExecutable, StringRef DefaultTargetTriple,
Benjamin Kramerd45b2052015-10-07 15:48:01 +000054 DiagnosticsEngine &Diags,
55 IntrusiveRefCntPtr<vfs::FileSystem> VFS)
Benjamin Kramercfeacf52016-05-27 14:27:13 +000056 : Opts(createDriverOptTable()), Diags(Diags), VFS(std::move(VFS)),
57 Mode(GCCMode), SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
58 LTOMode(LTOK_None), ClangExecutable(ClangExecutable),
Reid Kleckner68eb60b2015-02-02 22:41:48 +000059 SysRoot(DEFAULT_SYSROOT), UseStdLib(true),
Reid Kleckner68eb60b2015-02-02 22:41:48 +000060 DriverTitle("clang LLVM compiler"), CCPrintOptionsFilename(nullptr),
61 CCPrintHeadersFilename(nullptr), CCLogDiagnosticsFilename(nullptr),
62 CCCPrintBindings(false), CCPrintHeaders(false), CCLogDiagnostics(false),
Vedant Kumarf2030b92016-07-18 19:56:33 +000063 CCGenDiagnostics(false), DefaultTargetTriple(DefaultTargetTriple),
64 CCCGenericGCCName(""), CheckInputsExist(true), CCCUsePCH(true),
65 SuppressMissingInputWarning(false) {
Daniel Dunbar3f3e2cd2010-01-20 02:35:16 +000066
Benjamin Kramerd45b2052015-10-07 15:48:01 +000067 // Provide a sane fallback if no VFS is specified.
68 if (!this->VFS)
69 this->VFS = vfs::getRealFileSystem();
70
Sumanth Gundapaneni3a1592942015-03-03 20:43:12 +000071 Name = llvm::sys::path::filename(ClangExecutable);
Douglas Katzmana67e50c2015-06-26 15:47:46 +000072 Dir = llvm::sys::path::parent_path(ClangExecutable);
Benjamin Kramerf420dda2015-10-13 15:19:32 +000073 InstalledDir = Dir; // Provide a sensible default installed dir.
Bob Wilsona20a1da2013-03-23 05:17:59 +000074
75 // Compute the path to the resource directory.
76 StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
77 SmallString<128> P(Dir);
Chandler Carruthfd3cc702014-12-29 12:09:08 +000078 if (ClangResourceDir != "") {
Bob Wilsona20a1da2013-03-23 05:17:59 +000079 llvm::sys::path::append(P, ClangResourceDir);
Chandler Carruthfd3cc702014-12-29 12:09:08 +000080 } else {
81 StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX);
Argyrios Kyrtzidisbcae0472017-02-25 18:14:35 +000082 P = llvm::sys::path::parent_path(Dir);
83 llvm::sys::path::append(P, Twine("lib") + ClangLibdirSuffix, "clang",
Chandler Carruthfd3cc702014-12-29 12:09:08 +000084 CLANG_VERSION_STRING);
85 }
Bob Wilsona20a1da2013-03-23 05:17:59 +000086 ResourceDir = P.str();
Daniel Dunbar544ecd12009-03-02 19:59:07 +000087}
88
Zachary Turneraff19c32016-08-12 17:47:52 +000089void Driver::ParseDriverMode(StringRef ProgramName,
90 ArrayRef<const char *> Args) {
91 auto Default = ToolChain::getTargetAndModeFromProgramName(ProgramName);
92 StringRef DefaultMode(Default.second);
93 setDriverModeFromOption(DefaultMode);
Hans Wennborg70850d82013-07-18 20:29:38 +000094
Douglas Katzman6bbffc42015-06-25 18:51:37 +000095 for (const char *ArgPtr : Args) {
Reid Kleckneraf5fd6a2014-08-22 19:29:30 +000096 // Ingore nullptrs, they are response file's EOL markers
Douglas Katzman6bbffc42015-06-25 18:51:37 +000097 if (ArgPtr == nullptr)
Reid Kleckneraf5fd6a2014-08-22 19:29:30 +000098 continue;
Douglas Katzman6bbffc42015-06-25 18:51:37 +000099 const StringRef Arg = ArgPtr;
Zachary Turneraff19c32016-08-12 17:47:52 +0000100 setDriverModeFromOption(Arg);
Hans Wennborg70850d82013-07-18 20:29:38 +0000101 }
102}
103
Zachary Turneraff19c32016-08-12 17:47:52 +0000104void Driver::setDriverModeFromOption(StringRef Opt) {
105 const std::string OptName =
106 getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
107 if (!Opt.startswith(OptName))
108 return;
109 StringRef Value = Opt.drop_front(OptName.size());
110
111 const unsigned M = llvm::StringSwitch<unsigned>(Value)
112 .Case("gcc", GCCMode)
113 .Case("g++", GXXMode)
114 .Case("cpp", CPPMode)
115 .Case("cl", CLMode)
116 .Default(~0U);
117
118 if (M != ~0U)
119 Mode = static_cast<DriverMode>(M);
120 else
121 Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
122}
123
David Blaikie69a1d8c2015-06-22 22:07:27 +0000124InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000125 llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000126
127 unsigned IncludedFlagsBitmask;
128 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000129 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000130 getIncludeExcludeOptionFlagMasks();
Hans Wennborg6ddc6902013-07-27 00:23:45 +0000131
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000132 unsigned MissingArgIndex, MissingArgCount;
David Blaikie69a1d8c2015-06-22 22:07:27 +0000133 InputArgList Args =
David Blaikie6d492ad2015-06-21 06:32:36 +0000134 getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
135 IncludedFlagsBitmask, ExcludedFlagsBitmask);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000136
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000137 // Check for missing argument error.
138 if (MissingArgCount)
139 Diag(clang::diag::err_drv_missing_argument)
David Blaikie69a1d8c2015-06-22 22:07:27 +0000140 << Args.getArgString(MissingArgIndex) << MissingArgCount;
Daniel Dunbar65229332009-03-13 11:38:42 +0000141
Daniel Dunbar52ed5fe2009-11-19 06:35:06 +0000142 // Check for unsupported options.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000143 for (const Arg *A : Args) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +0000144 if (A->getOption().hasFlag(options::Unsupported)) {
David Blaikie69a1d8c2015-06-22 22:07:27 +0000145 Diag(clang::diag::err_drv_unsupported_opt) << A->getAsString(Args);
Daniel Dunbard8500f32009-03-22 23:26:43 +0000146 continue;
147 }
Chad Rosierce975d92012-02-22 17:55:22 +0000148
149 // Warn about -mcpu= without an argument.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000150 if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
David Blaikie69a1d8c2015-06-22 22:07:27 +0000151 Diag(clang::diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
Chad Rosierce975d92012-02-22 17:55:22 +0000152 }
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000153 }
154
David Blaikie69a1d8c2015-06-22 22:07:27 +0000155 for (const Arg *A : Args.filtered(options::OPT_UNKNOWN))
Ehsan Akhgarid8518332016-01-25 21:14:52 +0000156 Diags.Report(IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl :
157 diag::err_drv_unknown_argument)
158 << A->getAsString(Args);
Rafael Espindola8a2d4962013-09-23 23:55:25 +0000159
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000160 return Args;
161}
162
Chad Rosier7742b5d2011-07-27 23:36:45 +0000163// Determine which compilation mode we are in. We look for options which
164// affect the phase, starting with the earliest phases, and record which
165// option we used to determine the final phase.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000166phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
167 Arg **FinalPhaseArg) const {
Craig Topper92fc2df2014-05-17 16:56:41 +0000168 Arg *PhaseArg = nullptr;
Chad Rosier7742b5d2011-07-27 23:36:45 +0000169 phases::ID FinalPhase;
Eric Christopherf901e852011-08-17 22:59:59 +0000170
Hans Wennborge50cec32014-06-13 20:59:54 +0000171 // -{E,EP,P,M,MM} only run the preprocessor.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000172 if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
Hans Wennborge50cec32014-06-13 20:59:54 +0000173 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
Hans Wennborge0053472013-12-20 18:40:46 +0000174 (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
175 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000176 FinalPhase = phases::Preprocess;
Eric Christopherf901e852011-08-17 22:59:59 +0000177
Richard Smithdd4ad3d2016-08-30 19:06:26 +0000178 // --precompile only runs up to precompilation.
179 } else if ((PhaseArg = DAL.getLastArg(options::OPT__precompile))) {
180 FinalPhase = phases::Precompile;
181
Bob Wilson23a55f12014-12-21 07:00:00 +0000182 // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
Chad Rosier7742b5d2011-07-27 23:36:45 +0000183 } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +0000184 (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
Ben Langmuir2cb4a782014-02-05 22:21:15 +0000185 (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000186 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
Fariborz Jahanian73223bb2012-04-02 15:59:19 +0000187 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
Ted Kremenekf7639e12012-03-06 20:06:33 +0000188 (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
Chad Rosier7742b5d2011-07-27 23:36:45 +0000189 (PhaseArg = DAL.getLastArg(options::OPT__analyze,
Chad Rosier1aeb15a2012-03-06 23:14:35 +0000190 options::OPT__analyze_auto)) ||
Bob Wilson23a55f12014-12-21 07:00:00 +0000191 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000192 FinalPhase = phases::Compile;
193
Bob Wilson23a55f12014-12-21 07:00:00 +0000194 // -S only runs up to the backend.
195 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
196 FinalPhase = phases::Backend;
197
Artem Belevich4242f412015-07-28 21:01:21 +0000198 // -c compilation only runs up to the assembler.
199 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
Chad Rosier7742b5d2011-07-27 23:36:45 +0000200 FinalPhase = phases::Assemble;
201
202 // Otherwise do everything.
203 } else
204 FinalPhase = phases::Link;
205
206 if (FinalPhaseArg)
207 *FinalPhaseArg = PhaseArg;
208
209 return FinalPhase;
210}
211
David Blaikie0aaa7622017-01-13 17:34:15 +0000212static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
Hans Wennborged1d0722013-08-13 21:32:29 +0000213 StringRef Value) {
David Blaikie0aaa7622017-01-13 17:34:15 +0000214 Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
Hans Wennborged1d0722013-08-13 21:32:29 +0000215 Args.getBaseArgs().MakeIndex(Value), Value.data());
Hans Wennborg55362852014-05-02 22:55:30 +0000216 Args.AddSynthesizedArg(A);
Hans Wennborged1d0722013-08-13 21:32:29 +0000217 A->claim();
218 return A;
219}
220
Daniel Dunbar775d4062010-06-11 22:00:26 +0000221DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
222 DerivedArgList *DAL = new DerivedArgList(Args);
223
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000224 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
Nirav Daveb0bb6142015-11-24 16:07:21 +0000225 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000226 for (Arg *A : Args) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000227 // Unfortunately, we have to parse some forwarding options (-Xassembler,
228 // -Xlinker, -Xpreprocessor) because we either integrate their functionality
229 // (assembler and preprocessor), or bypass a previous driver ('collect2').
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000230
231 // Rewrite linker options, to replace --no-demangle with a custom internal
232 // option.
233 if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
234 A->getOption().matches(options::OPT_Xlinker)) &&
235 A->containsValue("--no-demangle")) {
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000236 // Add the rewritten no-demangle argument.
237 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
238
239 // Add the remaining values as Xlinker arguments.
Benjamin Kramer72e64312015-09-24 14:48:49 +0000240 for (StringRef Val : A->getValues())
Douglas Katzmana34b7bf2015-06-30 19:32:57 +0000241 if (Val != "--no-demangle")
242 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000243
244 continue;
245 }
246
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000247 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
248 // some build systems. We don't try to be complete here because we don't
249 // care to encourage this usage model.
250 if (A->getOption().matches(options::OPT_Wp_COMMA) &&
Richard Smithbd55daf2012-11-01 04:30:05 +0000251 (A->getValue(0) == StringRef("-MD") ||
252 A->getValue(0) == StringRef("-MMD"))) {
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000253 // Rewrite to -MD/-MMD along with -MF.
Richard Smithbd55daf2012-11-01 04:30:05 +0000254 if (A->getValue(0) == StringRef("-MD"))
Daniel Dunbar3648ba72010-06-15 20:30:18 +0000255 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
256 else
257 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
Michael J. Spencer70d85be2012-11-07 23:37:14 +0000258 if (A->getNumValues() == 2)
259 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
260 A->getValue(1));
Daniel Dunbar5a9d1832010-06-14 21:37:09 +0000261 continue;
262 }
263
Shantonu Senafeb03b2010-09-17 18:39:08 +0000264 // Rewrite reserved library names.
265 if (A->getOption().matches(options::OPT_l)) {
Richard Smithbd55daf2012-11-01 04:30:05 +0000266 StringRef Value = A->getValue();
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000267
Shantonu Senafeb03b2010-09-17 18:39:08 +0000268 // Rewrite unless -nostdlib is present.
Nirav Daveb0bb6142015-11-24 16:07:21 +0000269 if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000270 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000271 continue;
272 }
Shantonu Senafeb03b2010-09-17 18:39:08 +0000273
274 // Rewrite unconditionally.
275 if (Value == "cc_kext") {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000276 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
Shantonu Senafeb03b2010-09-17 18:39:08 +0000277 continue;
278 }
Daniel Dunbar2cc3f172010-09-17 00:45:02 +0000279 }
280
Hans Wennborged1d0722013-08-13 21:32:29 +0000281 // Pick up inputs via the -- option.
282 if (A->getOption().matches(options::OPT__DASH_DASH)) {
283 A->claim();
Benjamin Kramer72e64312015-09-24 14:48:49 +0000284 for (StringRef Val : A->getValues())
David Blaikie0aaa7622017-01-13 17:34:15 +0000285 DAL->append(MakeInputArg(*DAL, *Opts, Val));
Hans Wennborged1d0722013-08-13 21:32:29 +0000286 continue;
287 }
288
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000289 DAL->append(A);
Daniel Dunbarfb3d7472010-06-14 21:23:12 +0000290 }
Daniel Dunbar775d4062010-06-11 22:00:26 +0000291
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000292 // Enforce -static if -miamcu is present.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000293 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
294 DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000295
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000296// Add a default value of -mlinker-version=, if one was given and the user
297// didn't specify one.
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000298#if defined(HOST_LINK_VERSION)
Tim Northover018578c2015-06-12 19:21:35 +0000299 if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
300 strlen(HOST_LINK_VERSION) > 0) {
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000301 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
302 HOST_LINK_VERSION);
Daniel Dunbarb613ffc2010-08-17 22:32:45 +0000303 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
Daniel Dunbar628fcf42010-08-12 00:05:12 +0000304 }
305#endif
306
Daniel Dunbar775d4062010-06-11 22:00:26 +0000307 return DAL;
308}
309
Artem Belevich959e0542015-07-10 19:47:55 +0000310/// \brief Compute target triple from args.
311///
312/// This routine provides the logic to compute a target triple from various
313/// args passed to the driver and the default triple string.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000314static llvm::Triple computeTargetTriple(const Driver &D,
315 StringRef DefaultTargetTriple,
Artem Belevich959e0542015-07-10 19:47:55 +0000316 const ArgList &Args,
317 StringRef DarwinArchName = "") {
318 // FIXME: Already done in Compilation *Driver::BuildCompilation
319 if (const Arg *A = Args.getLastArg(options::OPT_target))
320 DefaultTargetTriple = A->getValue();
321
322 llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
323
324 // Handle Apple-specific options available here.
325 if (Target.isOSBinFormatMachO()) {
326 // If an explict Darwin arch name is given, that trumps all.
327 if (!DarwinArchName.empty()) {
328 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
329 return Target;
330 }
331
332 // Handle the Darwin '-arch' flag.
333 if (Arg *A = Args.getLastArg(options::OPT_arch)) {
334 StringRef ArchName = A->getValue();
335 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
336 }
337 }
338
339 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
340 // '-mbig-endian'/'-EB'.
341 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
342 options::OPT_mbig_endian)) {
343 if (A->getOption().matches(options::OPT_mlittle_endian)) {
344 llvm::Triple LE = Target.getLittleEndianArchVariant();
345 if (LE.getArch() != llvm::Triple::UnknownArch)
346 Target = std::move(LE);
347 } else {
348 llvm::Triple BE = Target.getBigEndianArchVariant();
349 if (BE.getArch() != llvm::Triple::UnknownArch)
350 Target = std::move(BE);
351 }
352 }
353
354 // Skip further flag support on OSes which don't support '-m32' or '-m64'.
Douglas Katzman15a63ed2015-08-12 18:36:12 +0000355 if (Target.getArch() == llvm::Triple::tce ||
356 Target.getOS() == llvm::Triple::Minix)
Artem Belevich959e0542015-07-10 19:47:55 +0000357 return Target;
358
359 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000360 Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
361 options::OPT_m32, options::OPT_m16);
362 if (A) {
Artem Belevich959e0542015-07-10 19:47:55 +0000363 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
364
365 if (A->getOption().matches(options::OPT_m64)) {
366 AT = Target.get64BitArchVariant().getArch();
367 if (Target.getEnvironment() == llvm::Triple::GNUX32)
368 Target.setEnvironment(llvm::Triple::GNU);
369 } else if (A->getOption().matches(options::OPT_mx32) &&
370 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
371 AT = llvm::Triple::x86_64;
372 Target.setEnvironment(llvm::Triple::GNUX32);
373 } else if (A->getOption().matches(options::OPT_m32)) {
374 AT = Target.get32BitArchVariant().getArch();
375 if (Target.getEnvironment() == llvm::Triple::GNUX32)
376 Target.setEnvironment(llvm::Triple::GNU);
377 } else if (A->getOption().matches(options::OPT_m16) &&
378 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
379 AT = llvm::Triple::x86;
380 Target.setEnvironment(llvm::Triple::CODE16);
381 }
382
383 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
384 Target.setArch(AT);
385 }
386
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000387 // Handle -miamcu flag.
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000388 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
389 if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
390 D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
391 << Target.str();
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000392
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000393 if (A && !A->getOption().matches(options::OPT_m32))
394 D.Diag(diag::err_drv_argument_not_allowed_with)
395 << "-miamcu" << A->getBaseArg().getAsString(Args);
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000396
Andrey Turetskiy5fea71c2016-06-29 10:57:17 +0000397 Target.setArch(llvm::Triple::x86);
398 Target.setArchName("i586");
399 Target.setEnvironment(llvm::Triple::UnknownEnvironment);
400 Target.setEnvironmentName("");
401 Target.setOS(llvm::Triple::ELFIAMCU);
402 Target.setVendor(llvm::Triple::UnknownVendor);
403 Target.setVendorName("intel");
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000404 }
405
Artem Belevich959e0542015-07-10 19:47:55 +0000406 return Target;
407}
408
Teresa Johnson945bc502015-10-15 20:35:53 +0000409// \brief Parse the LTO options and record the type of LTO compilation
410// based on which -f(no-)?lto(=.*)? option occurs last.
411void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
412 LTOMode = LTOK_None;
413 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
414 options::OPT_fno_lto, false))
415 return;
416
417 StringRef LTOName("full");
418
419 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
Teresa Johnson6ef80dc2015-11-02 18:03:12 +0000420 if (A)
421 LTOName = A->getValue();
Teresa Johnson945bc502015-10-15 20:35:53 +0000422
423 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
424 .Case("full", LTOK_Full)
425 .Case("thin", LTOK_Thin)
426 .Default(LTOK_Unknown);
427
428 if (LTOMode == LTOK_Unknown) {
429 assert(A);
430 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
431 << A->getValue();
432 }
433}
434
Samuel Antao39f9da22016-10-27 16:38:05 +0000435/// Compute the desired OpenMP runtime from the flags provided.
436Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
437 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
438
439 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
440 if (A)
441 RuntimeName = A->getValue();
442
443 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
444 .Case("libomp", OMPRT_OMP)
445 .Case("libgomp", OMPRT_GOMP)
446 .Case("libiomp5", OMPRT_IOMP5)
447 .Default(OMPRT_Unknown);
448
449 if (RT == OMPRT_Unknown) {
450 if (A)
451 Diag(diag::err_drv_unsupported_option_argument)
452 << A->getOption().getName() << A->getValue();
453 else
454 // FIXME: We could use a nicer diagnostic here.
455 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
456 }
457
458 return RT;
459}
460
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000461void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
462 InputList &Inputs) {
463
464 //
465 // CUDA
466 //
467 // We need to generate a CUDA toolchain if any of the inputs has a CUDA type.
468 if (llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
469 return types::isCuda(I.first);
470 })) {
Justin Lebar66c4fd72016-11-18 00:41:22 +0000471 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
472 const llvm::Triple &HostTriple = HostTC->getTriple();
473 llvm::Triple CudaTriple(HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda"
474 : "nvptx-nvidia-cuda");
475 // Use the CUDA and host triples as the key into the ToolChains map, because
476 // the device toolchain we create depends on both.
David Blaikie6ad71012017-01-13 18:53:43 +0000477 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
Justin Lebar66c4fd72016-11-18 00:41:22 +0000478 if (!CudaTC) {
David Blaikie6ad71012017-01-13 18:53:43 +0000479 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
480 *this, CudaTriple, *HostTC, C.getInputArgs());
Justin Lebar66c4fd72016-11-18 00:41:22 +0000481 }
David Blaikie6ad71012017-01-13 18:53:43 +0000482 C.addOffloadDeviceToolChain(CudaTC.get(), Action::OFK_Cuda);
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000483 }
484
485 //
Samuel Antao39f9da22016-10-27 16:38:05 +0000486 // OpenMP
487 //
488 // We need to generate an OpenMP toolchain if the user specified targets with
489 // the -fopenmp-targets option.
490 if (Arg *OpenMPTargets =
491 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
492 if (OpenMPTargets->getNumValues()) {
493 // We expect that -fopenmp-targets is always used in conjunction with the
494 // option -fopenmp specifying a valid runtime with offloading support,
495 // i.e. libomp or libiomp.
496 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
497 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
498 options::OPT_fno_openmp, false);
499 if (HasValidOpenMPRuntime) {
500 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
501 HasValidOpenMPRuntime =
502 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
503 }
504
505 if (HasValidOpenMPRuntime) {
506 llvm::StringMap<const char *> FoundNormalizedTriples;
507 for (const char *Val : OpenMPTargets->getValues()) {
508 llvm::Triple TT(Val);
509 std::string NormalizedName = TT.normalize();
510
511 // Make sure we don't have a duplicate triple.
512 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
513 if (Duplicate != FoundNormalizedTriples.end()) {
514 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
515 << Val << Duplicate->second;
516 continue;
517 }
518
519 // Store the current triple so that we can check for duplicates in the
520 // following iterations.
521 FoundNormalizedTriples[NormalizedName] = Val;
522
523 // If the specified target is invalid, emit a diagnostic.
524 if (TT.getArch() == llvm::Triple::UnknownArch)
525 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
526 else {
527 const ToolChain &TC = getToolChain(C.getInputArgs(), TT);
528 C.addOffloadDeviceToolChain(&TC, Action::OFK_OpenMP);
529 }
530 }
531 } else
532 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
533 } else
534 Diag(clang::diag::warn_drv_empty_joined_argument)
535 << OpenMPTargets->getAsString(C.getInputArgs());
536 }
537
538 //
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000539 // TODO: Add support for other offloading programming models here.
540 //
541
542 return;
543}
544
Chris Lattner54b16772011-07-23 17:14:25 +0000545Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
Daniel Dunbar2608c542009-03-18 01:38:48 +0000546 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
547
Eric Christopherf901e852011-08-17 22:59:59 +0000548 // FIXME: Handle environment options which affect driver behavior, somewhere
Bill Wendlingadbeb9f2012-03-12 21:24:57 +0000549 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
Chad Rosier82301162011-09-14 00:47:55 +0000550
David Majnemer85c25b42016-07-24 17:44:03 +0000551 if (Optional<std::string> CompilerPathValue =
552 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
553 StringRef CompilerPath = *CompilerPathValue;
Chad Rosier82301162011-09-14 00:47:55 +0000554 while (!CompilerPath.empty()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000555 std::pair<StringRef, StringRef> Split =
556 CompilerPath.split(llvm::sys::EnvPathSeparator);
Chad Rosier82301162011-09-14 00:47:55 +0000557 PrefixDirs.push_back(Split.first);
558 CompilerPath = Split.second;
559 }
560 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000561
Hans Wennborg70850d82013-07-18 20:29:38 +0000562 // We look for the driver mode option early, because the mode can affect
563 // how other options are parsed.
Zachary Turneraff19c32016-08-12 17:47:52 +0000564 ParseDriverMode(ClangExecutable, ArgList.slice(1));
Hans Wennborg70850d82013-07-18 20:29:38 +0000565
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +0000566 // FIXME: What are we going to do with -V and -b?
567
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000568 // FIXME: This stuff needs to go into the Compilation, not the driver.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000569 bool CCCPrintPhases;
Daniel Dunbard02cb1d2009-03-05 06:38:47 +0000570
David Blaikie69a1d8c2015-06-22 22:07:27 +0000571 InputArgList Args = ParseArgStrings(ArgList.slice(1));
Daniel Dunbaracd69572009-12-04 21:55:23 +0000572
Filipe Cabecinhas136f35e2015-07-18 06:35:24 +0000573 // Silence driver warnings if requested
574 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
575
Rafael Espindola59ae7992009-12-07 18:28:29 +0000576 // -no-canonical-prefixes is used very early in main.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000577 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
Rafael Espindola59ae7992009-12-07 18:28:29 +0000578
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000579 // Ignore -pipe.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000580 Args.ClaimAllArgs(options::OPT_pipe);
Daniel Dunbar926f81f2010-08-02 02:38:03 +0000581
Daniel Dunbaracd69572009-12-04 21:55:23 +0000582 // Extract -ccc args.
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000583 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +0000584 // FIXME: We need to figure out where this behavior should live. Most of it
585 // should be outside in the client; the parts that aren't should have proper
586 // options, either by introducing new ones or by overloading gcc ones like -V
587 // or -b.
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000588 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
David Blaikie69a1d8c2015-06-22 22:07:27 +0000589 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
590 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
Richard Smithbd55daf2012-11-01 04:30:05 +0000591 CCCGenericGCCName = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000592 CCCUsePCH =
593 Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
Joerg Sonnenberger17d75512012-02-22 19:15:16 +0000594 // FIXME: DefaultTargetTriple is used by the target-prefixed calls to as/ld
595 // and getToolChain is const.
Hans Wennborg2e274592013-08-13 23:38:57 +0000596 if (IsCLMode()) {
Hans Wennborg73609a02014-03-28 01:19:04 +0000597 // clang-cl targets MSVC-style Win32.
Hans Wennborg2e274592013-08-13 23:38:57 +0000598 llvm::Triple T(DefaultTargetTriple);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +0000599 T.setOS(llvm::Triple::Win32);
Hans Wennborg0f0e8d62015-09-18 17:11:50 +0000600 T.setVendor(llvm::Triple::PC);
Hans Wennborg9d9ce7a2014-03-28 20:49:28 +0000601 T.setEnvironment(llvm::Triple::MSVC);
Hans Wennborg2e274592013-08-13 23:38:57 +0000602 DefaultTargetTriple = T.str();
603 }
David Blaikie69a1d8c2015-06-22 22:07:27 +0000604 if (const Arg *A = Args.getLastArg(options::OPT_target))
Richard Smithbd55daf2012-11-01 04:30:05 +0000605 DefaultTargetTriple = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000606 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
Richard Smithbd55daf2012-11-01 04:30:05 +0000607 Dir = InstalledDir = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000608 for (const Arg *A : Args.filtered(options::OPT_B)) {
Benjamin Kramer1a648d12011-02-08 20:31:42 +0000609 A->claim();
Richard Smithbd55daf2012-11-01 04:30:05 +0000610 PrefixDirs.push_back(A->getValue(0));
Benjamin Kramer1a648d12011-02-08 20:31:42 +0000611 }
David Blaikie69a1d8c2015-06-22 22:07:27 +0000612 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
Richard Smithbd55daf2012-11-01 04:30:05 +0000613 SysRoot = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000614 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
Peter Collingbourne9d9e1fc2013-05-27 21:40:20 +0000615 DyldPrefix = A->getValue();
David Blaikie69a1d8c2015-06-22 22:07:27 +0000616 if (Args.hasArg(options::OPT_nostdlib))
Joerg Sonnenbergerbc923f32011-03-21 13:59:26 +0000617 UseStdLib = false;
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000618
David Blaikie69a1d8c2015-06-22 22:07:27 +0000619 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
Bob Wilsona20a1da2013-03-23 05:17:59 +0000620 ResourceDir = A->getValue();
Jim Grosbach061dabf2013-03-12 20:17:58 +0000621
David Blaikie69a1d8c2015-06-22 22:07:27 +0000622 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +0000623 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
624 .Case("cwd", SaveTempsCwd)
625 .Case("obj", SaveTempsObj)
626 .Default(SaveTempsCwd);
627 }
628
Steven Wu1257cd82016-05-18 17:04:52 +0000629 setLTOMode(Args);
630
Steven Wu844ab6a2016-11-16 06:06:44 +0000631 // Process -fembed-bitcode= flags.
632 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
633 StringRef Name = A->getValue();
634 unsigned Model = llvm::StringSwitch<unsigned>(Name)
635 .Case("off", EmbedNone)
636 .Case("all", EmbedBitcode)
637 .Case("bitcode", EmbedBitcode)
638 .Case("marker", EmbedMarker)
639 .Default(~0U);
640 if (Model == ~0U) {
641 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
642 << Name;
643 } else
644 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
Steven Wu574b0f22016-03-01 01:07:58 +0000645 }
646
David Blaikie69a1d8c2015-06-22 22:07:27 +0000647 std::unique_ptr<llvm::opt::InputArgList> UArgs =
648 llvm::make_unique<InputArgList>(std::move(Args));
649
Daniel Dunbar775d4062010-06-11 22:00:26 +0000650 // Perform the default argument translations.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000651 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
Daniel Dunbar775d4062010-06-11 22:00:26 +0000652
Chandler Carruthcb916192012-01-25 08:49:21 +0000653 // Owned by the host.
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +0000654 const ToolChain &TC = getToolChain(
655 *UArgs, computeTargetTriple(*this, DefaultTargetTriple, *UArgs));
Chandler Carruthcb916192012-01-25 08:49:21 +0000656
Daniel Dunbar3ce436d2009-03-16 06:42:30 +0000657 // The compilation takes ownership of Args.
David Blaikie69a1d8c2015-06-22 22:07:27 +0000658 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +0000659
Daniel Dunbarf0eddb82009-03-18 02:55:38 +0000660 if (!HandleImmediateArgs(*C))
661 return C;
662
Chad Rosierecdede82011-08-12 22:08:57 +0000663 // Construct the list of inputs.
664 InputList Inputs;
Hans Wennborged1d0722013-08-13 21:32:29 +0000665 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
Chad Rosierecdede82011-08-12 22:08:57 +0000666
Samuel Antaoc1ffba52016-06-13 18:10:57 +0000667 // Populate the tool chains for the offloading devices, if any.
668 CreateOffloadingDeviceToolChains(*C, Inputs);
Justin Lebar0e450a52016-03-30 23:30:25 +0000669
Chandler Carruth7f1417f2012-01-24 10:43:44 +0000670 // Construct the list of abstract actions to perform for this compilation. On
Tim Northover157d9112014-01-16 08:48:16 +0000671 // MachO targets this uses the driver-driver and universal actions.
672 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +0000673 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +0000674 else
Justin Lebar0f3474c2016-02-11 02:00:50 +0000675 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
Daniel Dunbarf0eddb82009-03-18 02:55:38 +0000676
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +0000677 if (CCCPrintPhases) {
Daniel Dunbareb843be2009-03-18 03:13:20 +0000678 PrintActions(*C);
Daniel Dunbarf0eddb82009-03-18 02:55:38 +0000679 return C;
680 }
681
682 BuildJobs(*C);
Daniel Dunbaradc91e62009-03-15 01:38:15 +0000683
684 return C;
Daniel Dunbaree66cf22009-03-10 20:52:46 +0000685}
686
Justin Bognered9cbe02015-07-09 06:58:31 +0000687static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
688 llvm::opt::ArgStringList ASL;
689 for (const auto *A : Args)
690 A->render(Args, ASL);
691
692 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
693 if (I != ASL.begin())
694 OS << ' ';
695 Command::printArg(OS, *I, true);
696 }
697 OS << '\n';
698}
699
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +0000700bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
701 SmallString<128> &CrashDiagDir) {
702 using namespace llvm::sys;
703 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
704 "Only knows about .crash files on Darwin");
705
706 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
707 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
708 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
709 path::home_directory(CrashDiagDir);
710 if (CrashDiagDir.startswith("/var/root"))
711 CrashDiagDir = "/";
712 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
713 int PID =
714#if LLVM_ON_UNIX
715 getpid();
716#else
717 0;
718#endif
719 std::error_code EC;
720 fs::file_status FileStatus;
721 TimePoint<> LastAccessTime;
722 SmallString<128> CrashFilePath;
723 // Lookup the .crash files and get the one generated by a subprocess spawned
724 // by this driver invocation.
725 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
726 File != FileEnd && !EC; File.increment(EC)) {
727 StringRef FileName = path::filename(File->path());
728 if (!FileName.startswith(Name))
729 continue;
730 if (fs::status(File->path(), FileStatus))
731 continue;
732 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
733 llvm::MemoryBuffer::getFile(File->path());
734 if (!CrashFile)
735 continue;
736 // The first line should start with "Process:", otherwise this isn't a real
737 // .crash file.
738 StringRef Data = CrashFile.get()->getBuffer();
739 if (!Data.startswith("Process:"))
740 continue;
741 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
742 size_t ParentProcPos = Data.find("Parent Process:");
743 if (ParentProcPos == StringRef::npos)
744 continue;
745 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
746 if (LineEnd == StringRef::npos)
747 continue;
748 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
749 int OpenBracket = -1, CloseBracket = -1;
750 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
751 if (ParentProcess[i] == '[')
752 OpenBracket = i;
753 if (ParentProcess[i] == ']')
754 CloseBracket = i;
755 }
756 // Extract the parent process PID from the .crash file and check whether
757 // it matches this driver invocation pid.
758 int CrashPID;
759 if (OpenBracket < 0 || CloseBracket < 0 ||
760 ParentProcess.slice(OpenBracket + 1, CloseBracket)
761 .getAsInteger(10, CrashPID) || CrashPID != PID) {
762 continue;
763 }
764
765 // Found a .crash file matching the driver pid. To avoid getting an older
766 // and misleading crash file, continue looking for the most recent.
767 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
768 // multiple crashes poiting to the same parent process. Since the driver
769 // does not collect pid information for the dispatched invocation there's
770 // currently no way to distinguish among them.
771 const auto FileAccessTime = FileStatus.getLastModificationTime();
772 if (FileAccessTime > LastAccessTime) {
773 CrashFilePath.assign(File->path());
774 LastAccessTime = FileAccessTime;
775 }
776 }
777
778 // If found, copy it over to the location of other reproducer files.
779 if (!CrashFilePath.empty()) {
780 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
781 if (EC)
782 return false;
783 return true;
784 }
785
786 return false;
787}
788
Eric Christopherf901e852011-08-17 22:59:59 +0000789// When clang crashes, produce diagnostic information including the fully
790// preprocessed source file(s). Request that the developer attach the
Chad Rosierbe10f982011-08-02 17:58:04 +0000791// diagnostic information to a bug report.
792void Driver::generateCompilationDiagnostics(Compilation &C,
Justin Bognere1a33d12014-10-20 21:02:05 +0000793 const Command &FailingCommand) {
Chad Rosier877c0a22012-02-22 00:30:39 +0000794 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
Chad Rosier62135492012-07-09 17:31:28 +0000795 return;
Chad Rosierbee5a1d2012-03-07 00:30:40 +0000796
Chad Rosierdbf46a12013-02-01 18:30:26 +0000797 // Don't try to generate diagnostics for link or dsymutil jobs.
Justin Bognere1a33d12014-10-20 21:02:05 +0000798 if (FailingCommand.getCreator().isLinkJob() ||
799 FailingCommand.getCreator().isDsymutilJob())
Chad Rosier877c0a22012-02-22 00:30:39 +0000800 return;
801
Chad Rosier8179f112012-06-19 17:51:34 +0000802 // Print the version of the compiler.
803 PrintVersion(C, llvm::errs());
804
Chad Rosierbe10f982011-08-02 17:58:04 +0000805 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000806 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
807 "crash backtrace, preprocessed source, and associated run script.";
Chad Rosierbe10f982011-08-02 17:58:04 +0000808
809 // Suppress driver output and emit preprocessor output to temp file.
Hans Wennborg70850d82013-07-18 20:29:38 +0000810 Mode = CPPMode;
Chad Rosierbe10f982011-08-02 17:58:04 +0000811 CCGenDiagnostics = true;
812
Chad Rosiercdb008d2011-11-02 21:29:05 +0000813 // Save the original job command(s).
Justin Bogner25645152014-10-21 17:24:44 +0000814 Command Cmd = FailingCommand;
Chad Rosiercdb008d2011-11-02 21:29:05 +0000815
Richard Smith5bb4cdf2012-12-20 02:22:15 +0000816 // Keep track of whether we produce any errors while trying to produce
817 // preprocessed sources.
818 DiagnosticErrorTrap Trap(Diags);
819
820 // Suppress tool output.
Chad Rosierbe10f982011-08-02 17:58:04 +0000821 C.initCompilationForDiagnostics();
Chad Rosierecdede82011-08-12 22:08:57 +0000822
823 // Construct the list of inputs.
824 InputList Inputs;
825 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +0000826
Chad Rosier4f81fc22011-08-12 23:30:05 +0000827 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
Chad Rosierd57133d2011-08-18 00:22:25 +0000828 bool IgnoreInput = false;
829
830 // Ignore input from stdin or any inputs that cannot be preprocessed.
Paul Robinsonf44157d2014-04-28 22:24:44 +0000831 // Check type first as not all linker inputs have a value.
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000832 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
Paul Robinsonf44157d2014-04-28 22:24:44 +0000833 IgnoreInput = true;
834 } else if (!strcmp(it->second->getValue(), "-")) {
Chad Rosierd57133d2011-08-18 00:22:25 +0000835 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000836 << "Error generating preprocessed source(s) - "
837 "ignoring input from stdin.";
Chad Rosierd57133d2011-08-18 00:22:25 +0000838 IgnoreInput = true;
Chad Rosierd57133d2011-08-18 00:22:25 +0000839 }
840
841 if (IgnoreInput) {
Chad Rosier4f81fc22011-08-12 23:30:05 +0000842 it = Inputs.erase(it);
843 ie = Inputs.end();
Chad Rosier6fdf38b2011-08-17 23:08:45 +0000844 } else {
Chad Rosier4f81fc22011-08-12 23:30:05 +0000845 ++it;
Chad Rosier6fdf38b2011-08-17 23:08:45 +0000846 }
Chad Rosier4f81fc22011-08-12 23:30:05 +0000847 }
Chad Rosierd57133d2011-08-18 00:22:25 +0000848
Chad Rosierc5103c32013-01-29 23:57:10 +0000849 if (Inputs.empty()) {
850 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000851 << "Error generating preprocessed source(s) - "
852 "no preprocessable inputs.";
Chad Rosierc5103c32013-01-29 23:57:10 +0000853 return;
854 }
855
Chad Rosiere75ef402011-09-06 23:52:36 +0000856 // Don't attempt to generate preprocessed files if multiple -arch options are
Chad Rosier636d2832012-02-13 18:16:28 +0000857 // used, unless they're all duplicates.
858 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +0000859 for (const Arg *A : C.getArgs()) {
Chad Rosiere75ef402011-09-06 23:52:36 +0000860 if (A->getOption().matches(options::OPT_arch)) {
Richard Smithbd55daf2012-11-01 04:30:05 +0000861 StringRef ArchName = A->getValue();
Chad Rosier636d2832012-02-13 18:16:28 +0000862 ArchNames.insert(ArchName);
Chad Rosiere75ef402011-09-06 23:52:36 +0000863 }
864 }
Chad Rosier636d2832012-02-13 18:16:28 +0000865 if (ArchNames.size() > 1) {
866 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000867 << "Error generating preprocessed source(s) - cannot generate "
868 "preprocessed source with multiple -arch options.";
Chad Rosier636d2832012-02-13 18:16:28 +0000869 return;
870 }
Chad Rosiere75ef402011-09-06 23:52:36 +0000871
Chandler Carruth7f1417f2012-01-24 10:43:44 +0000872 // Construct the list of abstract actions to perform for this compilation. On
873 // Darwin OSes this uses the driver-driver and builds universal actions.
Chandler Carruthcb916192012-01-25 08:49:21 +0000874 const ToolChain &TC = C.getDefaultToolChain();
Tim Northover157d9112014-01-16 08:48:16 +0000875 if (TC.getTriple().isOSBinFormatMachO())
Artem Belevich5e2a3ec2015-11-17 22:28:40 +0000876 BuildUniversalActions(C, TC, Inputs);
Chad Rosierbe10f982011-08-02 17:58:04 +0000877 else
Justin Lebar0f3474c2016-02-11 02:00:50 +0000878 BuildActions(C, C.getArgs(), Inputs, C.getActions());
Chad Rosierbe10f982011-08-02 17:58:04 +0000879
880 BuildJobs(C);
881
882 // If there were errors building the compilation, quit now.
Richard Smith5bb4cdf2012-12-20 02:22:15 +0000883 if (Trap.hasErrorOccurred()) {
Chad Rosierbe10f982011-08-02 17:58:04 +0000884 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000885 << "Error generating preprocessed source(s).";
Chad Rosierbe10f982011-08-02 17:58:04 +0000886 return;
887 }
888
889 // Generate preprocessed output.
Chad Rosierdd60e092013-01-29 20:15:05 +0000890 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
Justin Bogner0cd92482015-07-02 22:52:08 +0000891 C.ExecuteJobs(C.getJobs(), FailingCommands);
Chad Rosierbe10f982011-08-02 17:58:04 +0000892
Justin Bognerbc89b182014-10-20 21:20:27 +0000893 // If any of the preprocessing commands failed, clean up and exit.
894 if (!FailingCommands.empty()) {
Reid Kleckner68eb60b2015-02-02 22:41:48 +0000895 if (!isSaveTempsEnabled())
Chad Rosierbe10f982011-08-02 17:58:04 +0000896 C.CleanupFileList(C.getTempFiles(), true);
897
898 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000899 << "Error generating preprocessed source(s).";
Justin Bognerbc89b182014-10-20 21:20:27 +0000900 return;
Chad Rosierbe10f982011-08-02 17:58:04 +0000901 }
Justin Bognerbc89b182014-10-20 21:20:27 +0000902
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000903 const ArgStringList &TempFiles = C.getTempFiles();
904 if (TempFiles.empty()) {
905 Diag(clang::diag::note_drv_command_failed_diag_msg)
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000906 << "Error generating preprocessed source(s).";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000907 return;
908 }
909
Justin Bognerbc89b182014-10-20 21:20:27 +0000910 Diag(clang::diag::note_drv_command_failed_diag_msg)
911 << "\n********************\n\n"
912 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
913 "Preprocessed source(s) and associated run script(s) are located at:";
Justin Bognerbc89b182014-10-20 21:20:27 +0000914
Justin Bogner659ecc32014-10-20 22:47:23 +0000915 SmallString<128> VFS;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +0000916 SmallString<128> ReproCrashFilename;
Justin Bogner659ecc32014-10-20 22:47:23 +0000917 for (const char *TempFile : TempFiles) {
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000918 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +0000919 if (ReproCrashFilename.empty()) {
920 ReproCrashFilename = TempFile;
921 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
922 }
Justin Bogner659ecc32014-10-20 22:47:23 +0000923 if (StringRef(TempFile).endswith(".cache")) {
924 // In some cases (modules) we'll dump extra data to help with reproducing
925 // the crash into a directory next to the output.
926 VFS = llvm::sys::path::filename(TempFile);
927 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
928 }
929 }
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000930
931 // Assume associated files are based off of the first temporary file.
Justin Bogner25645152014-10-21 17:24:44 +0000932 CrashReportInfo CrashInfo(TempFiles[0], VFS);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000933
Justin Bogner25645152014-10-21 17:24:44 +0000934 std::string Script = CrashInfo.Filename.rsplit('.').first.str() + ".sh";
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000935 std::error_code EC;
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000936 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl);
937 if (EC) {
938 Diag(clang::diag::note_drv_command_failed_diag_msg)
939 << "Error generating run script: " + Script + " " + EC.message();
940 } else {
Justin Bogner42220ed2015-03-12 00:14:35 +0000941 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
Justin Bognered9cbe02015-07-09 06:58:31 +0000942 << "# Driver args: ";
943 printArgList(ScriptOS, C.getInputArgs());
944 ScriptOS << "# Original command: ";
Justin Bogner42220ed2015-03-12 00:14:35 +0000945 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
Justin Bogner33bdbc62014-10-21 18:03:08 +0000946 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
Justin Bognerc1fdf7f2014-10-20 21:47:56 +0000947 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
Justin Bognerbc89b182014-10-20 21:20:27 +0000948 }
Saleem Abdulrasool3661a822015-01-12 02:33:09 +0000949
Bruno Cardoso Lopes02681c42016-11-17 21:41:22 +0000950 // On darwin, provide information about the .crash diagnostic report.
951 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
952 SmallString<128> CrashDiagDir;
953 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
954 Diag(clang::diag::note_drv_command_failed_diag_msg)
955 << ReproCrashFilename.str();
956 } else { // Suggest a directory for the user to look for .crash files.
957 llvm::sys::path::append(CrashDiagDir, Name);
958 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
959 Diag(clang::diag::note_drv_command_failed_diag_msg)
960 << "Crash backtrace is located in";
961 Diag(clang::diag::note_drv_command_failed_diag_msg)
962 << CrashDiagDir.str();
963 Diag(clang::diag::note_drv_command_failed_diag_msg)
964 << "(choose the .crash file that corresponds to your crash)";
965 }
966 }
967
Saleem Abdulrasool3661a822015-01-12 02:33:09 +0000968 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
969 options::OPT_frewrite_map_file_EQ))
970 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
971
Justin Bognerbc89b182014-10-20 21:20:27 +0000972 Diag(clang::diag::note_drv_command_failed_diag_msg)
973 << "\n\n********************";
Chad Rosierbe10f982011-08-02 17:58:04 +0000974}
975
Justin Bogner0cd92482015-07-02 22:52:08 +0000976void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
Oleg Ranevskyycd516372016-01-05 19:54:39 +0000977 // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
Reid Kleckner0290c9c2014-09-15 17:45:39 +0000978 // if the tool does not support response files, there is a chance/ that things
979 // will just work without a response file, so we silently just skip it.
Justin Bogner0cd92482015-07-02 22:52:08 +0000980 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
Oleg Ranevskyycd516372016-01-05 19:54:39 +0000981 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
Reid Kleckner0290c9c2014-09-15 17:45:39 +0000982 return;
983
984 std::string TmpName = GetTemporaryPath("response", "txt");
Malcolm Parsonsf76f6502016-11-02 10:39:27 +0000985 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
Reid Kleckner0290c9c2014-09-15 17:45:39 +0000986}
987
Douglas Katzmana67e50c2015-06-26 15:47:46 +0000988int Driver::ExecuteCompilation(
989 Compilation &C,
990 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
Daniel Dunbar38bfda62009-07-01 20:03:04 +0000991 // Just print if -### was present.
992 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Hans Wennborgb212b342013-09-12 18:23:34 +0000993 C.getJobs().Print(llvm::errs(), "\n", true);
Daniel Dunbar38bfda62009-07-01 20:03:04 +0000994 return 0;
995 }
996
997 // If there were errors building the compilation, quit now.
Chad Rosierbe10f982011-08-02 17:58:04 +0000998 if (Diags.hasErrorOccurred())
Daniel Dunbar38bfda62009-07-01 20:03:04 +0000999 return 1;
1000
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001001 // Set up response file names for each command, if necessary
Justin Bogner0cd92482015-07-02 22:52:08 +00001002 for (auto &Job : C.getJobs())
1003 setUpResponseFiles(C, Job);
Reid Kleckner0290c9c2014-09-15 17:45:39 +00001004
Justin Bogner0cd92482015-07-02 22:52:08 +00001005 C.ExecuteJobs(C.getJobs(), FailingCommands);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001006
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001007 // Remove temp files.
1008 C.CleanupFileList(C.getTempFiles());
1009
Daniel Dunbar07494792010-05-22 00:37:20 +00001010 // If the command succeeded, we are done.
Chad Rosierdd60e092013-01-29 20:15:05 +00001011 if (FailingCommands.empty())
1012 return 0;
Daniel Dunbar07494792010-05-22 00:37:20 +00001013
Chad Rosierdd60e092013-01-29 20:15:05 +00001014 // Otherwise, remove result files and print extra information about abnormal
1015 // failures.
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001016 for (const auto &CmdPair : FailingCommands) {
1017 int Res = CmdPair.first;
1018 const Command *FailingCommand = CmdPair.second;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001019
Chad Rosierdd60e092013-01-29 20:15:05 +00001020 // Remove result files if we're not saving temps.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00001021 if (!isSaveTempsEnabled()) {
Chad Rosierdd60e092013-01-29 20:15:05 +00001022 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1023 C.CleanupFileMap(C.getResultFiles(), JA, true);
1024
1025 // Failure result files are valid unless we crashed.
1026 if (Res < 0)
1027 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1028 }
1029
1030 // Print extra information about abnormal failures, if possible.
1031 //
1032 // This is ad-hoc, but we don't want to be excessively noisy. If the result
Justin Bogner5aaf2e72014-06-26 20:59:36 +00001033 // status was 1, assume the command failed normally. In particular, if it
Chad Rosierdd60e092013-01-29 20:15:05 +00001034 // was the compiler then assume it gave a reasonable error code. Failures
1035 // in other tools are less common, and they generally have worse
1036 // diagnostics, so always print the diagnostic there.
1037 const Tool &FailingTool = FailingCommand->getCreator();
1038
1039 if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
1040 // FIXME: See FIXME above regarding result code interpretation.
1041 if (Res < 0)
1042 Diag(clang::diag::err_drv_command_signalled)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001043 << FailingTool.getShortName();
Chad Rosierdd60e092013-01-29 20:15:05 +00001044 else
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001045 Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
1046 << Res;
Chad Rosierdd60e092013-01-29 20:15:05 +00001047 }
Peter Collingbourne119cfaa2011-11-21 00:01:05 +00001048 }
Chad Rosierdd60e092013-01-29 20:15:05 +00001049 return 0;
Daniel Dunbar38bfda62009-07-01 20:03:04 +00001050}
1051
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001052void Driver::PrintHelp(bool ShowHidden) const {
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001053 unsigned IncludedFlagsBitmask;
1054 unsigned ExcludedFlagsBitmask;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001055 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001056 getIncludeExcludeOptionFlagMasks();
Hans Wennborg6ddc6902013-07-27 00:23:45 +00001057
1058 ExcludedFlagsBitmask |= options::NoDriverOption;
1059 if (!ShowHidden)
1060 ExcludedFlagsBitmask |= HelpHidden;
1061
1062 getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
1063 IncludedFlagsBitmask, ExcludedFlagsBitmask);
Daniel Dunbar7c925282009-03-31 21:38:17 +00001064}
1065
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001066void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001067 // FIXME: The following handlers should use a callback mechanism, we don't
1068 // know what the client would like to do.
Ted Kremenek4c0df3d2010-01-23 02:11:34 +00001069 OS << getClangFullVersion() << '\n';
Daniel Dunbarb10248802009-03-26 16:09:13 +00001070 const ToolChain &TC = C.getDefaultToolChain();
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001071 OS << "Target: " << TC.getTripleString() << '\n';
Daniel Dunbar10978e42009-06-16 23:32:58 +00001072
1073 // Print the threading model.
Jonathan Roelofsb140a102014-10-03 21:57:44 +00001074 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1075 // Don't print if the ToolChain would have barfed on it already
1076 if (TC.isThreadModelSupported(A->getValue()))
1077 OS << "Thread model: " << A->getValue();
1078 } else
1079 OS << "Thread model: " << TC.getThreadModel();
1080 OS << '\n';
Chandler Carruth9ade6a92015-08-05 17:07:33 +00001081
1082 // Print out the install directory.
1083 OS << "InstalledDir: " << InstalledDir << '\n';
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001084}
1085
Chris Lattner86ed5b02010-05-05 05:53:24 +00001086/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1087/// option.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001088static void PrintDiagnosticCategories(raw_ostream &OS) {
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001089 // Skip the empty category.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001090 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1091 ++i)
Argyrios Kyrtzidis0e37afa2011-05-25 05:05:01 +00001092 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
Chris Lattner86ed5b02010-05-05 05:53:24 +00001093}
1094
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001095bool Driver::HandleImmediateArgs(const Compilation &C) {
Daniel Dunbar18974bd2010-06-11 22:00:19 +00001096 // The order these options are handled in gcc is all over the place, but we
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001097 // don't expect inconsistencies w.r.t. that to matter in practice.
Daniel Dunbar7c925282009-03-31 21:38:17 +00001098
Daniel Dunbar1b09e042010-09-17 02:47:28 +00001099 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1100 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1101 return false;
1102 }
1103
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001104 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
Daniel Dunbare26e5002011-01-12 00:43:47 +00001105 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1106 // return an answer which matches our definition of __VERSION__.
1107 //
1108 // If we want to return a more correct answer some day, then we should
1109 // introduce a non-pedantically GCC compatible mode to Clang in which we
1110 // provide sensible definitions for -dumpversion, __VERSION__, etc.
1111 llvm::outs() << "4.2.1\n";
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001112 return false;
1113 }
Daniel Dunbarfb3d7472010-06-14 21:23:12 +00001114
Chris Lattner86ed5b02010-05-05 05:53:24 +00001115 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1116 PrintDiagnosticCategories(llvm::outs());
1117 return false;
1118 }
Daniel Dunbara9bbcfa2009-04-04 05:17:38 +00001119
James Molloya3c85b82012-05-01 14:57:16 +00001120 if (C.getArgs().hasArg(options::OPT_help) ||
Daniel Dunbara7b5e212009-04-15 16:34:29 +00001121 C.getArgs().hasArg(options::OPT__help_hidden)) {
1122 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
Daniel Dunbar7c925282009-03-31 21:38:17 +00001123 return false;
1124 }
1125
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001126 if (C.getArgs().hasArg(options::OPT__version)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001127 // Follow gcc behavior and use stdout for --version and stderr for -v.
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001128 PrintVersion(C, llvm::outs());
Daniel Dunbarb0006ae2009-04-02 15:05:41 +00001129 return false;
1130 }
1131
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001132 if (C.getArgs().hasArg(options::OPT_v) ||
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001133 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
Daniel Dunbar08e41d62009-07-21 20:06:58 +00001134 PrintVersion(C, llvm::errs());
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001135 SuppressMissingInputWarning = true;
1136 }
1137
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001138 const ToolChain &TC = C.getDefaultToolChain();
Chandler Carruth0ae39aa2013-07-30 17:57:09 +00001139
1140 if (C.getArgs().hasArg(options::OPT_v))
1141 TC.printVerboseInfo(llvm::errs());
1142
Daniel Dunbard972e222009-03-20 04:37:21 +00001143 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1144 llvm::outs() << "programs: =";
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001145 bool separator = false;
1146 for (const std::string &Path : TC.getProgramPaths()) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001147 if (separator)
1148 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001149 llvm::outs() << Path;
1150 separator = true;
Daniel Dunbard972e222009-03-20 04:37:21 +00001151 }
1152 llvm::outs() << "\n";
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001153 llvm::outs() << "libraries: =" << ResourceDir;
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001154
Sebastian Pop980920a2012-04-16 04:16:43 +00001155 StringRef sysroot = C.getSysRoot();
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001156
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001157 for (const std::string &Path : TC.getFilePaths()) {
1158 // Always print a separator. ResourceDir was the first item shown.
Peter Collingbournefa9771f2011-09-06 02:08:31 +00001159 llvm::outs() << ':';
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001160 // Interpretation of leading '=' is needed only for NetBSD.
1161 if (Path[0] == '=')
Douglas Katzman26eabf62015-06-24 15:10:30 +00001162 llvm::outs() << sysroot << Path.substr(1);
Joerg Sonnenberger9c3e69b2011-07-16 10:50:05 +00001163 else
Douglas Katzman51fe7bf2015-06-23 22:43:50 +00001164 llvm::outs() << Path;
Daniel Dunbard972e222009-03-20 04:37:21 +00001165 }
1166 llvm::outs() << "\n";
Daniel Dunbar7c925282009-03-31 21:38:17 +00001167 return false;
Daniel Dunbard972e222009-03-20 04:37:21 +00001168 }
1169
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001170 // FIXME: The following handlers should use a callback mechanism, we don't
1171 // know what the client would like to do.
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001172 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001173 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001174 return false;
1175 }
1176
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001177 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001178 llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n";
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001179 return false;
1180 }
1181
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00001182 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
Michal Gorny7cfe4802016-10-10 12:23:40 +00001183 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
1184 switch (RLT) {
1185 case ToolChain::RLT_CompilerRT:
1186 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1187 break;
1188 case ToolChain::RLT_Libgcc:
1189 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1190 break;
1191 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001192 return false;
1193 }
1194
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001195 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001196 for (const Multilib &Multilib : TC.getMultilibs())
1197 llvm::outs() << Multilib << "\n";
Daniel Dunbar1b3ec3a2009-06-16 23:25:22 +00001198 return false;
1199 }
1200
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001201 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
Douglas Katzmana34b7bf2015-06-30 19:32:57 +00001202 for (const Multilib &Multilib : TC.getMultilibs()) {
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001203 if (Multilib.gccSuffix().empty())
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001204 llvm::outs() << ".\n";
1205 else {
Douglas Katzman6bbffc42015-06-25 18:51:37 +00001206 StringRef Suffix(Multilib.gccSuffix());
Jonathan Roelofs2cea1be2014-02-12 03:21:20 +00001207 assert(Suffix.front() == '/');
1208 llvm::outs() << Suffix.substr(1) << "\n";
1209 }
Jonathan Roelofs3fa96d82014-02-12 01:36:51 +00001210 }
Jonathan Roelofs0e7ec602014-02-12 01:29:25 +00001211 return false;
1212 }
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00001213 return true;
1214}
1215
Douglas Katzmanfd528672015-06-11 15:05:22 +00001216// Display an action graph human-readably. Action A is the "sink" node
1217// and latest-occuring action. Traversal is in pre-order, visiting the
1218// inputs to each action before printing the action itself.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001219static unsigned PrintActions1(const Compilation &C, Action *A,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001220 std::map<Action *, unsigned> &Ids) {
Douglas Katzmanfd528672015-06-11 15:05:22 +00001221 if (Ids.count(A)) // A was already visited.
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001222 return Ids[A];
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001223
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001224 std::string str;
1225 llvm::raw_string_ostream os(str);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001226
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001227 os << Action::getClassName(A->getKind()) << ", ";
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001228 if (InputAction *IA = dyn_cast<InputAction>(A)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001229 os << "\"" << IA->getInputArg().getValue() << "\"";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001230 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001231 os << '"' << BIA->getArchName() << '"' << ", {"
Nico Weber5a459f82016-02-23 19:30:43 +00001232 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
Samuel Antaod06239d2016-07-15 23:13:27 +00001233 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1234 bool IsFirst = true;
1235 OA->doOnEachDependence(
1236 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1237 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1238 // sm_35 this will generate:
1239 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1240 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1241 if (!IsFirst)
1242 os << ", ";
1243 os << '"';
1244 if (TC)
1245 os << A->getOffloadingKindPrefix();
1246 else
1247 os << "host";
1248 os << " (";
1249 os << TC->getTriple().normalize();
1250
1251 if (BoundArch)
1252 os << ":" << BoundArch;
1253 os << ")";
1254 os << '"';
1255 os << " {" << PrintActions1(C, A, Ids) << "}";
1256 IsFirst = false;
1257 });
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001258 } else {
Samuel Antaod06239d2016-07-15 23:13:27 +00001259 const ActionList *AL = &A->getInputs();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00001260
Artem Belevich23256752015-09-22 17:23:09 +00001261 if (AL->size()) {
1262 const char *Prefix = "{";
1263 for (Action *PreRequisite : *AL) {
1264 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1265 Prefix = ", ";
1266 }
1267 os << "}";
1268 } else
1269 os << "{}";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001270 }
1271
Samuel Antaod06239d2016-07-15 23:13:27 +00001272 // Append offload info for all options other than the offloading action
1273 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1274 std::string offload_str;
1275 llvm::raw_string_ostream offload_os(offload_str);
1276 if (!isa<OffloadAction>(A)) {
1277 auto S = A->getOffloadingKindPrefix();
1278 if (!S.empty()) {
1279 offload_os << ", (" << S;
1280 if (A->getOffloadingArch())
1281 offload_os << ", " << A->getOffloadingArch();
1282 offload_os << ")";
1283 }
1284 }
1285
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001286 unsigned Id = Ids.size();
1287 Ids[A] = Id;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001288 llvm::errs() << Id << ": " << os.str() << ", "
Samuel Antaod06239d2016-07-15 23:13:27 +00001289 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
Daniel Dunbaraaf1ea62009-03-13 12:19:02 +00001290
1291 return Id;
1292}
1293
Douglas Katzmanfd528672015-06-11 15:05:22 +00001294// Print the action graphs in a compilation C.
1295// For example "clang -c file1.c file2.c" is composed of two subgraphs.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001296void Driver::PrintActions(const Compilation &C) const {
Douglas Katzmanb7e8ef02015-06-25 19:37:41 +00001297 std::map<Action *, unsigned> Ids;
1298 for (Action *A : C.getActions())
1299 PrintActions1(C, A, Ids);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001300}
1301
Joerg Sonnenberger5fe4a7d2011-05-06 14:05:11 +00001302/// \brief Check whether the given input tree contains any compilation or
1303/// assembly actions.
1304static bool ContainsCompileOrAssembleAction(const Action *A) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001305 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
Bob Wilson23a55f12014-12-21 07:00:00 +00001306 isa<AssembleJobAction>(A))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001307 return true;
1308
Nico Weber5a459f82016-02-23 19:30:43 +00001309 for (const Action *Input : A->inputs())
Nico Weberfb80f962015-09-19 21:36:51 +00001310 if (ContainsCompileOrAssembleAction(Input))
Daniel Dunbar00d3d8e2010-06-29 16:38:33 +00001311 return true;
1312
1313 return false;
1314}
1315
Artem Belevich5e2a3ec2015-11-17 22:28:40 +00001316void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1317 const InputList &BAInputs) const {
1318 DerivedArgList &Args = C.getArgs();
1319 ActionList &Actions = C.getActions();
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001320 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1321 // Collect the list of architectures. Duplicates are allowed, but should only
1322 // be handled once (in the order seen).
Daniel Dunbare5dc4822009-03-13 20:33:35 +00001323 llvm::StringSet<> ArchNames;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001324 SmallVector<const char *, 4> Archs;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001325 for (Arg *A : Args) {
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001326 if (A->getOption().matches(options::OPT_arch)) {
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001327 // Validate the option here; we don't save the type here because its
1328 // particular spelling may participate in other driver choices.
1329 llvm::Triple::ArchType Arch =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001330 tools::darwin::getArchTypeForMachOArchName(A->getValue());
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001331 if (Arch == llvm::Triple::UnknownArch) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001332 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
Daniel Dunbar9c3f7c42009-09-08 23:37:30 +00001333 continue;
1334 }
1335
Daniel Dunbar2da02722009-03-19 07:55:12 +00001336 A->claim();
David Blaikie61b86d42014-11-19 02:56:13 +00001337 if (ArchNames.insert(A->getValue()).second)
Richard Smithbd55daf2012-11-01 04:30:05 +00001338 Archs.push_back(A->getValue());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001339 }
1340 }
1341
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001342 // When there is no explicit arch for this platform, make sure we still bind
1343 // the architecture (to the default) so that -Xarch_ is handled correctly.
Daniel Dunbareb843be2009-03-18 03:13:20 +00001344 if (!Archs.size())
Daniel Dunbarc3bd9f52012-11-08 03:38:26 +00001345 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001346
Daniel Dunbarf479c122009-03-12 18:40:18 +00001347 ActionList SingleActions;
Justin Lebar0f3474c2016-02-11 02:00:50 +00001348 BuildActions(C, Args, BAInputs, SingleActions);
Daniel Dunbarf479c122009-03-12 18:40:18 +00001349
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001350 // Add in arch bindings for every top level action, as well as lipo and
1351 // dsymutil steps if needed.
Nico Weberfb80f962015-09-19 21:36:51 +00001352 for (Action* Act : SingleActions) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001353 // Make sure we can lipo this kind of output. If not (and it is an actual
1354 // output) then we disallow, since we can't create an output file with the
1355 // right name without overwriting it. We could remove this oddity by just
1356 // changing the output names to include the arch, which would also fix
Daniel Dunbarf479c122009-03-12 18:40:18 +00001357 // -save-temps. Compatibility wins for now.
1358
Daniel Dunbare2ca3bd2009-03-13 17:46:02 +00001359 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
Daniel Dunbarf479c122009-03-12 18:40:18 +00001360 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001361 << types::getTypeName(Act->getType());
Daniel Dunbarf479c122009-03-12 18:40:18 +00001362
1363 ActionList Inputs;
Justin Lebar41094612016-01-11 23:07:27 +00001364 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1365 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
Daniel Dunbarf479c122009-03-12 18:40:18 +00001366
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001367 // Lipo if necessary, we do it this way because we need to set the arch flag
1368 // so that -Xarch_ gets overwritten.
Daniel Dunbarf479c122009-03-12 18:40:18 +00001369 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1370 Actions.append(Inputs.begin(), Inputs.end());
1371 else
Justin Lebar41094612016-01-11 23:07:27 +00001372 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001373
Eric Christopher65c05fa2012-02-06 19:43:51 +00001374 // Handle debug info queries.
1375 Arg *A = Args.getLastArg(options::OPT_g_Group);
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001376 if (A && !A->getOption().matches(options::OPT_g0) &&
1377 !A->getOption().matches(options::OPT_gstabs) &&
1378 ContainsCompileOrAssembleAction(Actions.back())) {
Chad Rosier62135492012-07-09 17:31:28 +00001379
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001380 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1381 // have a compile input. We need to run 'dsymutil' ourselves in such cases
Eric Christopher776c26f2013-01-28 17:39:03 +00001382 // because the debug info will refer to a temporary object file which
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001383 // will be removed at the end of the compilation process.
1384 if (Act->getType() == types::TY_Image) {
1385 ActionList Inputs;
1386 Inputs.push_back(Actions.back());
1387 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001388 Actions.push_back(
1389 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
Daniel Dunbar6beaf512010-06-04 18:28:41 +00001390 }
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001391
Ben Langmuir9b9a8d32014-02-06 18:53:25 +00001392 // Verify the debug info output.
Alp Tokere9d2bfc2014-01-17 02:06:23 +00001393 if (Args.hasArg(options::OPT_verify_debug_info)) {
Justin Lebar41094612016-01-11 23:07:27 +00001394 Action* LastAction = Actions.back();
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001395 Actions.pop_back();
Justin Lebar41094612016-01-11 23:07:27 +00001396 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1397 LastAction, types::TY_Nothing));
David Blaikie6f9f4eb2012-04-15 21:22:10 +00001398 }
1399 }
Daniel Dunbarf479c122009-03-12 18:40:18 +00001400 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001401}
1402
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001403/// \brief Check that the file referenced by Value exists. If it doesn't,
1404/// issue a diagnostic and return false.
Alp Toker8c8a8752013-12-03 06:53:35 +00001405static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001406 StringRef Value, types::ID Ty) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001407 if (!D.getCheckInputsExist())
1408 return true;
1409
1410 // stdin always exists.
1411 if (Value == "-")
1412 return true;
1413
1414 SmallString<64> Path(Value);
1415 if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
Yaron Keren92e1b622015-03-18 10:17:07 +00001416 if (!llvm::sys::path::is_absolute(Path)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001417 SmallString<64> Directory(WorkDir->getValue());
1418 llvm::sys::path::append(Directory, Value);
1419 Path.assign(Directory);
1420 }
1421 }
1422
1423 if (llvm::sys::fs::exists(Twine(Path)))
1424 return true;
1425
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001426 if (D.IsCLMode()) {
1427 if (!llvm::sys::path::is_absolute(Twine(Path)) &&
1428 llvm::sys::Process::FindInEnvPath("LIB", Value))
1429 return true;
1430
1431 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
1432 // Arguments to the /link flag might cause the linker to search for object
1433 // and library files in paths we don't know about. Don't error in such
1434 // cases.
1435 return true;
1436 }
1437 }
Hans Wennborg23d26a32014-06-18 17:21:50 +00001438
Yaron Keren92e1b622015-03-18 10:17:07 +00001439 D.Diag(clang::diag::err_drv_no_such_file) << Path;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001440 return false;
1441}
1442
Chad Rosierecdede82011-08-12 22:08:57 +00001443// Construct a the list of inputs and their types.
Hans Wennborg55362852014-05-02 22:55:30 +00001444void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
Chad Rosierecdede82011-08-12 22:08:57 +00001445 InputList &Inputs) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001446 // Track the current user specified (-x) input. We also explicitly track the
1447 // argument used to set the type; we only want to claim the type when we
1448 // actually use it, so we warn about unused -x arguments.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001449 types::ID InputType = types::TY_Nothing;
Craig Topper92fc2df2014-05-17 16:56:41 +00001450 Arg *InputTypeArg = nullptr;
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001451
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001452 // The last /TC or /TP option sets the input type to C or C++ globally.
Ehsan Akhgaric249abb2014-09-12 21:44:24 +00001453 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1454 options::OPT__SLASH_TP)) {
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001455 InputTypeArg = TCTP;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001456 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001457 ? types::TY_C
1458 : types::TY_CXX;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001459
Richard Smith0aef3052017-02-18 01:14:43 +00001460 Arg *Previous = nullptr;
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001461 bool ShowNote = false;
Richard Smith0aef3052017-02-18 01:14:43 +00001462 for (Arg *A : Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
1463 if (Previous) {
1464 Diag(clang::diag::warn_drv_overriding_flag_option)
1465 << Previous->getSpelling() << A->getSpelling();
1466 ShowNote = true;
1467 }
1468 Previous = A;
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001469 }
Hans Wennborg0d0b19c2013-08-12 18:34:17 +00001470 if (ShowNote)
1471 Diag(clang::diag::note_drv_t_option_is_global);
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001472
1473 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1474 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1475 }
1476
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00001477 for (Arg *A : Args) {
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00001478 if (A->getOption().getKind() == Option::InputClass) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001479 const char *Value = A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001480 types::ID Ty = types::TY_INVALID;
1481
1482 // Infer the input type if necessary.
Daniel Dunbarc5a5ac52009-03-13 17:57:10 +00001483 if (InputType == types::TY_Nothing) {
1484 // If there was an explicit arg for this, claim it.
1485 if (InputTypeArg)
1486 InputTypeArg->claim();
1487
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001488 // stdin must be handled specially.
1489 if (memcmp(Value, "-", 2) == 0) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001490 // If running with -E, treat as a C input (this changes the builtin
1491 // macros, for example). This may be overridden by -ObjC below.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001492 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001493 // Otherwise emit an error but still use a valid type to avoid
1494 // spurious errors (e.g., no inputs).
Hans Wennborg70850d82013-07-18 20:29:38 +00001495 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
Hans Wennborgcfdd8b52014-01-29 01:04:40 +00001496 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1497 : clang::diag::err_drv_unknown_stdin_type);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001498 Ty = types::TY_C;
1499 } else {
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001500 // Otherwise lookup by extension.
1501 // Fallback is C if invoked as C preprocessor or Object otherwise.
1502 // We use a host hook here because Darwin at least has its own
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001503 // idea of what .s is.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001504 if (const char *Ext = strrchr(Value, '.'))
Daniel Dunbarcc7df6c2010-08-02 05:43:56 +00001505 Ty = TC.LookupTypeForExtension(Ext + 1);
Daniel Dunbarea9f0322009-03-20 23:39:23 +00001506
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001507 if (Ty == types::TY_INVALID) {
Hans Wennborg70850d82013-07-18 20:29:38 +00001508 if (CCCIsCPP())
Joerg Sonnenbergerbdbdf702011-03-16 22:45:02 +00001509 Ty = types::TY_C;
1510 else
1511 Ty = types::TY_Object;
1512 }
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001513
1514 // If the driver is invoked as C++ compiler (like clang++ or c++) it
1515 // should autodetect some input files as C++ for g++ compatibility.
Hans Wennborg70850d82013-07-18 20:29:38 +00001516 if (CCCIsCXX()) {
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001517 types::ID OldTy = Ty;
1518 Ty = types::lookupCXXTypeForCType(Ty);
1519
1520 if (Ty != OldTy)
1521 Diag(clang::diag::warn_drv_treating_input_as_cxx)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00001522 << getTypeName(OldTy) << getTypeName(Ty);
Daniel Dunbar0ac94452010-02-17 20:32:58 +00001523 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001524 }
1525
Daniel Dunbar82b22102009-05-18 21:47:54 +00001526 // -ObjC and -ObjC++ override the default language, but only for "source
1527 // files". We just treat everything that isn't a linker input as a
1528 // source file.
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001529 //
Daniel Dunbar82b22102009-05-18 21:47:54 +00001530 // FIXME: Clean this up if we move the phase sequence into the type.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001531 if (Ty != types::TY_Object) {
1532 if (Args.hasArg(options::OPT_ObjC))
1533 Ty = types::TY_ObjC;
1534 else if (Args.hasArg(options::OPT_ObjCXX))
1535 Ty = types::TY_ObjCXX;
1536 }
1537 } else {
1538 assert(InputTypeArg && "InputType set w/o InputTypeArg");
Ehsan Akhgari7e954ea2014-09-12 18:15:10 +00001539 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
1540 // If emulating cl.exe, make sure that /TC and /TP don't affect input
1541 // object files.
1542 const char *Ext = strrchr(Value, '.');
1543 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
1544 Ty = types::TY_Object;
1545 }
1546 if (Ty == types::TY_INVALID) {
1547 Ty = InputType;
1548 InputTypeArg->claim();
1549 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001550 }
1551
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001552 if (DiagnoseInputExistence(*this, Args, Value, Ty))
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001553 Inputs.push_back(std::make_pair(Ty, A));
1554
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001555 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
1556 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001557 if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00001558 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001559 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
1560 }
1561 A->claim();
1562 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
1563 StringRef Value = A->getValue();
Hans Wennborg12f4f8b2016-04-15 01:12:32 +00001564 if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) {
David Blaikie0aaa7622017-01-13 17:34:15 +00001565 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
Hans Wennborg6ee64d52013-08-06 00:20:31 +00001566 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
1567 }
1568 A->claim();
Michael J. Spencer66e2b202012-10-19 22:37:06 +00001569 } else if (A->getOption().hasFlag(options::LinkerInput)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001570 // Just treat as object type, we could make a special type for this if
1571 // necessary.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001572 Inputs.push_back(std::make_pair(types::TY_Object, A));
1573
Daniel Dunbar0bfb21e2009-11-19 03:26:40 +00001574 } else if (A->getOption().matches(options::OPT_x)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001575 InputTypeArg = A;
Richard Smithbd55daf2012-11-01 04:30:05 +00001576 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
Chad Rosier706c2352012-04-07 00:01:31 +00001577 A->claim();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001578
1579 // Follow gcc behavior and treat as linker input for invalid -x
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00001580 // options. Its not clear why we shouldn't just revert to unknown; but
Michael J. Spencer1a4fe8c2010-12-17 21:22:33 +00001581 // this isn't very important, we might as well be bug compatible.
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001582 if (!InputType) {
Richard Smithbd55daf2012-11-01 04:30:05 +00001583 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001584 InputType = types::TY_Object;
1585 }
Hans Wennborg091f1b62017-01-27 17:09:41 +00001586 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
1587 assert(A->getNumValues() == 1 && "The /U option has one value.");
1588 StringRef Val = A->getValue(0);
1589 if (Val.find_first_of("/\\") != StringRef::npos) {
1590 // Warn about e.g. "/Users/me/myfile.c".
1591 Diag(diag::warn_slash_u_filename) << Val;
1592 Diag(diag::note_use_dashdash);
1593 }
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00001594 }
1595 }
Hans Wennborg70850d82013-07-18 20:29:38 +00001596 if (CCCIsCPP() && Inputs.empty()) {
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00001597 // If called as standalone preprocessor, stdin is processed
1598 // if no other input is present.
David Blaikie0aaa7622017-01-13 17:34:15 +00001599 Arg *A = MakeInputArg(Args, *Opts, "-");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00001600 Inputs.push_back(std::make_pair(types::TY_C, A));
1601 }
Chad Rosierecdede82011-08-12 22:08:57 +00001602}
1603
Samuel Antao64e965e2016-09-30 15:34:19 +00001604namespace {
1605/// Provides a convenient interface for different programming models to generate
1606/// the required device actions.
1607class OffloadingActionBuilder final {
1608 /// Flag used to trace errors in the builder.
1609 bool IsValid = false;
1610
1611 /// The compilation that is using this builder.
1612 Compilation &C;
1613
Samuel Antao64e965e2016-09-30 15:34:19 +00001614 /// Map between an input argument and the offload kinds used to process it.
1615 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
1616
1617 /// Builder interface. It doesn't build anything or keep any state.
1618 class DeviceActionBuilder {
1619 public:
1620 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
1621
1622 enum ActionBuilderReturnCode {
1623 // The builder acted successfully on the current action.
1624 ABRT_Success,
1625 // The builder didn't have to act on the current action.
1626 ABRT_Inactive,
1627 // The builder was successful and requested the host action to not be
1628 // generated.
1629 ABRT_Ignore_Host,
1630 };
1631
1632 protected:
1633 /// Compilation associated with this builder.
1634 Compilation &C;
1635
1636 /// Tool chains associated with this builder. The same programming
1637 /// model may have associated one or more tool chains.
1638 SmallVector<const ToolChain *, 2> ToolChains;
1639
1640 /// The derived arguments associated with this builder.
1641 DerivedArgList &Args;
1642
1643 /// The inputs associated with this builder.
1644 const Driver::InputList &Inputs;
1645
1646 /// The associated offload kind.
1647 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
1648
1649 public:
1650 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
1651 const Driver::InputList &Inputs,
1652 Action::OffloadKind AssociatedOffloadKind)
1653 : C(C), Args(Args), Inputs(Inputs),
1654 AssociatedOffloadKind(AssociatedOffloadKind) {}
1655 virtual ~DeviceActionBuilder() {}
1656
1657 /// Fill up the array \a DA with all the device dependences that should be
1658 /// added to the provided host action \a HostAction. By default it is
1659 /// inactive.
1660 virtual ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00001661 getDeviceDependences(OffloadAction::DeviceDependences &DA,
1662 phases::ID CurPhase, phases::ID FinalPhase,
1663 PhasesTy &Phases) {
Samuel Antao64e965e2016-09-30 15:34:19 +00001664 return ABRT_Inactive;
1665 }
1666
1667 /// Update the state to include the provided host action \a HostAction as a
1668 /// dependency of the current device action. By default it is inactive.
1669 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
1670 return ABRT_Inactive;
1671 }
1672
1673 /// Append top level actions generated by the builder. Return true if errors
1674 /// were found.
1675 virtual void appendTopLevelActions(ActionList &AL) {}
1676
1677 /// Append linker actions generated by the builder. Return true if errors
1678 /// were found.
1679 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
1680
1681 /// Initialize the builder. Return true if any initialization errors are
1682 /// found.
1683 virtual bool initialize() { return false; }
1684
Samuel Antao69d6f312016-10-27 17:50:43 +00001685 /// Return true if the builder can use bundling/unbundling.
1686 virtual bool canUseBundlerUnbundler() const { return false; }
1687
Samuel Antao64e965e2016-09-30 15:34:19 +00001688 /// Return true if this builder is valid. We have a valid builder if we have
1689 /// associated device tool chains.
1690 bool isValid() { return !ToolChains.empty(); }
1691
1692 /// Return the associated offload kind.
1693 Action::OffloadKind getAssociatedOffloadKind() {
1694 return AssociatedOffloadKind;
1695 }
1696 };
1697
1698 /// \brief CUDA action builder. It injects device code in the host backend
1699 /// action.
1700 class CudaActionBuilder final : public DeviceActionBuilder {
1701 /// Flags to signal if the user requested host-only or device-only
1702 /// compilation.
1703 bool CompileHostOnly = false;
1704 bool CompileDeviceOnly = false;
1705
1706 /// List of GPU architectures to use in this compilation.
1707 SmallVector<CudaArch, 4> GpuArchList;
1708
1709 /// The CUDA actions for the current input.
1710 ActionList CudaDeviceActions;
1711
1712 /// The CUDA fat binary if it was generated for the current input.
1713 Action *CudaFatBinary = nullptr;
1714
1715 /// Flag that is set to true if this builder acted on the current input.
1716 bool IsActive = false;
1717
1718 public:
1719 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
1720 const Driver::InputList &Inputs)
1721 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_Cuda) {}
1722
1723 ActionBuilderReturnCode
Samuel Antao28c4f182016-10-27 17:08:03 +00001724 getDeviceDependences(OffloadAction::DeviceDependences &DA,
1725 phases::ID CurPhase, phases::ID FinalPhase,
1726 PhasesTy &Phases) override {
Samuel Antao64e965e2016-09-30 15:34:19 +00001727 if (!IsActive)
1728 return ABRT_Inactive;
1729
1730 // If we don't have more CUDA actions, we don't have any dependences to
1731 // create for the host.
1732 if (CudaDeviceActions.empty())
1733 return ABRT_Success;
1734
1735 assert(CudaDeviceActions.size() == GpuArchList.size() &&
1736 "Expecting one action per GPU architecture.");
1737 assert(!CompileHostOnly &&
1738 "Not expecting CUDA actions in host-only compilation.");
1739
1740 // If we are generating code for the device or we are in a backend phase,
1741 // we attempt to generate the fat binary. We compile each arch to ptx and
1742 // assemble to cubin, then feed the cubin *and* the ptx into a device
1743 // "link" action, which uses fatbinary to combine these cubins into one
1744 // fatbin. The fatbin is then an input to the host action if not in
1745 // device-only mode.
1746 if (CompileDeviceOnly || CurPhase == phases::Backend) {
1747 ActionList DeviceActions;
1748 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
1749 // Produce the device action from the current phase up to the assemble
1750 // phase.
1751 for (auto Ph : Phases) {
1752 // Skip the phases that were already dealt with.
1753 if (Ph < CurPhase)
1754 continue;
1755 // We have to be consistent with the host final phase.
1756 if (Ph > FinalPhase)
1757 break;
1758
1759 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
1760 C, Args, Ph, CudaDeviceActions[I]);
1761
1762 if (Ph == phases::Assemble)
1763 break;
1764 }
1765
1766 // If we didn't reach the assemble phase, we can't generate the fat
1767 // binary. We don't need to generate the fat binary if we are not in
1768 // device-only mode.
1769 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
1770 CompileDeviceOnly)
1771 continue;
1772
1773 Action *AssembleAction = CudaDeviceActions[I];
1774 assert(AssembleAction->getType() == types::TY_Object);
1775 assert(AssembleAction->getInputs().size() == 1);
1776
1777 Action *BackendAction = AssembleAction->getInputs()[0];
1778 assert(BackendAction->getType() == types::TY_PP_Asm);
1779
1780 for (auto &A : {AssembleAction, BackendAction}) {
1781 OffloadAction::DeviceDependences DDep;
1782 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
1783 Action::OFK_Cuda);
1784 DeviceActions.push_back(
1785 C.MakeAction<OffloadAction>(DDep, A->getType()));
1786 }
1787 }
1788
1789 // We generate the fat binary if we have device input actions.
1790 if (!DeviceActions.empty()) {
1791 CudaFatBinary =
1792 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
1793
1794 if (!CompileDeviceOnly) {
1795 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
1796 Action::OFK_Cuda);
1797 // Clear the fat binary, it is already a dependence to an host
1798 // action.
1799 CudaFatBinary = nullptr;
1800 }
1801
1802 // Remove the CUDA actions as they are already connected to an host
1803 // action or fat binary.
1804 CudaDeviceActions.clear();
1805 }
1806
1807 // We avoid creating host action in device-only mode.
1808 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
Samuel Antao5b1a89a2016-10-27 00:53:34 +00001809 } else if (CurPhase > phases::Backend) {
1810 // If we are past the backend phase and still have a device action, we
1811 // don't have to do anything as this action is already a device
1812 // top-level action.
1813 return ABRT_Success;
Samuel Antao64e965e2016-09-30 15:34:19 +00001814 }
1815
1816 assert(CurPhase < phases::Backend && "Generating single CUDA "
1817 "instructions should only occur "
1818 "before the backend phase!");
1819
1820 // By default, we produce an action for each device arch.
1821 for (Action *&A : CudaDeviceActions)
1822 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
1823
1824 return ABRT_Success;
1825 }
1826
1827 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
1828 // While generating code for CUDA, we only depend on the host input action
1829 // to trigger the creation of all the CUDA device actions.
1830
1831 // If we are dealing with an input action, replicate it for each GPU
1832 // architecture. If we are in host-only mode we return 'success' so that
1833 // the host uses the CUDA offload kind.
1834 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
1835 assert(!GpuArchList.empty() &&
1836 "We should have at least one GPU architecture.");
1837
1838 // If the host input is not CUDA, we don't need to bother about this
1839 // input.
1840 if (IA->getType() != types::TY_CUDA) {
1841 // The builder will ignore this input.
1842 IsActive = false;
1843 return ABRT_Inactive;
1844 }
1845
1846 // Set the flag to true, so that the builder acts on the current input.
1847 IsActive = true;
1848
1849 if (CompileHostOnly)
1850 return ABRT_Success;
1851
1852 // Replicate inputs for each GPU architecture.
1853 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1854 CudaDeviceActions.push_back(C.MakeAction<InputAction>(
1855 IA->getInputArg(), types::TY_CUDA_DEVICE));
1856
1857 return ABRT_Success;
1858 }
1859
1860 return IsActive ? ABRT_Success : ABRT_Inactive;
1861 }
1862
1863 void appendTopLevelActions(ActionList &AL) override {
1864 // Utility to append actions to the top level list.
1865 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
1866 OffloadAction::DeviceDependences Dep;
1867 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
1868 Action::OFK_Cuda);
1869 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
1870 };
1871
1872 // If we have a fat binary, add it to the list.
1873 if (CudaFatBinary) {
1874 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
1875 CudaDeviceActions.clear();
1876 CudaFatBinary = nullptr;
1877 return;
1878 }
1879
1880 if (CudaDeviceActions.empty())
1881 return;
1882
1883 // If we have CUDA actions at this point, that's because we have a have
1884 // partial compilation, so we should have an action for each GPU
1885 // architecture.
1886 assert(CudaDeviceActions.size() == GpuArchList.size() &&
1887 "Expecting one action per GPU architecture.");
1888 assert(ToolChains.size() == 1 &&
1889 "Expecting to have a sing CUDA toolchain.");
1890 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1891 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
1892
1893 CudaDeviceActions.clear();
1894 }
1895
1896 bool initialize() override {
1897 // We don't need to support CUDA.
1898 if (!C.hasOffloadToolChain<Action::OFK_Cuda>())
1899 return false;
1900
1901 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
1902 assert(HostTC && "No toolchain for host compilation.");
1903 if (HostTC->getTriple().isNVPTX()) {
1904 // We do not support targeting NVPTX for host compilation. Throw
1905 // an error and abort pipeline construction early so we don't trip
1906 // asserts that assume device-side compilation.
1907 C.getDriver().Diag(diag::err_drv_cuda_nvptx_host);
1908 return true;
1909 }
1910
1911 ToolChains.push_back(C.getSingleOffloadToolChain<Action::OFK_Cuda>());
1912
1913 Arg *PartialCompilationArg = Args.getLastArg(
1914 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
1915 options::OPT_cuda_compile_host_device);
1916 CompileHostOnly = PartialCompilationArg &&
1917 PartialCompilationArg->getOption().matches(
1918 options::OPT_cuda_host_only);
1919 CompileDeviceOnly = PartialCompilationArg &&
1920 PartialCompilationArg->getOption().matches(
1921 options::OPT_cuda_device_only);
1922
1923 // Collect all cuda_gpu_arch parameters, removing duplicates.
Artem Belevicha424e882016-12-09 22:59:17 +00001924 std::set<CudaArch> GpuArchs;
Samuel Antao64e965e2016-09-30 15:34:19 +00001925 bool Error = false;
1926 for (Arg *A : Args) {
Artem Belevicha424e882016-12-09 22:59:17 +00001927 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
1928 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
Samuel Antao64e965e2016-09-30 15:34:19 +00001929 continue;
1930 A->claim();
1931
Artem Belevicha424e882016-12-09 22:59:17 +00001932 const StringRef ArchStr = A->getValue();
1933 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
1934 ArchStr == "all") {
1935 GpuArchs.clear();
1936 continue;
1937 }
Samuel Antao64e965e2016-09-30 15:34:19 +00001938 CudaArch Arch = StringToCudaArch(ArchStr);
1939 if (Arch == CudaArch::UNKNOWN) {
1940 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
1941 Error = true;
Artem Belevicha424e882016-12-09 22:59:17 +00001942 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
1943 GpuArchs.insert(Arch);
1944 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
1945 GpuArchs.erase(Arch);
1946 else
1947 llvm_unreachable("Unexpected option.");
Samuel Antao64e965e2016-09-30 15:34:19 +00001948 }
1949
Artem Belevicha424e882016-12-09 22:59:17 +00001950 // Collect list of GPUs remaining in the set.
1951 for (CudaArch Arch : GpuArchs)
1952 GpuArchList.push_back(Arch);
1953
1954 // Default to sm_20 which is the lowest common denominator for
1955 // supported GPUs. sm_20 code should work correctly, if
1956 // suboptimally, on all newer GPUs.
Samuel Antao64e965e2016-09-30 15:34:19 +00001957 if (GpuArchList.empty())
1958 GpuArchList.push_back(CudaArch::SM_20);
1959
1960 return Error;
1961 }
1962 };
1963
Samuel Antao28c4f182016-10-27 17:08:03 +00001964 /// OpenMP action builder. The host bitcode is passed to the device frontend
1965 /// and all the device linked images are passed to the host link phase.
1966 class OpenMPActionBuilder final : public DeviceActionBuilder {
1967 /// The OpenMP actions for the current input.
1968 ActionList OpenMPDeviceActions;
1969
1970 /// The linker inputs obtained for each toolchain.
1971 SmallVector<ActionList, 8> DeviceLinkerInputs;
1972
1973 public:
1974 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
1975 const Driver::InputList &Inputs)
1976 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
1977
1978 ActionBuilderReturnCode
1979 getDeviceDependences(OffloadAction::DeviceDependences &DA,
1980 phases::ID CurPhase, phases::ID FinalPhase,
1981 PhasesTy &Phases) override {
1982
1983 // We should always have an action for each input.
1984 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
1985 "Number of OpenMP actions and toolchains do not match.");
1986
1987 // The host only depends on device action in the linking phase, when all
1988 // the device images have to be embedded in the host image.
1989 if (CurPhase == phases::Link) {
1990 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
1991 "Toolchains and linker inputs sizes do not match.");
1992 auto LI = DeviceLinkerInputs.begin();
1993 for (auto *A : OpenMPDeviceActions) {
1994 LI->push_back(A);
1995 ++LI;
1996 }
1997
1998 // We passed the device action as a host dependence, so we don't need to
1999 // do anything else with them.
2000 OpenMPDeviceActions.clear();
2001 return ABRT_Success;
2002 }
2003
2004 // By default, we produce an action for each device arch.
2005 for (Action *&A : OpenMPDeviceActions)
2006 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2007
2008 return ABRT_Success;
2009 }
2010
2011 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2012
2013 // If this is an input action replicate it for each OpenMP toolchain.
2014 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2015 OpenMPDeviceActions.clear();
2016 for (unsigned I = 0; I < ToolChains.size(); ++I)
2017 OpenMPDeviceActions.push_back(
2018 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2019 return ABRT_Success;
2020 }
2021
Samuel Antaofab4f372016-10-27 18:00:51 +00002022 // If this is an unbundling action use it as is for each OpenMP toolchain.
2023 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2024 OpenMPDeviceActions.clear();
2025 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2026 OpenMPDeviceActions.push_back(UA);
2027 UA->registerDependentActionInfo(
2028 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2029 }
2030 return ABRT_Success;
2031 }
2032
Samuel Antao28c4f182016-10-27 17:08:03 +00002033 // When generating code for OpenMP we use the host compile phase result as
2034 // a dependence to the device compile phase so that it can learn what
2035 // declarations should be emitted. However, this is not the only use for
2036 // the host action, so we prevent it from being collapsed.
2037 if (isa<CompileJobAction>(HostAction)) {
2038 HostAction->setCannotBeCollapsedWithNextDependentAction();
2039 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2040 "Toolchains and device action sizes do not match.");
2041 OffloadAction::HostDependence HDep(
2042 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2043 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2044 auto TC = ToolChains.begin();
2045 for (Action *&A : OpenMPDeviceActions) {
2046 assert(isa<CompileJobAction>(A));
2047 OffloadAction::DeviceDependences DDep;
2048 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2049 A = C.MakeAction<OffloadAction>(HDep, DDep);
2050 ++TC;
2051 }
2052 }
2053 return ABRT_Success;
2054 }
2055
Samuel Antao69d6f312016-10-27 17:50:43 +00002056 void appendTopLevelActions(ActionList &AL) override {
2057 if (OpenMPDeviceActions.empty())
2058 return;
2059
2060 // We should always have an action for each input.
2061 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2062 "Number of OpenMP actions and toolchains do not match.");
2063
2064 // Append all device actions followed by the proper offload action.
2065 auto TI = ToolChains.begin();
2066 for (auto *A : OpenMPDeviceActions) {
2067 OffloadAction::DeviceDependences Dep;
2068 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2069 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2070 ++TI;
2071 }
2072 // We no longer need the action stored in this builder.
2073 OpenMPDeviceActions.clear();
2074 }
2075
Samuel Antao28c4f182016-10-27 17:08:03 +00002076 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2077 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2078 "Toolchains and linker inputs sizes do not match.");
2079
2080 // Append a new link action for each device.
2081 auto TC = ToolChains.begin();
2082 for (auto &LI : DeviceLinkerInputs) {
2083 auto *DeviceLinkAction =
2084 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2085 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2086 Action::OFK_OpenMP);
2087 ++TC;
2088 }
2089 }
2090
2091 bool initialize() override {
2092 // Get the OpenMP toolchains. If we don't get any, the action builder will
2093 // know there is nothing to do related to OpenMP offloading.
2094 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2095 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2096 ++TI)
2097 ToolChains.push_back(TI->second);
2098
2099 DeviceLinkerInputs.resize(ToolChains.size());
2100 return false;
2101 }
Samuel Antao69d6f312016-10-27 17:50:43 +00002102
2103 bool canUseBundlerUnbundler() const override {
2104 // OpenMP should use bundled files whenever possible.
2105 return true;
2106 }
Samuel Antao28c4f182016-10-27 17:08:03 +00002107 };
2108
2109 ///
2110 /// TODO: Add the implementation for other specialized builders here.
2111 ///
Samuel Antao64e965e2016-09-30 15:34:19 +00002112
2113 /// Specialized builders being used by this offloading action builder.
2114 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2115
Samuel Antao69d6f312016-10-27 17:50:43 +00002116 /// Flag set to true if all valid builders allow file bundling/unbundling.
2117 bool CanUseBundler;
2118
Samuel Antao64e965e2016-09-30 15:34:19 +00002119public:
2120 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2121 const Driver::InputList &Inputs)
Samuel Antao10e905c2016-10-27 01:08:58 +00002122 : C(C) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002123 // Create a specialized builder for each device toolchain.
2124
2125 IsValid = true;
2126
2127 // Create a specialized builder for CUDA.
2128 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2129
Samuel Antao28c4f182016-10-27 17:08:03 +00002130 // Create a specialized builder for OpenMP.
2131 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2132
Samuel Antao64e965e2016-09-30 15:34:19 +00002133 //
2134 // TODO: Build other specialized builders here.
2135 //
2136
Samuel Antao69d6f312016-10-27 17:50:43 +00002137 // Initialize all the builders, keeping track of errors. If all valid
2138 // builders agree that we can use bundling, set the flag to true.
2139 unsigned ValidBuilders = 0u;
2140 unsigned ValidBuildersSupportingBundling = 0u;
2141 for (auto *SB : SpecializedBuilders) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002142 IsValid = IsValid && !SB->initialize();
Samuel Antao69d6f312016-10-27 17:50:43 +00002143
2144 // Update the counters if the builder is valid.
2145 if (SB->isValid()) {
2146 ++ValidBuilders;
2147 if (SB->canUseBundlerUnbundler())
2148 ++ValidBuildersSupportingBundling;
2149 }
2150 }
2151 CanUseBundler =
2152 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
Artem Belevichf981e30b2016-08-02 22:37:47 +00002153 }
Justin Lebardc3c5042016-04-19 02:27:07 +00002154
Samuel Antao64e965e2016-09-30 15:34:19 +00002155 ~OffloadingActionBuilder() {
2156 for (auto *SB : SpecializedBuilders)
2157 delete SB;
Samuel Antaod06239d2016-07-15 23:13:27 +00002158 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002159
Samuel Antao64e965e2016-09-30 15:34:19 +00002160 /// Generate an action that adds device dependences (if any) to a host action.
2161 /// If no device dependence actions exist, just return the host action \a
2162 /// HostAction. If an error is found or if no builder requires the host action
2163 /// to be generated, return nullptr.
2164 Action *
2165 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2166 phases::ID CurPhase, phases::ID FinalPhase,
2167 DeviceActionBuilder::PhasesTy &Phases) {
2168 if (!IsValid)
2169 return nullptr;
Justin Lebar7bf77982016-01-11 23:27:13 +00002170
Samuel Antao64e965e2016-09-30 15:34:19 +00002171 if (SpecializedBuilders.empty())
2172 return HostAction;
2173
2174 assert(HostAction && "Invalid host action!");
2175
2176 OffloadAction::DeviceDependences DDeps;
2177 // Check if all the programming models agree we should not emit the host
2178 // action. Also, keep track of the offloading kinds employed.
2179 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2180 unsigned InactiveBuilders = 0u;
2181 unsigned IgnoringBuilders = 0u;
2182 for (auto *SB : SpecializedBuilders) {
2183 if (!SB->isValid()) {
2184 ++InactiveBuilders;
2185 continue;
2186 }
2187
Samuel Antao28c4f182016-10-27 17:08:03 +00002188 auto RetCode =
2189 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
Samuel Antao64e965e2016-09-30 15:34:19 +00002190
2191 // If the builder explicitly says the host action should be ignored,
2192 // we need to increment the variable that tracks the builders that request
2193 // the host object to be ignored.
2194 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2195 ++IgnoringBuilders;
2196
2197 // Unless the builder was inactive for this action, we have to record the
2198 // offload kind because the host will have to use it.
2199 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2200 OffloadKind |= SB->getAssociatedOffloadKind();
2201 }
2202
2203 // If all builders agree that the host object should be ignored, just return
2204 // nullptr.
2205 if (IgnoringBuilders &&
2206 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2207 return nullptr;
2208
2209 if (DDeps.getActions().empty())
2210 return HostAction;
2211
2212 // We have dependences we need to bundle together. We use an offload action
2213 // for that.
2214 OffloadAction::HostDependence HDep(
2215 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2216 /*BoundArch=*/nullptr, DDeps);
2217 return C.MakeAction<OffloadAction>(HDep, DDeps);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002218 }
2219
Samuel Antao64e965e2016-09-30 15:34:19 +00002220 /// Generate an action that adds a host dependence to a device action. The
2221 /// results will be kept in this action builder. Return true if an error was
2222 /// found.
Samuel Antaofab4f372016-10-27 18:00:51 +00002223 bool addHostDependenceToDeviceActions(Action *&HostAction,
Samuel Antao64e965e2016-09-30 15:34:19 +00002224 const Arg *InputArg) {
2225 if (!IsValid)
2226 return true;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002227
Samuel Antaofab4f372016-10-27 18:00:51 +00002228 // If we are supporting bundling/unbundling and the current action is an
2229 // input action of non-source file, we replace the host action by the
2230 // unbundling action. The bundler tool has the logic to detect if an input
2231 // is a bundle or not and if the input is not a bundle it assumes it is a
2232 // host file. Therefore it is safe to create an unbundling action even if
2233 // the input is not a bundle.
2234 if (CanUseBundler && isa<InputAction>(HostAction) &&
2235 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
2236 !types::isSrcFile(HostAction->getType())) {
2237 auto UnbundlingHostAction =
2238 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
2239 UnbundlingHostAction->registerDependentActionInfo(
2240 C.getSingleOffloadToolChain<Action::OFK_Host>(),
2241 /*BoundArch=*/StringRef(), Action::OFK_Host);
2242 HostAction = UnbundlingHostAction;
2243 }
2244
Samuel Antao64e965e2016-09-30 15:34:19 +00002245 assert(HostAction && "Invalid host action!");
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002246
Samuel Antao64e965e2016-09-30 15:34:19 +00002247 // Register the offload kinds that are used.
2248 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2249 for (auto *SB : SpecializedBuilders) {
2250 if (!SB->isValid())
2251 continue;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002252
Samuel Antao64e965e2016-09-30 15:34:19 +00002253 auto RetCode = SB->addDeviceDepences(HostAction);
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002254
Samuel Antao64e965e2016-09-30 15:34:19 +00002255 // Host dependences for device actions are not compatible with that same
2256 // action being ignored.
2257 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
2258 "Host dependence not expected to be ignored.!");
Samuel Antaod06239d2016-07-15 23:13:27 +00002259
Samuel Antao64e965e2016-09-30 15:34:19 +00002260 // Unless the builder was inactive for this action, we have to record the
2261 // offload kind because the host will have to use it.
2262 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2263 OffloadKind |= SB->getAssociatedOffloadKind();
2264 }
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002265
Samuel Antao64e965e2016-09-30 15:34:19 +00002266 return false;
2267 }
2268
Samuel Antao69d6f312016-10-27 17:50:43 +00002269 /// Add the offloading top level actions to the provided action list. This
2270 /// function can replace the host action by a bundling action if the
2271 /// programming models allow it.
Samuel Antao64e965e2016-09-30 15:34:19 +00002272 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
2273 const Arg *InputArg) {
Samuel Antao69d6f312016-10-27 17:50:43 +00002274 // Get the device actions to be appended.
2275 ActionList OffloadAL;
Samuel Antao64e965e2016-09-30 15:34:19 +00002276 for (auto *SB : SpecializedBuilders) {
2277 if (!SB->isValid())
2278 continue;
Samuel Antao69d6f312016-10-27 17:50:43 +00002279 SB->appendTopLevelActions(OffloadAL);
Samuel Antao64e965e2016-09-30 15:34:19 +00002280 }
2281
Samuel Antao69d6f312016-10-27 17:50:43 +00002282 // If we can use the bundler, replace the host action by the bundling one in
2283 // the resulting list. Otherwise, just append the device actions.
2284 if (CanUseBundler && !OffloadAL.empty()) {
2285 // Add the host action to the list in order to create the bundling action.
2286 OffloadAL.push_back(HostAction);
2287
2288 // We expect that the host action was just appended to the action list
2289 // before this method was called.
2290 assert(HostAction == AL.back() && "Host action not in the list??");
2291 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
2292 AL.back() = HostAction;
2293 } else
2294 AL.append(OffloadAL.begin(), OffloadAL.end());
2295
Samuel Antao64e965e2016-09-30 15:34:19 +00002296 // Propagate to the current host action (if any) the offload information
2297 // associated with the current input.
2298 if (HostAction)
2299 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
2300 /*BoundArch=*/nullptr);
Samuel Antao64e965e2016-09-30 15:34:19 +00002301 return false;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002302 }
Artem Belevich5bde4e02015-07-20 20:02:54 +00002303
Samuel Antao64e965e2016-09-30 15:34:19 +00002304 /// Processes the host linker action. This currently consists of replacing it
2305 /// with an offload action if there are device link objects and propagate to
2306 /// the host action all the offload kinds used in the current compilation. The
2307 /// resulting action is returned.
2308 Action *processHostLinkAction(Action *HostAction) {
2309 // Add all the dependences from the device linking actions.
2310 OffloadAction::DeviceDependences DDeps;
2311 for (auto *SB : SpecializedBuilders) {
2312 if (!SB->isValid())
2313 continue;
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002314
Samuel Antao64e965e2016-09-30 15:34:19 +00002315 SB->appendLinkDependences(DDeps);
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002316 }
Samuel Antaod06239d2016-07-15 23:13:27 +00002317
Samuel Antao64e965e2016-09-30 15:34:19 +00002318 // Calculate all the offload kinds used in the current compilation.
2319 unsigned ActiveOffloadKinds = 0u;
2320 for (auto &I : InputArgToOffloadKindMap)
2321 ActiveOffloadKinds |= I.second;
2322
2323 // If we don't have device dependencies, we don't have to create an offload
2324 // action.
2325 if (DDeps.getActions().empty()) {
2326 // Propagate all the active kinds to host action. Given that it is a link
2327 // action it is assumed to depend on all actions generated so far.
2328 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
2329 /*BoundArch=*/nullptr);
2330 return HostAction;
2331 }
2332
2333 // Create the offload action with all dependences. When an offload action
2334 // is created the kinds are propagated to the host action, so we don't have
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002335 // to do that explicitly here.
Samuel Antao64e965e2016-09-30 15:34:19 +00002336 OffloadAction::HostDependence HDep(
2337 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2338 /*BoundArch*/ nullptr, ActiveOffloadKinds);
2339 return C.MakeAction<OffloadAction>(HDep, DDeps);
2340 }
2341};
2342} // anonymous namespace.
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002343
Justin Lebar0f3474c2016-02-11 02:00:50 +00002344void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
2345 const InputList &Inputs, ActionList &Actions) const {
Chad Rosierecdede82011-08-12 22:08:57 +00002346 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
Joerg Sonnenbergerb86f5f42011-03-06 23:31:01 +00002347
Daniel Dunbar34c41872009-03-13 00:17:48 +00002348 if (!SuppressMissingInputWarning && Inputs.empty()) {
Daniel Dunbarbfeec742009-03-12 23:55:14 +00002349 Diag(clang::diag::err_drv_no_input_files);
2350 return;
2351 }
2352
Chad Rosier7742b5d2011-07-27 23:36:45 +00002353 Arg *FinalPhaseArg;
2354 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00002355
Bob Haarmanaaf51912017-02-27 19:40:19 +00002356 if (FinalPhase == phases::Link) {
2357 if (Args.hasArg(options::OPT_emit_llvm))
2358 Diag(clang::diag::err_drv_emit_llvm_link);
2359 if (IsCLMode() && LTOMode != LTOK_None &&
2360 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
2361 Diag(clang::diag::err_drv_lto_without_lld);
Rafael Espindolae8025642013-08-25 14:27:09 +00002362 }
2363
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002364 // Reject -Z* at the top level, these options should never have been exposed
2365 // by gcc.
Daniel Dunbardd765242009-03-26 16:12:09 +00002366 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
Daniel Dunbar0e759942009-03-20 06:14:23 +00002367 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
Daniel Dunbarbfeec742009-03-12 23:55:14 +00002368
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002369 // Diagnose misuse of /Fo.
2370 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002371 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00002372 if (Inputs.size() > 1 && !V.empty() &&
2373 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002374 // Check whether /Fo tries to name an output file for multiple inputs.
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002375 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002376 << A->getSpelling() << V;
Hans Wennborg13b7fe72013-08-12 23:26:25 +00002377 Args.eraseArg(options::OPT__SLASH_Fo);
2378 }
2379 }
2380
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002381 // Diagnose misuse of /Fa.
2382 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
2383 StringRef V = A->getValue();
Hans Wennborg61647532014-11-17 19:16:36 +00002384 if (Inputs.size() > 1 && !V.empty() &&
2385 !llvm::sys::path::is_separator(V.back())) {
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002386 // Check whether /Fa tries to name an asm file for multiple inputs.
2387 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002388 << A->getSpelling() << V;
Hans Wennborg9c1659b2013-10-18 22:49:04 +00002389 Args.eraseArg(options::OPT__SLASH_Fa);
2390 }
2391 }
2392
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00002393 // Diagnose misuse of /o.
2394 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
2395 if (A->getValue()[0] == '\0') {
2396 // It has to have a value.
2397 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
2398 Args.eraseArg(options::OPT__SLASH_o);
2399 }
2400 }
2401
Nico Weber2ca4be92016-03-01 23:16:44 +00002402 // Diagnose unsupported forms of /Yc /Yu. Ignore /Yc/Yu for now if:
2403 // * no filename after it
2404 // * both /Yc and /Yu passed but with different filenames
2405 // * corresponding file not also passed as /FI
2406 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
2407 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
2408 if (YcArg && YcArg->getValue()[0] == '\0') {
2409 Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YcArg->getSpelling();
2410 Args.eraseArg(options::OPT__SLASH_Yc);
2411 YcArg = nullptr;
2412 }
2413 if (YuArg && YuArg->getValue()[0] == '\0') {
2414 Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YuArg->getSpelling();
2415 Args.eraseArg(options::OPT__SLASH_Yu);
2416 YuArg = nullptr;
2417 }
2418 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
2419 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
2420 Args.eraseArg(options::OPT__SLASH_Yc);
2421 Args.eraseArg(options::OPT__SLASH_Yu);
2422 YcArg = YuArg = nullptr;
2423 }
2424 if (YcArg || YuArg) {
2425 StringRef Val = YcArg ? YcArg->getValue() : YuArg->getValue();
2426 bool FoundMatchingInclude = false;
2427 for (const Arg *Inc : Args.filtered(options::OPT_include)) {
2428 // FIXME: Do case-insensitive matching and consider / and \ as equal.
2429 if (Inc->getValue() == Val)
2430 FoundMatchingInclude = true;
2431 }
2432 if (!FoundMatchingInclude) {
2433 Diag(clang::diag::warn_drv_ycyu_no_fi_arg_clang_cl)
2434 << (YcArg ? YcArg : YuArg)->getSpelling();
2435 Args.eraseArg(options::OPT__SLASH_Yc);
2436 Args.eraseArg(options::OPT__SLASH_Yu);
2437 YcArg = YuArg = nullptr;
2438 }
2439 }
2440 if (YcArg && Inputs.size() > 1) {
2441 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
2442 Args.eraseArg(options::OPT__SLASH_Yc);
2443 YcArg = nullptr;
2444 }
2445 if (Args.hasArg(options::OPT__SLASH_Y_)) {
2446 // /Y- disables all pch handling. Rather than check for it everywhere,
2447 // just remove clang-cl pch-related flags here.
2448 Args.eraseArg(options::OPT__SLASH_Fp);
2449 Args.eraseArg(options::OPT__SLASH_Yc);
2450 Args.eraseArg(options::OPT__SLASH_Yu);
2451 YcArg = YuArg = nullptr;
2452 }
Nico Weber2ca4be92016-03-01 23:16:44 +00002453
Samuel Antao64e965e2016-09-30 15:34:19 +00002454 // Builder to be used to build offloading actions.
2455 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
Samuel Antaod06239d2016-07-15 23:13:27 +00002456
Daniel Dunbar65229332009-03-13 11:38:42 +00002457 // Construct the actions to perform.
2458 ActionList LinkerInputs;
Alp Toker965f8822013-11-27 05:22:15 +00002459
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00002460 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
Artem Belevich5bde4e02015-07-20 20:02:54 +00002461 for (auto &I : Inputs) {
2462 types::ID InputType = I.first;
2463 const Arg *InputArg = I.second;
Daniel Dunbar65229332009-03-13 11:38:42 +00002464
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00002465 PL.clear();
2466 types::getCompilationPhases(InputType, PL);
Daniel Dunbar65229332009-03-13 11:38:42 +00002467
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002468 // If the first step comes after the final phase we are doing as part of
2469 // this compilation, warn the user about it.
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00002470 phases::ID InitialPhase = PL[0];
Daniel Dunbar65229332009-03-13 11:38:42 +00002471 if (InitialPhase > FinalPhase) {
Daniel Dunbaradc5c7c2009-03-19 07:57:08 +00002472 // Claim here to avoid the more general unused warning.
2473 InputArg->claim();
Daniel Dunbar07806ca2009-09-17 04:13:26 +00002474
Daniel Dunbar2db3e732011-04-20 15:44:48 +00002475 // Suppress all unused style warnings with -Qunused-arguments
2476 if (Args.hasArg(options::OPT_Qunused_arguments))
2477 continue;
2478
Richard Smith403f76e2012-08-06 04:09:06 +00002479 // Special case when final phase determined by binary name, rather than
2480 // by a command-line argument with a corresponding Arg.
Hans Wennborg70850d82013-07-18 20:29:38 +00002481 if (CCCIsCPP())
Richard Smith403f76e2012-08-06 04:09:06 +00002482 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002483 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
Daniel Dunbar07806ca2009-09-17 04:13:26 +00002484 // Special case '-E' warning on a previously preprocessed file to make
2485 // more sense.
Richard Smith403f76e2012-08-06 04:09:06 +00002486 else if (InitialPhase == phases::Compile &&
2487 FinalPhase == phases::Preprocess &&
2488 getPreprocessedType(InputType) == types::TY_INVALID)
Daniel Dunbar07806ca2009-09-17 04:13:26 +00002489 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002490 << InputArg->getAsString(Args) << !!FinalPhaseArg
2491 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar07806ca2009-09-17 04:13:26 +00002492 else
2493 Diag(clang::diag::warn_drv_input_file_unused)
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002494 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
2495 << !!FinalPhaseArg
2496 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
Daniel Dunbar65229332009-03-13 11:38:42 +00002497 continue;
2498 }
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002499
Nico Weberad2d8f32016-04-21 19:59:10 +00002500 if (YcArg) {
2501 // Add a separate precompile phase for the compile phase.
2502 if (FinalPhase >= phases::Compile) {
Richard Smith8cd452d2016-08-30 18:55:16 +00002503 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
Nico Weberad2d8f32016-04-21 19:59:10 +00002504 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
Richard Smith8cd452d2016-08-30 18:55:16 +00002505 types::getCompilationPhases(HeaderType, PCHPL);
David Blaikie0aaa7622017-01-13 17:34:15 +00002506 Arg *PchInputArg = MakeInputArg(Args, *Opts, YcArg->getValue());
Nico Weberad2d8f32016-04-21 19:59:10 +00002507
2508 // Build the pipeline for the pch file.
Richard Smith8cd452d2016-08-30 18:55:16 +00002509 Action *ClangClPch =
2510 C.MakeAction<InputAction>(*PchInputArg, HeaderType);
Nico Weberad2d8f32016-04-21 19:59:10 +00002511 for (phases::ID Phase : PCHPL)
2512 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
2513 assert(ClangClPch);
2514 Actions.push_back(ClangClPch);
2515 // The driver currently exits after the first failed command. This
2516 // relies on that behavior, to make sure if the pch generation fails,
2517 // the main compilation won't run.
2518 }
2519 }
2520
Daniel Dunbar65229332009-03-13 11:38:42 +00002521 // Build the pipeline for this file.
Justin Lebar41094612016-01-11 23:07:27 +00002522 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
Samuel Antao64e965e2016-09-30 15:34:19 +00002523
2524 // Use the current host action in any of the offloading actions, if
2525 // required.
2526 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
2527 break;
2528
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002529 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
2530 i != e; ++i) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00002531 phases::ID Phase = *i;
Daniel Dunbar65229332009-03-13 11:38:42 +00002532
2533 // We are done if this step is past what the user requested.
2534 if (Phase > FinalPhase)
2535 break;
2536
Samuel Antao64e965e2016-09-30 15:34:19 +00002537 // Add any offload action the host action depends on.
2538 Current = OffloadBuilder.addDeviceDependencesToHostAction(
2539 Current, InputArg, Phase, FinalPhase, PL);
2540 if (!Current)
2541 break;
2542
Daniel Dunbar65229332009-03-13 11:38:42 +00002543 // Queue linker inputs.
2544 if (Phase == phases::Link) {
Matthew Curtis7ab8b2b2013-03-07 12:32:26 +00002545 assert((i + 1) == e && "linking must be final compilation step.");
Justin Lebar41094612016-01-11 23:07:27 +00002546 LinkerInputs.push_back(Current);
2547 Current = nullptr;
Daniel Dunbar65229332009-03-13 11:38:42 +00002548 break;
2549 }
2550
Samuel Antao64e965e2016-09-30 15:34:19 +00002551 // Otherwise construct the appropriate action.
2552 auto *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
2553
2554 // We didn't create a new action, so we will just move to the next phase.
2555 if (NewCurrent == Current)
Daniel Dunbar13864952009-03-24 20:17:30 +00002556 continue;
2557
Samuel Antao64e965e2016-09-30 15:34:19 +00002558 Current = NewCurrent;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002559
Samuel Antao64e965e2016-09-30 15:34:19 +00002560 // Use the current host action in any of the offloading actions, if
2561 // required.
2562 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
2563 break;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00002564
Daniel Dunbar65229332009-03-13 11:38:42 +00002565 if (Current->getType() == types::TY_Nothing)
2566 break;
2567 }
2568
Samuel Antao64e965e2016-09-30 15:34:19 +00002569 // If we ended with something, add to the output list.
2570 if (Current)
Justin Lebar41094612016-01-11 23:07:27 +00002571 Actions.push_back(Current);
Samuel Antao64e965e2016-09-30 15:34:19 +00002572
2573 // Add any top level actions generated for offloading.
2574 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002575 }
Daniel Dunbar65229332009-03-13 11:38:42 +00002576
Samuel Antao64e965e2016-09-30 15:34:19 +00002577 // Add a link action if necessary.
Samuel Antaod06239d2016-07-15 23:13:27 +00002578 if (!LinkerInputs.empty()) {
Samuel Antao64e965e2016-09-30 15:34:19 +00002579 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
2580 LA = OffloadBuilder.processHostLinkAction(LA);
2581 Actions.push_back(LA);
Samuel Antaod06239d2016-07-15 23:13:27 +00002582 }
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00002583
2584 // If we are linking, claim any options which are obviously only used for
2585 // compilation.
Hans Wennborga8ef14f2013-09-17 00:03:41 +00002586 if (FinalPhase == phases::Link && PL.size() == 1) {
Daniel Dunbarc7a67b72009-12-22 23:19:32 +00002587 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
Hans Wennborga8ef14f2013-09-17 00:03:41 +00002588 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
2589 }
2590
2591 // Claim ignored clang-cl options.
2592 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
Artem Belevichbaae0932015-07-28 21:01:30 +00002593
Justin Lebardc3c5042016-04-19 02:27:07 +00002594 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
2595 // to non-CUDA compilations and should not trigger warnings there.
Artem Belevichbaae0932015-07-28 21:01:30 +00002596 Args.ClaimAllArgs(options::OPT_cuda_host_only);
Justin Lebardc3c5042016-04-19 02:27:07 +00002597 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
Daniel Dunbar65229332009-03-13 11:38:42 +00002598}
2599
Justin Lebar0f3474c2016-02-11 02:00:50 +00002600Action *Driver::ConstructPhaseAction(Compilation &C, const ArgList &Args,
2601 phases::ID Phase, Action *Input) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00002602 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
Samuel Antao64e965e2016-09-30 15:34:19 +00002603
2604 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
2605 // encode this in the steps because the intermediate type depends on
2606 // arguments. Just special case here.
2607 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
2608 return Input;
2609
Daniel Dunbar65229332009-03-13 11:38:42 +00002610 // Build the appropriate action.
2611 switch (Phase) {
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002612 case phases::Link:
2613 llvm_unreachable("link action invalid here.");
Daniel Dunbar65229332009-03-13 11:38:42 +00002614 case phases::Preprocess: {
Daniel Dunbard67a3222009-03-30 06:36:42 +00002615 types::ID OutputTy;
2616 // -{M, MM} alter the output type.
Daniel Dunbar86aed7d2010-12-08 21:33:40 +00002617 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
Daniel Dunbard67a3222009-03-30 06:36:42 +00002618 OutputTy = types::TY_Dependencies;
2619 } else {
David Blaikie5d577a22012-06-29 22:03:56 +00002620 OutputTy = Input->getType();
2621 if (!Args.hasFlag(options::OPT_frewrite_includes,
Justin Bognerce8245b2014-06-24 08:01:01 +00002622 options::OPT_fno_rewrite_includes, false) &&
2623 !CCGenDiagnostics)
David Blaikie5d577a22012-06-29 22:03:56 +00002624 OutputTy = types::getPreprocessedType(OutputTy);
Daniel Dunbard67a3222009-03-30 06:36:42 +00002625 assert(OutputTy != types::TY_INVALID &&
2626 "Cannot preprocess this input type!");
2627 }
Justin Lebar41094612016-01-11 23:07:27 +00002628 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
Daniel Dunbar65229332009-03-13 11:38:42 +00002629 }
Aaron Ballman1f10cc52012-07-31 01:21:00 +00002630 case phases::Precompile: {
Richard Smithdd4ad3d2016-08-30 19:06:26 +00002631 types::ID OutputTy = getPrecompiledType(Input->getType());
2632 assert(OutputTy != types::TY_INVALID &&
2633 "Cannot precompile this input type!");
Aaron Ballman1f10cc52012-07-31 01:21:00 +00002634 if (Args.hasArg(options::OPT_fsyntax_only)) {
2635 // Syntax checks should not emit a PCH file
2636 OutputTy = types::TY_Nothing;
2637 }
Justin Lebar41094612016-01-11 23:07:27 +00002638 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
Aaron Ballman1f10cc52012-07-31 01:21:00 +00002639 }
Daniel Dunbar65229332009-03-13 11:38:42 +00002640 case phases::Compile: {
David Blaikie486f4402014-08-29 07:25:23 +00002641 if (Args.hasArg(options::OPT_fsyntax_only))
Justin Lebar41094612016-01-11 23:07:27 +00002642 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
David Blaikie486f4402014-08-29 07:25:23 +00002643 if (Args.hasArg(options::OPT_rewrite_objc))
Justin Lebar41094612016-01-11 23:07:27 +00002644 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
David Blaikie486f4402014-08-29 07:25:23 +00002645 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
Justin Lebar41094612016-01-11 23:07:27 +00002646 return C.MakeAction<CompileJobAction>(Input,
2647 types::TY_RewrittenLegacyObjC);
David Blaikie486f4402014-08-29 07:25:23 +00002648 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
Justin Lebar41094612016-01-11 23:07:27 +00002649 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
David Blaikie486f4402014-08-29 07:25:23 +00002650 if (Args.hasArg(options::OPT__migrate))
Justin Lebar41094612016-01-11 23:07:27 +00002651 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
David Blaikie486f4402014-08-29 07:25:23 +00002652 if (Args.hasArg(options::OPT_emit_ast))
Justin Lebar41094612016-01-11 23:07:27 +00002653 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
David Blaikie486f4402014-08-29 07:25:23 +00002654 if (Args.hasArg(options::OPT_module_file_info))
Justin Lebar41094612016-01-11 23:07:27 +00002655 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
David Blaikie486f4402014-08-29 07:25:23 +00002656 if (Args.hasArg(options::OPT_verify_pch))
Justin Lebar41094612016-01-11 23:07:27 +00002657 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
2658 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
Bob Wilson23a55f12014-12-21 07:00:00 +00002659 }
2660 case phases::Backend: {
Teresa Johnson945bc502015-10-15 20:35:53 +00002661 if (isUsingLTO()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002662 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002663 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
Justin Lebar41094612016-01-11 23:07:27 +00002664 return C.MakeAction<BackendJobAction>(Input, Output);
David Blaikie486f4402014-08-29 07:25:23 +00002665 }
2666 if (Args.hasArg(options::OPT_emit_llvm)) {
Shuxin Yang4b3c7ff2013-08-23 21:34:57 +00002667 types::ID Output =
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002668 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
Justin Lebar41094612016-01-11 23:07:27 +00002669 return C.MakeAction<BackendJobAction>(Input, Output);
Daniel Dunbar65229332009-03-13 11:38:42 +00002670 }
Justin Lebar41094612016-01-11 23:07:27 +00002671 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
Daniel Dunbar65229332009-03-13 11:38:42 +00002672 }
2673 case phases::Assemble:
Justin Lebar21e5d4f2016-01-14 21:41:27 +00002674 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
Daniel Dunbar65229332009-03-13 11:38:42 +00002675 }
2676
David Blaikie83d382b2011-09-23 05:06:16 +00002677 llvm_unreachable("invalid phase in ConstructPhaseAction");
Daniel Dunbar1688f1a2009-03-12 07:58:46 +00002678}
2679
Daniel Dunbarf0eddb82009-03-18 02:55:38 +00002680void Driver::BuildJobs(Compilation &C) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00002681 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbare75d8342009-03-16 06:56:51 +00002682
2683 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
2684
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002685 // It is an error to provide a -o option if we are making multiple output
2686 // files.
Daniel Dunbare75d8342009-03-16 06:56:51 +00002687 if (FinalOutput) {
2688 unsigned NumOutputs = 0;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00002689 for (const Action *A : C.getActions())
2690 if (A->getType() != types::TY_Nothing)
Daniel Dunbare75d8342009-03-16 06:56:51 +00002691 ++NumOutputs;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002692
Daniel Dunbare75d8342009-03-16 06:56:51 +00002693 if (NumOutputs > 1) {
2694 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
Craig Topper92fc2df2014-05-17 16:56:41 +00002695 FinalOutput = nullptr;
Daniel Dunbare75d8342009-03-16 06:56:51 +00002696 }
2697 }
2698
Chad Rosier35767232013-04-30 22:01:21 +00002699 // Collect the list of architectures.
2700 llvm::StringSet<> ArchNames;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00002701 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
2702 for (const Arg *A : C.getArgs())
Chad Rosier35767232013-04-30 22:01:21 +00002703 if (A->getOption().matches(options::OPT_arch))
2704 ArchNames.insert(A->getValue());
Chad Rosier35767232013-04-30 22:01:21 +00002705
Justin Lebarb44f6fe2016-01-14 21:41:21 +00002706 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
2707 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00002708 for (Action *A : C.getActions()) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002709 // If we are linking an image for multiple archs then the linker wants
2710 // -arch_multiple and -final_output <final image name>. Unfortunately, this
2711 // doesn't fit in cleanly because we have to pass this information down.
Daniel Dunbare75d8342009-03-16 06:56:51 +00002712 //
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002713 // FIXME: This is a hack; find a cleaner way to integrate this into the
2714 // process.
Craig Topper92fc2df2014-05-17 16:56:41 +00002715 const char *LinkingOutput = nullptr;
Daniel Dunbardd765242009-03-26 16:12:09 +00002716 if (isa<LipoJobAction>(A)) {
Daniel Dunbare75d8342009-03-16 06:56:51 +00002717 if (FinalOutput)
Richard Smithbd55daf2012-11-01 04:30:05 +00002718 LinkingOutput = FinalOutput->getValue();
Daniel Dunbare75d8342009-03-16 06:56:51 +00002719 else
Hans Wennborga7707222015-01-09 17:38:53 +00002720 LinkingOutput = getDefaultImageName();
Daniel Dunbare75d8342009-03-16 06:56:51 +00002721 }
2722
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002723 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
Mehdi Aminic50b1a22016-10-07 21:27:26 +00002724 /*BoundArch*/ StringRef(),
Daniel Dunbare75d8342009-03-16 06:56:51 +00002725 /*AtTopLevel*/ true,
Chad Rosier35767232013-04-30 22:01:21 +00002726 /*MultipleArchs*/ ArchNames.size() > 1,
Samuel Antaod06239d2016-07-15 23:13:27 +00002727 /*LinkingOutput*/ LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00002728 /*TargetDeviceOffloadKind*/ Action::OFK_None);
Daniel Dunbare75d8342009-03-16 06:56:51 +00002729 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00002730
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002731 // If the user passed -Qunused-arguments or there were errors, don't warn
2732 // about any unused arguments.
Argyrios Kyrtzidis31448a42010-11-18 21:47:07 +00002733 if (Diags.hasErrorOccurred() ||
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00002734 C.getArgs().hasArg(options::OPT_Qunused_arguments))
Daniel Dunbard175d972009-03-18 18:03:46 +00002735 return;
2736
Daniel Dunbar58399ae2009-03-29 22:24:54 +00002737 // Claim -### here.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002738 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002739
Nico Weber47bf5052016-04-25 21:15:49 +00002740 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00002741 (void)C.getArgs().hasArg(options::OPT_driver_mode);
Nico Weber47bf5052016-04-25 21:15:49 +00002742 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
Hans Wennborg70850d82013-07-18 20:29:38 +00002743
Saleem Abdulrasool688b6bc2014-12-29 19:01:36 +00002744 for (Arg *A : C.getArgs()) {
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00002745 // FIXME: It would be nice to be able to send the argument to the
David Blaikie9c902b52011-09-25 23:23:43 +00002746 // DiagnosticsEngine, so that extra values, position, and so on could be
2747 // printed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00002748 if (!A->isClaimed()) {
Michael J. Spencer66e2b202012-10-19 22:37:06 +00002749 if (A->getOption().hasFlag(options::NoArgumentUnused))
Daniel Dunbara3cfbe32009-04-07 19:04:18 +00002750 continue;
2751
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00002752 // Suppress the warning automatically if this is just a flag, and it is an
2753 // instance of an argument we already claimed.
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00002754 const Option &Opt = A->getOption();
Michael J. Spencerad3ccc32012-08-20 21:41:17 +00002755 if (Opt.getKind() == Option::FlagClass) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00002756 bool DuplicateClaimed = false;
2757
Sean Silva14facf32015-06-09 01:57:17 +00002758 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
2759 if (AA->isClaimed()) {
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00002760 DuplicateClaimed = true;
2761 break;
2762 }
2763 }
2764
2765 if (DuplicateClaimed)
2766 continue;
2767 }
2768
Ehsan Akhgarid8518332016-01-25 21:14:52 +00002769 // In clang-cl, don't mention unknown arguments here since they have
2770 // already been warned about.
2771 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
2772 Diag(clang::diag::warn_drv_unused_argument)
2773 << A->getAsString(C.getArgs());
Daniel Dunbar90dd6f42009-04-04 00:52:26 +00002774 }
Daniel Dunbar3ce436d2009-03-16 06:42:30 +00002775 }
Daniel Dunbar95e6b192009-03-13 22:12:33 +00002776}
Daniel Dunbarc4343942010-02-03 03:07:56 +00002777
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002778namespace {
2779/// Utility class to control the collapse of dependent actions and select the
2780/// tools accordingly.
2781class ToolSelector final {
2782 /// The tool chain this selector refers to.
2783 const ToolChain &TC;
Daniel Dunbarf9ff3502010-05-14 02:03:00 +00002784
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002785 /// The compilation this selector refers to.
2786 const Compilation &C;
Samuel Antaod06239d2016-07-15 23:13:27 +00002787
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002788 /// The base action this selector refers to.
2789 const JobAction *BaseAction;
Samuel Antaod06239d2016-07-15 23:13:27 +00002790
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002791 /// Set to true if the current toolchain refers to host actions.
2792 bool IsHostSelector;
Samuel Antaod06239d2016-07-15 23:13:27 +00002793
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002794 /// Set to true if save-temps and embed-bitcode functionalities are active.
2795 bool SaveTemps;
2796 bool EmbedBitcode;
2797
2798 /// Get previous dependent action or null if that does not exist. If
2799 /// \a CanBeCollapsed is false, that action must be legal to collapse or
2800 /// null will be returned.
2801 const JobAction *getPrevDependentAction(const ActionList &Inputs,
2802 ActionList &SavedOffloadAction,
2803 bool CanBeCollapsed = true) {
2804 // An option can be collapsed only if it has a single input.
2805 if (Inputs.size() != 1)
Craig Topper92fc2df2014-05-17 16:56:41 +00002806 return nullptr;
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002807
2808 Action *CurAction = *Inputs.begin();
2809 if (CanBeCollapsed &&
2810 !CurAction->isCollapsingWithNextDependentActionLegal())
2811 return nullptr;
2812
2813 // If the input action is an offload action. Look through it and save any
2814 // offload action that can be dropped in the event of a collapse.
2815 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
2816 // If the dependent action is a device action, we will attempt to collapse
2817 // only with other device actions. Otherwise, we would do the same but
2818 // with host actions only.
2819 if (!IsHostSelector) {
2820 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
2821 CurAction =
2822 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
2823 if (CanBeCollapsed &&
2824 !CurAction->isCollapsingWithNextDependentActionLegal())
2825 return nullptr;
2826 SavedOffloadAction.push_back(OA);
2827 return dyn_cast<JobAction>(CurAction);
2828 }
2829 } else if (OA->hasHostDependence()) {
2830 CurAction = OA->getHostDependence();
2831 if (CanBeCollapsed &&
2832 !CurAction->isCollapsingWithNextDependentActionLegal())
2833 return nullptr;
2834 SavedOffloadAction.push_back(OA);
2835 return dyn_cast<JobAction>(CurAction);
2836 }
2837 return nullptr;
2838 }
2839
2840 return dyn_cast<JobAction>(CurAction);
2841 }
2842
2843 /// Return true if an assemble action can be collapsed.
2844 bool canCollapseAssembleAction() const {
2845 return TC.useIntegratedAs() && !SaveTemps &&
2846 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
2847 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
2848 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
2849 }
2850
2851 /// Return true if a preprocessor action can be collapsed.
2852 bool canCollapsePreprocessorAction() const {
2853 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
2854 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
2855 !C.getArgs().hasArg(options::OPT_rewrite_objc);
2856 }
2857
2858 /// Struct that relates an action with the offload actions that would be
2859 /// collapsed with it.
2860 struct JobActionInfo final {
2861 /// The action this info refers to.
2862 const JobAction *JA = nullptr;
2863 /// The offload actions we need to take care off if this action is
2864 /// collapsed.
2865 ActionList SavedOffloadAction;
2866 };
2867
2868 /// Append collapsed offload actions from the give nnumber of elements in the
2869 /// action info array.
2870 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
2871 ArrayRef<JobActionInfo> &ActionInfo,
2872 unsigned ElementNum) {
2873 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
2874 for (unsigned I = 0; I < ElementNum; ++I)
2875 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
2876 ActionInfo[I].SavedOffloadAction.end());
2877 }
2878
2879 /// Functions that attempt to perform the combining. They detect if that is
2880 /// legal, and if so they update the inputs \a Inputs and the offload action
2881 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
2882 /// the combined action is returned. If the combining is not legal or if the
2883 /// tool does not exist, null is returned.
2884 /// Currently three kinds of collapsing are supported:
2885 /// - Assemble + Backend + Compile;
2886 /// - Assemble + Backend ;
2887 /// - Backend + Compile.
2888 const Tool *
2889 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
2890 const ActionList *&Inputs,
2891 ActionList &CollapsedOffloadAction) {
2892 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
2893 return nullptr;
2894 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
2895 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
2896 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
2897 if (!AJ || !BJ || !CJ)
2898 return nullptr;
2899
2900 // Get compiler tool.
2901 const Tool *T = TC.SelectTool(*CJ);
2902 if (!T)
2903 return nullptr;
2904
Steven Wu574b0f22016-03-01 01:07:58 +00002905 // When using -fembed-bitcode, it is required to have the same tool (clang)
2906 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
2907 if (EmbedBitcode) {
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002908 const Tool *BT = TC.SelectTool(*BJ);
2909 if (BT == T)
2910 return nullptr;
Steven Wu574b0f22016-03-01 01:07:58 +00002911 }
Bob Wilson23a55f12014-12-21 07:00:00 +00002912
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002913 if (!T->hasIntegratedAssembler())
Bob Wilson23a55f12014-12-21 07:00:00 +00002914 return nullptr;
Samuel Antaod06239d2016-07-15 23:13:27 +00002915
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00002916 Inputs = &CJ->getInputs();
2917 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
2918 /*NumElements=*/3);
2919 return T;
2920 }
2921 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
2922 const ActionList *&Inputs,
2923 ActionList &CollapsedOffloadAction) {
2924 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
2925 return nullptr;
2926 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
2927 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
2928 if (!AJ || !BJ)
2929 return nullptr;
2930
2931 // Retrieve the compile job, backend action must always be preceded by one.
2932 ActionList CompileJobOffloadActions;
2933 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
2934 /*CanBeCollapsed=*/false);
2935 if (!AJ || !BJ || !CJ)
2936 return nullptr;
2937
2938 assert(isa<CompileJobAction>(CJ) &&
2939 "Expecting compile job preceding backend job.");
2940
2941 // Get compiler tool.
2942 const Tool *T = TC.SelectTool(*CJ);
2943 if (!T)
2944 return nullptr;
2945
2946 if (!T->hasIntegratedAssembler())
2947 return nullptr;
2948
2949 Inputs = &BJ->getInputs();
2950 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
2951 /*NumElements=*/2);
2952 return T;
2953 }
2954 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
2955 const ActionList *&Inputs,
2956 ActionList &CollapsedOffloadAction) {
2957 if (ActionInfo.size() < 2 || !canCollapsePreprocessorAction())
2958 return nullptr;
2959 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
2960 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
2961 if (!BJ || !CJ)
2962 return nullptr;
2963
2964 // Get compiler tool.
2965 const Tool *T = TC.SelectTool(*CJ);
2966 if (!T)
2967 return nullptr;
2968
2969 if (T->canEmitIR() && (SaveTemps || EmbedBitcode))
2970 return nullptr;
2971
2972 Inputs = &CJ->getInputs();
2973 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
2974 /*NumElements=*/2);
2975 return T;
2976 }
2977
2978 /// Updates the inputs if the obtained tool supports combining with
2979 /// preprocessor action, and the current input is indeed a preprocessor
2980 /// action. If combining results in the collapse of offloading actions, those
2981 /// are appended to \a CollapsedOffloadAction.
2982 void combineWithPreprocessor(const Tool *T, const ActionList *&Inputs,
2983 ActionList &CollapsedOffloadAction) {
2984 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
2985 return;
2986
2987 // Attempt to get a preprocessor action dependence.
2988 ActionList PreprocessJobOffloadActions;
2989 auto *PJ = getPrevDependentAction(*Inputs, PreprocessJobOffloadActions);
2990 if (!PJ || !isa<PreprocessJobAction>(PJ))
2991 return;
2992
2993 // This is legal to combine. Append any offload action we found and set the
2994 // current inputs to preprocessor inputs.
2995 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
2996 PreprocessJobOffloadActions.end());
2997 Inputs = &PJ->getInputs();
2998 }
2999
3000public:
3001 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3002 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3003 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3004 EmbedBitcode(EmbedBitcode) {
3005 assert(BaseAction && "Invalid base action.");
3006 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3007 }
3008
3009 /// Check if a chain of actions can be combined and return the tool that can
3010 /// handle the combination of actions. The pointer to the current inputs \a
3011 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3012 /// connected to collapsed actions are updated accordingly. The latter enables
3013 /// the caller of the selector to process them afterwards instead of just
3014 /// dropping them. If no suitable tool is found, null will be returned.
3015 const Tool *getTool(const ActionList *&Inputs,
3016 ActionList &CollapsedOffloadAction) {
3017 //
3018 // Get the largest chain of actions that we could combine.
3019 //
3020
3021 SmallVector<JobActionInfo, 5> ActionChain(1);
3022 ActionChain.back().JA = BaseAction;
3023 while (ActionChain.back().JA) {
3024 const Action *CurAction = ActionChain.back().JA;
3025
3026 // Grow the chain by one element.
3027 ActionChain.resize(ActionChain.size() + 1);
3028 JobActionInfo &AI = ActionChain.back();
3029
3030 // Attempt to fill it with the
3031 AI.JA =
3032 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
Daniel Dunbarc4343942010-02-03 03:07:56 +00003033 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003034
3035 // Pop the last action info as it could not be filled.
3036 ActionChain.pop_back();
3037
3038 //
3039 // Attempt to combine actions. If all combining attempts failed, just return
3040 // the tool of the provided action. At the end we attempt to combine the
3041 // action with any preprocessor action it may depend on.
3042 //
3043
3044 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3045 CollapsedOffloadAction);
3046 if (!T)
3047 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3048 if (!T)
3049 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3050 if (!T) {
3051 Inputs = &BaseAction->getInputs();
3052 T = TC.SelectTool(*BaseAction);
3053 }
3054
3055 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3056 return T;
Daniel Dunbarc4343942010-02-03 03:07:56 +00003057 }
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003058};
Daniel Dunbarc4343942010-02-03 03:07:56 +00003059}
3060
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003061/// Return a string that uniquely identifies the result of a job. The bound arch
3062/// is not necessarily represented in the toolchain's triple -- for example,
3063/// armv7 and armv7s both map to the same triple -- so we need both in our map.
3064/// Also, we need to add the offloading device kind, as the same tool chain can
3065/// be used for host and device for some programming models, e.g. OpenMP.
3066static std::string GetTriplePlusArchString(const ToolChain *TC,
3067 StringRef BoundArch,
3068 Action::OffloadKind OffloadKind) {
Justin Lebar55c83322016-01-16 03:30:08 +00003069 std::string TriplePlusArch = TC->getTriple().normalize();
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003070 if (!BoundArch.empty()) {
Justin Lebar55c83322016-01-16 03:30:08 +00003071 TriplePlusArch += "-";
3072 TriplePlusArch += BoundArch;
3073 }
Samuel Antao59efaed2016-10-27 17:31:22 +00003074 TriplePlusArch += "-";
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003075 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3076 return TriplePlusArch;
3077}
3078
3079InputInfo Driver::BuildJobsForAction(
3080 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3081 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3082 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3083 Action::OffloadKind TargetDeviceOffloadKind) const {
3084 std::pair<const Action *, std::string> ActionTC = {
3085 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003086 auto CachedResult = CachedResults.find(ActionTC);
3087 if (CachedResult != CachedResults.end()) {
3088 return CachedResult->second;
3089 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003090 InputInfo Result = BuildJobsForActionNoCache(
3091 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003092 CachedResults, TargetDeviceOffloadKind);
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003093 CachedResults[ActionTC] = Result;
3094 return Result;
3095}
3096
3097InputInfo Driver::BuildJobsForActionNoCache(
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003098 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
Justin Lebarb44f6fe2016-01-14 21:41:21 +00003099 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
Samuel Antaod06239d2016-07-15 23:13:27 +00003100 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003101 Action::OffloadKind TargetDeviceOffloadKind) const {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003102 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
Daniel Dunbarc4acf9d2009-03-18 23:18:19 +00003103
Samuel Antaod06239d2016-07-15 23:13:27 +00003104 InputInfoList OffloadDependencesInputInfo;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003105 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
Samuel Antaod06239d2016-07-15 23:13:27 +00003106 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
3107 // The offload action is expected to be used in four different situations.
3108 //
3109 // a) Set a toolchain/architecture/kind for a host action:
3110 // Host Action 1 -> OffloadAction -> Host Action 2
3111 //
3112 // b) Set a toolchain/architecture/kind for a device action;
3113 // Device Action 1 -> OffloadAction -> Device Action 2
3114 //
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003115 // c) Specify a device dependence to a host action;
Samuel Antaod06239d2016-07-15 23:13:27 +00003116 // Device Action 1 _
3117 // \
3118 // Host Action 1 ---> OffloadAction -> Host Action 2
3119 //
3120 // d) Specify a host dependence to a device action.
3121 // Host Action 1 _
3122 // \
3123 // Device Action 1 ---> OffloadAction -> Device Action 2
3124 //
3125 // For a) and b), we just return the job generated for the dependence. For
3126 // c) and d) we override the current action with the host/device dependence
3127 // if the current toolchain is host/device and set the offload dependences
3128 // info with the jobs obtained from the device/host dependence(s).
3129
3130 // If there is a single device option, just generate the job for it.
3131 if (OA->hasSingleDeviceDependence()) {
3132 InputInfo DevA;
3133 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3134 const char *DepBoundArch) {
3135 DevA =
3136 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3137 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003138 CachedResults, DepA->getOffloadingDeviceKind());
Samuel Antaod06239d2016-07-15 23:13:27 +00003139 });
3140 return DevA;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003141 }
Samuel Antaod06239d2016-07-15 23:13:27 +00003142
3143 // If 'Action 2' is host, we generate jobs for the device dependences and
3144 // override the current action with the host dependence. Otherwise, we
3145 // generate the host dependences and override the action with the device
3146 // dependence. The dependences can't therefore be a top-level action.
3147 OA->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003148 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003149 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3150 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3151 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3152 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003153 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003154 });
3155
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003156 A = BuildingForOffloadDevice
Samuel Antaod06239d2016-07-15 23:13:27 +00003157 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3158 : OA->getHostDependence();
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003159 }
3160
Daniel Dunbare75d8342009-03-16 06:56:51 +00003161 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003162 // FIXME: It would be nice to not claim this here; maybe the old scheme of
3163 // just using Args was better?
Daniel Dunbar5cdf3e02009-03-19 07:29:38 +00003164 const Arg &Input = IA->getInputArg();
3165 Input.claim();
Daniel Dunbar35cbfeb2010-06-09 22:31:08 +00003166 if (Input.getOption().matches(options::OPT_INPUT)) {
Richard Smithbd55daf2012-11-01 04:30:05 +00003167 const char *Name = Input.getValue();
Justin Lebard98cea82016-01-11 23:15:21 +00003168 return InputInfo(A, Name, /* BaseInput = */ Name);
Douglas Katzman678d0cb2015-06-16 18:01:24 +00003169 }
Justin Lebard98cea82016-01-11 23:15:21 +00003170 return InputInfo(A, &Input, /* BaseInput = */ "");
Daniel Dunbare75d8342009-03-16 06:56:51 +00003171 }
3172
3173 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003174 const ToolChain *TC;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003175 StringRef ArchName = BAA->getArchName();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003176
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003177 if (!ArchName.empty())
Andrey Turetskiy6a8b91d2016-04-21 10:16:48 +00003178 TC = &getToolChain(C.getArgs(),
3179 computeTargetTriple(*this, DefaultTargetTriple,
3180 C.getArgs(), ArchName));
Chad Rosiera78a6eb2012-04-27 16:50:38 +00003181 else
3182 TC = &C.getDefaultToolChain();
Daniel Dunbar1ef3f2a2009-09-08 23:37:19 +00003183
Nico Weber5a459f82016-02-23 19:30:43 +00003184 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00003185 MultipleArchs, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003186 TargetDeviceOffloadKind);
Daniel Dunbare75d8342009-03-16 06:56:51 +00003187 }
3188
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003189
Daniel Dunbare75d8342009-03-16 06:56:51 +00003190 const ActionList *Inputs = &A->getInputs();
Daniel Dunbarc4343942010-02-03 03:07:56 +00003191
3192 const JobAction *JA = cast<JobAction>(A);
Samuel Antaod06239d2016-07-15 23:13:27 +00003193 ActionList CollapsedOffloadActions;
3194
Mehdi Amini6683e222017-01-24 18:12:25 +00003195 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
3196 embedBitcodeInObject() && !isUsingLTO());
Samuel Antao9c9d9cd2016-10-27 16:29:20 +00003197 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
3198
Rafael Espindola79764462013-03-24 15:06:53 +00003199 if (!T)
Justin Lebar9eaa4892016-01-11 23:09:32 +00003200 return InputInfo();
Daniel Dunbare75d8342009-03-16 06:56:51 +00003201
Samuel Antaod06239d2016-07-15 23:13:27 +00003202 // If we've collapsed action list that contained OffloadAction we
3203 // need to build jobs for host/device-side inputs it may have held.
3204 for (const auto *OA : CollapsedOffloadActions)
3205 cast<OffloadAction>(OA)->doOnEachDependence(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003206 /*IsHostDependence=*/BuildingForOffloadDevice,
Samuel Antaod06239d2016-07-15 23:13:27 +00003207 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3208 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
Artem Belevichbee2f412016-08-22 18:50:34 +00003209 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
Samuel Antaod06239d2016-07-15 23:13:27 +00003210 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003211 DepA->getOffloadingDeviceKind()));
Samuel Antaod06239d2016-07-15 23:13:27 +00003212 });
Artem Belevichf8144ab2015-08-27 18:10:41 +00003213
Daniel Dunbare75d8342009-03-16 06:56:51 +00003214 // Only use pipes when there is exactly one input.
Daniel Dunbar1a093d22009-03-18 06:00:36 +00003215 InputInfoList InputInfos;
Saleem Abdulrasoolda3f4e52014-12-29 21:02:47 +00003216 for (const Action *Input : *Inputs) {
Eric Christopher14668dd2013-02-18 00:38:25 +00003217 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
3218 // shouldn't get temporary output names.
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003219 // FIXME: Clean this up.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003220 bool SubJobAtTopLevel =
3221 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
Samuel Antaod06239d2016-07-15 23:13:27 +00003222 InputInfos.push_back(BuildJobsForAction(
3223 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003224 CachedResults, A->getOffloadingDeviceKind()));
Daniel Dunbare75d8342009-03-16 06:56:51 +00003225 }
3226
Daniel Dunbare75d8342009-03-16 06:56:51 +00003227 // Always use the first input as the base input.
3228 const char *BaseInput = InputInfos[0].getBaseInput();
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003229
Daniel Dunbar6beaf512010-06-04 18:28:41 +00003230 // ... except dsymutil actions, which use their actual input as the base
3231 // input.
3232 if (JA->getType() == types::TY_dSYM)
3233 BaseInput = InputInfos[0].getFilename();
3234
Samuel Antaod06239d2016-07-15 23:13:27 +00003235 // Append outputs of offload device jobs to the input list
3236 if (!OffloadDependencesInputInfo.empty())
3237 InputInfos.append(OffloadDependencesInputInfo.begin(),
3238 OffloadDependencesInputInfo.end());
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003239
Vedant Kumar18286cf2016-07-27 23:02:20 +00003240 // Set the effective triple of the toolchain for the duration of this job.
3241 llvm::Triple EffectiveTriple;
3242 const ToolChain &ToolTC = T->getToolChain();
Samuel Antao31fef982016-10-27 17:39:44 +00003243 const ArgList &Args =
3244 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
Vedant Kumar18286cf2016-07-27 23:02:20 +00003245 if (InputInfos.size() != 1) {
3246 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
3247 } else {
3248 // Pass along the input type if it can be unambiguously determined.
3249 EffectiveTriple = llvm::Triple(
3250 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
3251 }
3252 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
3253
Daniel Dunbard00272f2010-08-02 02:38:15 +00003254 // Determine the place to write output to, if any.
Justin Lebar9eaa4892016-01-11 23:09:32 +00003255 InputInfo Result;
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003256 InputInfoList UnbundlingResults;
3257 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
3258 // If we have an unbundling job, we need to create results for all the
3259 // outputs. We also update the results cache so that other actions using
3260 // this unbundling action can get the right results.
3261 for (auto &UI : UA->getDependentActionsInfo()) {
3262 assert(UI.DependentOffloadKind != Action::OFK_None &&
3263 "Unbundling with no offloading??");
3264
3265 // Unbundling actions are never at the top level. When we generate the
3266 // offloading prefix, we also do that for the host file because the
3267 // unbundling action does not change the type of the output which can
3268 // cause a overwrite.
3269 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3270 UI.DependentOffloadKind,
3271 UI.DependentToolChain->getTriple().normalize(),
3272 /*CreatePrefixForHost=*/true);
3273 auto CurI = InputInfo(
3274 UA, GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
3275 /*AtTopLevel=*/false, MultipleArchs,
3276 OffloadingPrefix),
3277 BaseInput);
3278 // Save the unbundling result.
3279 UnbundlingResults.push_back(CurI);
3280
3281 // Get the unique string identifier for this dependence and cache the
3282 // result.
3283 CachedResults[{A, GetTriplePlusArchString(
3284 UI.DependentToolChain, UI.DependentBoundArch,
3285 UI.DependentOffloadKind)}] = CurI;
3286 }
3287
3288 // Now that we have all the results generated, select the one that should be
3289 // returned for the current depending action.
3290 std::pair<const Action *, std::string> ActionTC = {
3291 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
3292 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
3293 "Result does not exist??");
3294 Result = CachedResults[ActionTC];
3295 } else if (JA->getType() == types::TY_Nothing)
Justin Lebard98cea82016-01-11 23:15:21 +00003296 Result = InputInfo(A, BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003297 else {
3298 // We only have to generate a prefix for the host if this is not a top-level
3299 // action.
3300 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3301 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
3302 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
3303 !AtTopLevel);
Justin Lebard98cea82016-01-11 23:15:21 +00003304 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
Samuel Antaod06239d2016-07-15 23:13:27 +00003305 AtTopLevel, MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003306 OffloadingPrefix),
Justin Lebard98cea82016-01-11 23:15:21 +00003307 BaseInput);
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003308 }
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003309
Chad Rosierbe10f982011-08-02 17:58:04 +00003310 if (CCCPrintBindings && !CCGenDiagnostics) {
Rafael Espindola79764462013-03-24 15:06:53 +00003311 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
3312 << " - \"" << T->getName() << "\", inputs: [";
Daniel Dunbarb39cc522009-03-17 22:47:06 +00003313 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
3314 llvm::errs() << InputInfos[i].getAsString();
3315 if (i + 1 != e)
3316 llvm::errs() << ", ";
3317 }
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003318 if (UnbundlingResults.empty())
3319 llvm::errs() << "], output: " << Result.getAsString() << "\n";
3320 else {
3321 llvm::errs() << "], outputs: [";
3322 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
3323 llvm::errs() << UnbundlingResults[i].getAsString();
3324 if (i + 1 != e)
3325 llvm::errs() << ", ";
3326 }
3327 llvm::errs() << "] \n";
3328 }
Daniel Dunbarb39cc522009-03-17 22:47:06 +00003329 } else {
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003330 if (UnbundlingResults.empty())
3331 T->ConstructJob(
3332 C, *JA, Result, InputInfos,
3333 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3334 LinkingOutput);
3335 else
Samuel Antao7108bf32016-11-03 15:41:50 +00003336 T->ConstructJobMultipleOutputs(
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003337 C, *JA, UnbundlingResults, InputInfos,
3338 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3339 LinkingOutput);
Daniel Dunbarb39cc522009-03-17 22:47:06 +00003340 }
Justin Lebar9eaa4892016-01-11 23:09:32 +00003341 return Result;
Daniel Dunbare75d8342009-03-16 06:56:51 +00003342}
3343
Hans Wennborga7707222015-01-09 17:38:53 +00003344const char *Driver::getDefaultImageName() const {
3345 llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
3346 return Target.isOSWindows() ? "a.exe" : "a.out";
3347}
3348
Hans Wennborg2c21f742013-10-17 16:16:23 +00003349/// \brief Create output filename based on ArgValue, which could either be a
3350/// full filename, filename without extension, or a directory. If ArgValue
3351/// does not provide a filename, then use BaseName, and use the extension
3352/// suitable for FileType.
Hans Wennborg207fcf02013-08-12 21:56:42 +00003353static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003354 StringRef BaseName,
3355 types::ID FileType) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00003356 SmallString<128> Filename = ArgValue;
Justin Bogner5aaf2e72014-06-26 20:59:36 +00003357
Hans Wennborgf1a74252013-09-10 20:18:04 +00003358 if (ArgValue.empty()) {
3359 // If the argument is empty, output to BaseName in the current dir.
3360 Filename = BaseName;
3361 } else if (llvm::sys::path::is_separator(Filename.back())) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00003362 // If the argument is a directory, output to BaseName in that dir.
3363 llvm::sys::path::append(Filename, BaseName);
3364 }
3365
3366 if (!llvm::sys::path::has_extension(ArgValue)) {
3367 // If the argument didn't provide an extension, then set it.
3368 const char *Extension = types::getTypeTempSuffix(FileType, true);
Hans Wennborgf1a74252013-09-10 20:18:04 +00003369
3370 if (FileType == types::TY_Image &&
3371 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
3372 // The output file is a dll.
3373 Extension = "dll";
3374 }
3375
Hans Wennborg207fcf02013-08-12 21:56:42 +00003376 llvm::sys::path::replace_extension(Filename, Extension);
3377 }
3378
3379 return Args.MakeArgString(Filename.c_str());
3380}
3381
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003382const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003383 const char *BaseInput,
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003384 StringRef BoundArch, bool AtTopLevel,
Samuel Antaod06239d2016-07-15 23:13:27 +00003385 bool MultipleArchs,
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003386 StringRef OffloadingPrefix) const {
Daniel Dunbar2608c542009-03-18 01:38:48 +00003387 llvm::PrettyStackTraceString CrashInfo("Computing output path");
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003388 // Output to a user requested destination?
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003389 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003390 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
Chad Rosier633dcdc2013-01-24 19:14:47 +00003391 return C.addResultFile(FinalOutput->getValue(), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003392 }
3393
Hans Wennborge0053472013-12-20 18:40:46 +00003394 // For /P, preprocess to file named after BaseInput.
3395 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
3396 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
3397 StringRef BaseName = llvm::sys::path::filename(BaseInput);
Hans Wennborg04c764f2014-06-17 00:19:12 +00003398 StringRef NameArg;
Greg Bedwell065f70a2015-06-09 10:24:06 +00003399 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
Hans Wennborg04c764f2014-06-17 00:19:12 +00003400 NameArg = A->getValue();
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003401 return C.addResultFile(
3402 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
3403 &JA);
Hans Wennborge0053472013-12-20 18:40:46 +00003404 }
3405
Nick Lewycky6e1ce292010-09-24 00:46:53 +00003406 // Default to writing to stdout?
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +00003407 if (AtTopLevel && !CCGenDiagnostics &&
3408 (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile))
Nick Lewycky6e1ce292010-09-24 00:46:53 +00003409 return "-";
3410
Hans Wennborg2c21f742013-10-17 16:16:23 +00003411 // Is this the assembly listing for /FA?
3412 if (JA.getType() == types::TY_PP_Asm &&
3413 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
3414 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
3415 // Use /Fa and the input filename to determine the asm file name.
3416 StringRef BaseName = llvm::sys::path::filename(BaseInput);
3417 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003418 return C.addResultFile(
3419 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
3420 &JA);
Hans Wennborg2c21f742013-10-17 16:16:23 +00003421 }
3422
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003423 // Output to a temporary file?
Reid Kleckner68eb60b2015-02-02 22:41:48 +00003424 if ((!AtTopLevel && !isSaveTempsEnabled() &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003425 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
Chad Rosierbe10f982011-08-02 17:58:04 +00003426 CCGenDiagnostics) {
Chad Rosier97c37372011-08-26 22:27:02 +00003427 StringRef Name = llvm::sys::path::filename(BaseInput);
3428 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003429 std::string TmpName = GetTemporaryPath(
3430 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00003431 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003432 }
3433
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003434 SmallString<128> BasePath(BaseInput);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003435 StringRef BaseName;
Daniel Dunbar67fea712011-03-25 18:16:51 +00003436
3437 // Dsymutil actions should use the full path.
Eric Christopher551ef452011-08-23 17:56:55 +00003438 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
Daniel Dunbar67fea712011-03-25 18:16:51 +00003439 BaseName = BasePath;
3440 else
3441 BaseName = llvm::sys::path::filename(BasePath);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003442
3443 // Determine what the derived output name should be.
3444 const char *NamedOutput;
Hans Wennborg2b89a262013-08-06 22:11:28 +00003445
Hans Wennborg625fba82016-10-04 21:01:04 +00003446 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00003447 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
3448 // The /Fo or /o flag decides the object filename.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003449 StringRef Val =
3450 C.getArgs()
3451 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
3452 ->getValue();
3453 NamedOutput =
3454 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
Hans Wennborg207fcf02013-08-12 21:56:42 +00003455 } else if (JA.getType() == types::TY_Image &&
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003456 C.getArgs().hasArg(options::OPT__SLASH_Fe,
3457 options::OPT__SLASH_o)) {
Ehsan Akhgari81f36b72014-09-11 18:16:21 +00003458 // The /Fe or /o flag names the linked file.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003459 StringRef Val =
3460 C.getArgs()
3461 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
3462 ->getValue();
3463 NamedOutput =
3464 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
Hans Wennborgf1a74252013-09-10 20:18:04 +00003465 } else if (JA.getType() == types::TY_Image) {
Hans Wennborg207fcf02013-08-12 21:56:42 +00003466 if (IsCLMode()) {
3467 // clang-cl uses BaseName for the executable name.
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003468 NamedOutput =
3469 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
Samuel Antao59efaed2016-10-27 17:31:22 +00003470 } else {
Hans Wennborga7707222015-01-09 17:38:53 +00003471 SmallString<128> Output(getDefaultImageName());
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003472 Output += OffloadingPrefix;
Samuel Antao59efaed2016-10-27 17:31:22 +00003473 if (MultipleArchs && !BoundArch.empty()) {
3474 Output += "-";
3475 Output.append(BoundArch);
3476 }
Chad Rosier35767232013-04-30 22:01:21 +00003477 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
Nico Weber2ca4be92016-03-01 23:16:44 +00003478 }
3479 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00003480 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003481 } else {
Hans Wennborg0a096a02013-09-05 17:05:56 +00003482 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003483 assert(Suffix && "All types used for output should have a suffix.");
3484
3485 std::string::size_type End = std::string::npos;
3486 if (!types::appendSuffixForType(JA.getType()))
3487 End = BaseName.rfind('.');
Chad Rosier35767232013-04-30 22:01:21 +00003488 SmallString<128> Suffixed(BaseName.substr(0, End));
Samuel Antao3b7e38b2016-10-27 18:14:55 +00003489 Suffixed += OffloadingPrefix;
Mehdi Aminic50b1a22016-10-07 21:27:26 +00003490 if (MultipleArchs && !BoundArch.empty()) {
Chad Rosier35767232013-04-30 22:01:21 +00003491 Suffixed += "-";
3492 Suffixed.append(BoundArch);
3493 }
Bob Wilson23a55f12014-12-21 07:00:00 +00003494 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
3495 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
3496 // optimized bitcode output.
3497 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
3498 JA.getType() == types::TY_LLVM_BC)
3499 Suffixed += ".tmp";
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003500 Suffixed += '.';
3501 Suffixed += Suffix;
3502 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
3503 }
3504
Reid Kleckner68eb60b2015-02-02 22:41:48 +00003505 // Prepend object file path if -save-temps=obj
3506 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
3507 JA.getType() != types::TY_PCH) {
3508 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3509 SmallString<128> TempPath(FinalOutput->getValue());
3510 llvm::sys::path::remove_filename(TempPath);
3511 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
3512 llvm::sys::path::append(TempPath, OutputFileName);
3513 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
3514 }
3515
Chad Rosier62135492012-07-09 17:31:28 +00003516 // If we're saving temps and the temp file conflicts with the input file,
Chad Rosier5b58af02012-04-20 20:05:08 +00003517 // then avoid overwriting input file.
Reid Kleckner68eb60b2015-02-02 22:41:48 +00003518 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
Chad Rosier5b58af02012-04-20 20:05:08 +00003519 bool SameFile = false;
3520 SmallString<256> Result;
3521 llvm::sys::fs::current_path(Result);
3522 llvm::sys::path::append(Result, BaseName);
3523 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
3524 // Must share the same path to conflict.
3525 if (SameFile) {
3526 StringRef Name = llvm::sys::path::filename(BaseInput);
3527 std::pair<StringRef, StringRef> Split = Name.split('.');
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003528 std::string TmpName = GetTemporaryPath(
3529 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00003530 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
Chad Rosier5b58af02012-04-20 20:05:08 +00003531 }
Chad Rosierf8412cd2011-07-15 21:54:29 +00003532 }
3533
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003534 // As an annoying special case, PCH generation doesn't strip the pathname.
Nico Weber8ab92192016-03-02 23:29:29 +00003535 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
Michael J. Spencere1696752010-12-18 00:19:12 +00003536 llvm::sys::path::remove_filename(BasePath);
3537 if (BasePath.empty())
Daniel Dunbare6c83192009-03-18 09:58:30 +00003538 BasePath = NamedOutput;
3539 else
Michael J. Spencere1696752010-12-18 00:19:12 +00003540 llvm::sys::path::append(BasePath, NamedOutput);
Chad Rosier633dcdc2013-01-24 19:14:47 +00003541 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003542 } else {
Chad Rosier633dcdc2013-01-24 19:14:47 +00003543 return C.addResultFile(NamedOutput, &JA);
Daniel Dunbar7a178a42009-03-17 17:53:55 +00003544 }
3545}
3546
Mehdi Amini12011172016-10-06 05:11:48 +00003547std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
Chandler Carruth84559242010-03-22 01:52:07 +00003548 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00003549 // attempting to use this prefix when looking for file paths.
Douglas Katzman26eabf62015-06-24 15:10:30 +00003550 for (const std::string &Dir : PrefixDirs) {
Joerg Sonnenberger6165ab12011-03-21 13:51:29 +00003551 if (Dir.empty())
3552 continue;
Douglas Katzman26eabf62015-06-24 15:10:30 +00003553 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
Rafael Espindola609a6642013-06-24 18:33:43 +00003554 llvm::sys::path::append(P, Name);
3555 if (llvm::sys::fs::exists(Twine(P)))
Chandler Carruth84559242010-03-22 01:52:07 +00003556 return P.str();
3557 }
3558
Rafael Espindola609a6642013-06-24 18:33:43 +00003559 SmallString<128> P(ResourceDir);
3560 llvm::sys::path::append(P, Name);
3561 if (llvm::sys::fs::exists(Twine(P)))
Peter Collingbournefa9771f2011-09-06 02:08:31 +00003562 return P.str();
3563
Douglas Katzman26eabf62015-06-24 15:10:30 +00003564 for (const std::string &Dir : TC.getFilePaths()) {
Joerg Sonnenberger6165ab12011-03-21 13:51:29 +00003565 if (Dir.empty())
3566 continue;
Douglas Katzman26eabf62015-06-24 15:10:30 +00003567 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
Rafael Espindola609a6642013-06-24 18:33:43 +00003568 llvm::sys::path::append(P, Name);
3569 if (llvm::sys::fs::exists(Twine(P)))
Daniel Dunbar1ce81532009-09-09 22:33:00 +00003570 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00003571 }
3572
Daniel Dunbar1ce81532009-09-09 22:33:00 +00003573 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00003574}
3575
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003576void Driver::generatePrefixedToolNames(
Mehdi Amini12011172016-10-06 05:11:48 +00003577 StringRef Tool, const ToolChain &TC,
Douglas Katzmana67e50c2015-06-26 15:47:46 +00003578 SmallVectorImpl<std::string> &Names) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00003579 // FIXME: Needs a better variable than DefaultTargetTriple
Mehdi Amini12011172016-10-06 05:11:48 +00003580 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
Benjamin Kramer3204b152015-05-29 19:42:19 +00003581 Names.emplace_back(Tool);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00003582
3583 // Allow the discovery of tools prefixed with LLVM's default target triple.
3584 std::string LLVMDefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
3585 if (LLVMDefaultTargetTriple != DefaultTargetTriple)
Mehdi Amini12011172016-10-06 05:11:48 +00003586 Names.emplace_back((LLVMDefaultTargetTriple + "-" + Tool).str());
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00003587}
3588
Benjamin Kramer7111b912014-11-04 20:26:01 +00003589static bool ScanDirForExecutable(SmallString<128> &Dir,
3590 ArrayRef<std::string> Names) {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00003591 for (const auto &Name : Names) {
3592 llvm::sys::path::append(Dir, Name);
3593 if (llvm::sys::fs::can_execute(Twine(Dir)))
3594 return true;
3595 llvm::sys::path::remove_filename(Dir);
3596 }
3597 return false;
3598}
3599
Mehdi Amini12011172016-10-06 05:11:48 +00003600std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00003601 SmallVector<std::string, 2> TargetSpecificExecutables;
3602 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
3603
Chandler Carruth84559242010-03-22 01:52:07 +00003604 // Respect a limited subset of the '-Bprefix' functionality in GCC by
Logan Chiencd679fd2012-10-04 08:08:56 +00003605 // attempting to use this prefix when looking for program paths.
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00003606 for (const auto &PrefixDir : PrefixDirs) {
3607 if (llvm::sys::fs::is_directory(PrefixDir)) {
3608 SmallString<128> P(PrefixDir);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00003609 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00003610 return P.str();
Simon Atanasyana47ba292012-10-31 14:39:28 +00003611 } else {
Mehdi Amini12011172016-10-06 05:11:48 +00003612 SmallString<128> P((PrefixDir + Name).str());
Rafael Espindola609a6642013-06-24 18:33:43 +00003613 if (llvm::sys::fs::can_execute(Twine(P)))
Rafael Espindola8be5c052013-06-19 13:24:29 +00003614 return P.str();
Simon Atanasyan86bdab72012-10-31 12:01:53 +00003615 }
Chandler Carruth84559242010-03-22 01:52:07 +00003616 }
3617
Daniel Dunbar68b01a02009-03-18 20:26:19 +00003618 const ToolChain::path_list &List = TC.getProgramPaths();
Saleem Abdulrasool23d99b12014-09-16 03:48:32 +00003619 for (const auto &Path : List) {
3620 SmallString<128> P(Path);
Saleem Abdulrasoolf0ba6ce2014-10-25 23:33:21 +00003621 if (ScanDirForExecutable(P, TargetSpecificExecutables))
Rafael Espindola8be5c052013-06-19 13:24:29 +00003622 return P.str();
Daniel Dunbar68b01a02009-03-18 20:26:19 +00003623 }
3624
Daniel Dunbar76ce7412009-03-23 16:15:50 +00003625 // If all else failed, search the path.
Michael J. Spencerb011d482014-11-07 21:30:32 +00003626 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
3627 if (llvm::ErrorOr<std::string> P =
3628 llvm::sys::findProgramByName(TargetSpecificExecutable))
Michael J. Spencer04162ea2014-11-04 01:30:55 +00003629 return *P;
Daniel Dunbar6f668772009-03-18 21:34:08 +00003630
Daniel Dunbar1ce81532009-09-09 22:33:00 +00003631 return Name;
Daniel Dunbar5e0f6af2009-03-13 00:51:18 +00003632}
3633
Mehdi Amini12011172016-10-06 05:11:48 +00003634std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
Rafael Espindola37d229d2013-06-25 04:26:55 +00003635 SmallString<128> Path;
Rafael Espindolac0809172014-06-12 14:02:15 +00003636 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
Rafael Espindola37d229d2013-06-25 04:26:55 +00003637 if (EC) {
3638 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00003639 return "";
3640 }
3641
Rafael Espindola37d229d2013-06-25 04:26:55 +00003642 return Path.str();
Daniel Dunbare627c1c2009-03-18 19:34:39 +00003643}
3644
Nico Weber2ca4be92016-03-01 23:16:44 +00003645std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
3646 SmallString<128> Output;
3647 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
3648 // FIXME: If anybody needs it, implement this obscure rule:
3649 // "If you specify a directory without a file name, the default file name
3650 // is VCx0.pch., where x is the major version of Visual C++ in use."
3651 Output = FpArg->getValue();
3652
3653 // "If you do not specify an extension as part of the path name, an
3654 // extension of .pch is assumed. "
3655 if (!llvm::sys::path::has_extension(Output))
3656 Output += ".pch";
3657 } else {
3658 Output = BaseName;
3659 llvm::sys::path::replace_extension(Output, ".pch");
3660 }
3661 return Output.str();
3662}
3663
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003664const ToolChain &Driver::getToolChain(const ArgList &Args,
Artem Belevich959e0542015-07-10 19:47:55 +00003665 const llvm::Triple &Target) const {
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003666
David Blaikie6ad71012017-01-13 18:53:43 +00003667 auto &TC = ToolChains[Target.str()];
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003668 if (!TC) {
3669 switch (Target.getOS()) {
Reid Kleckner330fb172016-05-11 16:19:05 +00003670 case llvm::Triple::Haiku:
David Blaikie6ad71012017-01-13 18:53:43 +00003671 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
Reid Kleckner330fb172016-05-11 16:19:05 +00003672 break;
Ed Schouten3c3e58c2015-03-26 11:13:44 +00003673 case llvm::Triple::CloudABI:
David Blaikie6ad71012017-01-13 18:53:43 +00003674 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
Ed Schouten3c3e58c2015-03-26 11:13:44 +00003675 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003676 case llvm::Triple::Darwin:
3677 case llvm::Triple::MacOSX:
3678 case llvm::Triple::IOS:
Tim Northover6f3ff222015-10-30 16:30:27 +00003679 case llvm::Triple::TvOS:
3680 case llvm::Triple::WatchOS:
David Blaikie6ad71012017-01-13 18:53:43 +00003681 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003682 break;
3683 case llvm::Triple::DragonFly:
David Blaikie6ad71012017-01-13 18:53:43 +00003684 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003685 break;
3686 case llvm::Triple::OpenBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00003687 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003688 break;
Eli Friedman9fa28852012-08-08 23:57:20 +00003689 case llvm::Triple::Bitrig:
David Blaikie6ad71012017-01-13 18:53:43 +00003690 TC = llvm::make_unique<toolchains::Bitrig>(*this, Target, Args);
Eli Friedman9fa28852012-08-08 23:57:20 +00003691 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003692 case llvm::Triple::NetBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00003693 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003694 break;
3695 case llvm::Triple::FreeBSD:
David Blaikie6ad71012017-01-13 18:53:43 +00003696 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003697 break;
3698 case llvm::Triple::Minix:
David Blaikie6ad71012017-01-13 18:53:43 +00003699 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003700 break;
3701 case llvm::Triple::Linux:
Andrey Turetskiy4798eb62016-06-16 10:36:09 +00003702 case llvm::Triple::ELFIAMCU:
Chandler Carruthcf705b22012-01-25 21:03:58 +00003703 if (Target.getArch() == llvm::Triple::hexagon)
David Blaikie6ad71012017-01-13 18:53:43 +00003704 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
3705 Args);
Vasileios Kalintirisc744e122015-11-12 15:26:54 +00003706 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
3707 !Target.hasEnvironment())
David Blaikie6ad71012017-01-13 18:53:43 +00003708 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
3709 Args);
Chandler Carruthcf705b22012-01-25 21:03:58 +00003710 else
David Blaikie6ad71012017-01-13 18:53:43 +00003711 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003712 break;
Derek Schuff6ab52fa2015-03-30 20:31:33 +00003713 case llvm::Triple::NaCl:
David Blaikie6ad71012017-01-13 18:53:43 +00003714 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
Derek Schuff6ab52fa2015-03-30 20:31:33 +00003715 break;
Petr Hosek62e1d232016-10-06 06:08:09 +00003716 case llvm::Triple::Fuchsia:
David Blaikie6ad71012017-01-13 18:53:43 +00003717 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
Petr Hosek62e1d232016-10-06 06:08:09 +00003718 break;
David Chisnallf571cde2012-02-15 13:39:01 +00003719 case llvm::Triple::Solaris:
David Blaikie6ad71012017-01-13 18:53:43 +00003720 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
David Chisnallf571cde2012-02-15 13:39:01 +00003721 break;
Tom Stellard8fa33092015-07-18 01:49:05 +00003722 case llvm::Triple::AMDHSA:
David Blaikie6ad71012017-01-13 18:53:43 +00003723 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
Tom Stellard8fa33092015-07-18 01:49:05 +00003724 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003725 case llvm::Triple::Win32:
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003726 switch (Target.getEnvironment()) {
3727 default:
3728 if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00003729 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003730 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00003731 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003732 else
David Blaikie6ad71012017-01-13 18:53:43 +00003733 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003734 break;
3735 case llvm::Triple::GNU:
David Blaikie6ad71012017-01-13 18:53:43 +00003736 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003737 break;
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00003738 case llvm::Triple::Itanium:
David Blaikie6ad71012017-01-13 18:53:43 +00003739 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
3740 Args);
Saleem Abdulrasool543a78b2014-10-24 03:13:37 +00003741 break;
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003742 case llvm::Triple::MSVC:
3743 case llvm::Triple::UnknownEnvironment:
David Blaikie6ad71012017-01-13 18:53:43 +00003744 TC = llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
Saleem Abdulrasool377066a2014-03-27 22:50:18 +00003745 break;
3746 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003747 break;
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00003748 case llvm::Triple::PS4:
David Blaikie6ad71012017-01-13 18:53:43 +00003749 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
Filipe Cabecinhasc888e192015-10-14 12:25:43 +00003750 break;
David L Kreitzerd397ea42016-10-14 20:44:33 +00003751 case llvm::Triple::Contiki:
David Blaikie6ad71012017-01-13 18:53:43 +00003752 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
David L Kreitzerd397ea42016-10-14 20:44:33 +00003753 break;
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003754 default:
Douglas Katzman9f5e70e2015-05-26 18:01:33 +00003755 // Of these targets, Hexagon is the only one that might have
3756 // an OS of Linux, in which case it got handled above already.
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003757 switch (Target.getArch()) {
3758 case llvm::Triple::tce:
David Blaikie6ad71012017-01-13 18:53:43 +00003759 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003760 break;
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00003761 case llvm::Triple::tcele:
David Blaikie6ad71012017-01-13 18:53:43 +00003762 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
Pekka Jaaskelainen67354482016-11-16 15:22:31 +00003763 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003764 case llvm::Triple::hexagon:
David Blaikie6ad71012017-01-13 18:53:43 +00003765 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
3766 Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003767 break;
Jacques Pienaard964cc22016-03-28 21:02:54 +00003768 case llvm::Triple::lanai:
David Blaikie6ad71012017-01-13 18:53:43 +00003769 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
Jacques Pienaard964cc22016-03-28 21:02:54 +00003770 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003771 case llvm::Triple::xcore:
David Blaikie6ad71012017-01-13 18:53:43 +00003772 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003773 break;
Dan Gohmanc2853072015-09-03 22:51:53 +00003774 case llvm::Triple::wasm32:
3775 case llvm::Triple::wasm64:
David Blaikie6ad71012017-01-13 18:53:43 +00003776 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
Dan Gohmanc2853072015-09-03 22:51:53 +00003777 break;
Dylan McKay924fa3a2017-01-05 05:20:27 +00003778 case llvm::Triple::avr:
David Blaikie6ad71012017-01-13 18:53:43 +00003779 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
Dylan McKay924fa3a2017-01-05 05:20:27 +00003780 break;
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003781 default:
Douglas Katzmand6e597c2015-09-17 19:56:40 +00003782 if (Target.getVendor() == llvm::Triple::Myriad)
David Blaikie6ad71012017-01-13 18:53:43 +00003783 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
3784 Args);
Douglas Katzmand6e597c2015-09-17 19:56:40 +00003785 else if (Target.isOSBinFormatELF())
David Blaikie6ad71012017-01-13 18:53:43 +00003786 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003787 else if (Target.isOSBinFormatMachO())
David Blaikie6ad71012017-01-13 18:53:43 +00003788 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003789 else
David Blaikie6ad71012017-01-13 18:53:43 +00003790 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
Douglas Katzman15a63ed2015-08-12 18:36:12 +00003791 }
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003792 }
3793 }
Justin Lebar66c4fd72016-11-18 00:41:22 +00003794
3795 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
3796 // compiles always need two toolchains, the CUDA toolchain and the host
3797 // toolchain. So the only valid way to create a CUDA toolchain is via
3798 // CreateOffloadingDeviceToolChains.
3799
Chandler Carruth2ad5de12012-01-25 11:01:57 +00003800 return *TC;
Daniel Dunbar4dff6a42009-03-10 23:41:59 +00003801}
Daniel Dunbar8fa879d2009-03-24 18:57:02 +00003802
Rafael Espindola2f69d402013-03-18 15:33:26 +00003803bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
Douglas Katzman00249092015-06-12 15:45:21 +00003804 // Say "no" if there is not exactly one input of a type clang understands.
Nico Weber5a459f82016-02-23 19:30:43 +00003805 if (JA.size() != 1 ||
3806 !types::isAcceptedByClang((*JA.input_begin())->getType()))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00003807 return false;
3808
Douglas Katzman00249092015-06-12 15:45:21 +00003809 // And say "no" if this is not a kind of action clang understands.
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00003810 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
Bob Wilson23a55f12014-12-21 07:00:00 +00003811 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
Nick Lewycky5cc9ebb2012-11-15 05:36:36 +00003812 return false;
3813
3814 return true;
3815}
3816
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003817/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
3818/// grouped values as integers. Numbers which are not provided are set to 0.
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003819///
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003820/// \return True if the entire string was parsed (9.2), or all groups were
3821/// parsed (10.3.5extrastuff).
Mehdi Amini12011172016-10-06 05:11:48 +00003822bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
3823 unsigned &Micro, bool &HadExtra) {
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003824 HadExtra = false;
3825
3826 Major = Minor = Micro = 0;
Mehdi Amini12011172016-10-06 05:11:48 +00003827 if (Str.empty())
Bob Wilson433cb312015-04-07 01:03:35 +00003828 return false;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003829
Mehdi Amini12011172016-10-06 05:11:48 +00003830 if (Str.consumeInteger(10, Major))
3831 return false;
3832 if (Str.empty())
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003833 return true;
Mehdi Amini12011172016-10-06 05:11:48 +00003834 if (Str[0] != '.')
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003835 return false;
Daniel Dunbarf26a7ab2009-09-08 23:36:43 +00003836
Mehdi Amini12011172016-10-06 05:11:48 +00003837 Str = Str.drop_front(1);
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003838
Mehdi Amini12011172016-10-06 05:11:48 +00003839 if (Str.consumeInteger(10, Minor))
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003840 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00003841 if (Str.empty())
3842 return true;
3843 if (Str[0] != '.')
3844 return false;
3845 Str = Str.drop_front(1);
3846
3847 if (Str.consumeInteger(10, Micro))
3848 return false;
3849 if (!Str.empty())
3850 HadExtra = true;
Daniel Dunbarc7fd57a2009-03-26 15:58:36 +00003851 return true;
3852}
Hans Wennborg6ddc6902013-07-27 00:23:45 +00003853
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00003854/// Parse digits from a string \p Str and fulfill \p Digits with
3855/// the parsed numbers. This method assumes that the max number of
3856/// digits to look for is equal to Digits.size().
3857///
3858/// \return True if the entire string was parsed and there are
3859/// no extra characters remaining at the end.
Mehdi Amini12011172016-10-06 05:11:48 +00003860bool Driver::GetReleaseVersion(StringRef Str,
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00003861 MutableArrayRef<unsigned> Digits) {
Mehdi Amini12011172016-10-06 05:11:48 +00003862 if (Str.empty())
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00003863 return false;
3864
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00003865 unsigned CurDigit = 0;
3866 while (CurDigit < Digits.size()) {
Mehdi Amini12011172016-10-06 05:11:48 +00003867 unsigned Digit;
3868 if (Str.consumeInteger(10, Digit))
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00003869 return false;
Mehdi Amini12011172016-10-06 05:11:48 +00003870 Digits[CurDigit] = Digit;
3871 if (Str.empty())
3872 return true;
3873 if (Str[0] != '.')
3874 return false;
3875 Str = Str.drop_front(1);
Bruno Cardoso Lopes8ed5cac2016-03-31 02:45:46 +00003876 CurDigit++;
3877 }
3878
3879 // More digits than requested, bail out...
3880 return false;
3881}
3882
Hans Wennborg6ddc6902013-07-27 00:23:45 +00003883std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
3884 unsigned IncludedFlagsBitmask = 0;
Rafael Espindolacc707bc2013-09-25 15:54:41 +00003885 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00003886
3887 if (Mode == CLMode) {
Hans Wennborg19076102013-07-31 20:51:53 +00003888 // Include CL and Core options.
3889 IncludedFlagsBitmask |= options::CLOption;
3890 IncludedFlagsBitmask |= options::CoreOption;
Hans Wennborg6ddc6902013-07-27 00:23:45 +00003891 } else {
3892 ExcludedFlagsBitmask |= options::CLOption;
3893 }
3894
3895 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
3896}
Benjamin Kramerab88f622014-03-25 18:02:07 +00003897
Douglas Katzmanf08fadf2015-06-04 14:40:44 +00003898bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
Benjamin Kramerab88f622014-03-25 18:02:07 +00003899 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
3900}