1 //===--- Driver.cpp - Clang GCC Compatible Driver -------------------------===//
2 //
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 
10 #include "clang/Driver/Driver.h"
11 #include "InputInfo.h"
12 #include "ToolChains.h"
13 #include "clang/Basic/Version.h"
14 #include "clang/Config/config.h"
15 #include "clang/Driver/Action.h"
16 #include "clang/Driver/Compilation.h"
17 #include "clang/Driver/DriverDiagnostic.h"
18 #include "clang/Driver/Job.h"
19 #include "clang/Driver/Options.h"
20 #include "clang/Driver/Tool.h"
21 #include "clang/Driver/ToolChain.h"
22 #include "llvm/ADT/ArrayRef.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/ADT/StringExtras.h"
25 #include "llvm/ADT/StringSet.h"
26 #include "llvm/ADT/StringSwitch.h"
27 #include "llvm/Option/Arg.h"
28 #include "llvm/Option/ArgList.h"
29 #include "llvm/Option/OptSpecifier.h"
30 #include "llvm/Option/OptTable.h"
31 #include "llvm/Option/Option.h"
32 #include "llvm/Support/Debug.h"
33 #include "llvm/Support/ErrorHandling.h"
34 #include "llvm/Support/FileSystem.h"
35 #include "llvm/Support/Path.h"
36 #include "llvm/Support/PrettyStackTrace.h"
37 #include "llvm/Support/Process.h"
38 #include "llvm/Support/Program.h"
39 #include "llvm/Support/raw_ostream.h"
40 #include <map>
41 #include <memory>
42 
43 using namespace clang::driver;
44 using namespace clang;
45 using namespace llvm::opt;
46 
47 Driver::Driver(StringRef ClangExecutable,
48                StringRef DefaultTargetTriple,
49                DiagnosticsEngine &Diags)
50   : Opts(createDriverOptTable()), Diags(Diags), Mode(GCCMode),
51     ClangExecutable(ClangExecutable), SysRoot(DEFAULT_SYSROOT),
52     UseStdLib(true), DefaultTargetTriple(DefaultTargetTriple),
53     DefaultImageName("a.out"),
54     DriverTitle("clang LLVM compiler"),
55     CCPrintOptionsFilename(nullptr), CCPrintHeadersFilename(nullptr),
56     CCLogDiagnosticsFilename(nullptr),
57     CCCPrintBindings(false),
58     CCPrintHeaders(false), CCLogDiagnostics(false),
59     CCGenDiagnostics(false), CCCGenericGCCName(""), CheckInputsExist(true),
60     CCCUsePCH(true), SuppressMissingInputWarning(false) {
61 
62   Name = llvm::sys::path::stem(ClangExecutable);
63   Dir  = llvm::sys::path::parent_path(ClangExecutable);
64 
65   // Compute the path to the resource directory.
66   StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
67   SmallString<128> P(Dir);
68   if (ClangResourceDir != "")
69     llvm::sys::path::append(P, ClangResourceDir);
70   else
71     llvm::sys::path::append(P, "..", "lib", "clang", CLANG_VERSION_STRING);
72   ResourceDir = P.str();
73 }
74 
75 Driver::~Driver() {
76   delete Opts;
77 
78   llvm::DeleteContainerSeconds(ToolChains);
79 }
80 
81 void Driver::ParseDriverMode(ArrayRef<const char *> Args) {
82   const std::string OptName =
83     getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
84 
85   for (size_t I = 0, E = Args.size(); I != E; ++I) {
86     // Ingore nullptrs, they are response file's EOL markers
87     if (Args[I] == nullptr)
88       continue;
89     const StringRef Arg = Args[I];
90     if (!Arg.startswith(OptName))
91       continue;
92 
93     const StringRef Value = Arg.drop_front(OptName.size());
94     const unsigned M = llvm::StringSwitch<unsigned>(Value)
95         .Case("gcc", GCCMode)
96         .Case("g++", GXXMode)
97         .Case("cpp", CPPMode)
98         .Case("cl",  CLMode)
99         .Default(~0U);
100 
101     if (M != ~0U)
102       Mode = static_cast<DriverMode>(M);
103     else
104       Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
105   }
106 }
107 
108 InputArgList *Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings) {
109   llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
110 
111   unsigned IncludedFlagsBitmask;
112   unsigned ExcludedFlagsBitmask;
113   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
114     getIncludeExcludeOptionFlagMasks();
115 
116   unsigned MissingArgIndex, MissingArgCount;
117   InputArgList *Args = getOpts().ParseArgs(ArgStrings.begin(), ArgStrings.end(),
118                                            MissingArgIndex, MissingArgCount,
119                                            IncludedFlagsBitmask,
120                                            ExcludedFlagsBitmask);
121 
122   // Check for missing argument error.
123   if (MissingArgCount)
124     Diag(clang::diag::err_drv_missing_argument)
125       << Args->getArgString(MissingArgIndex) << MissingArgCount;
126 
127   // Check for unsupported options.
128   for (ArgList::const_iterator it = Args->begin(), ie = Args->end();
129        it != ie; ++it) {
130     Arg *A = *it;
131     if (A->getOption().hasFlag(options::Unsupported)) {
132       Diag(clang::diag::err_drv_unsupported_opt) << A->getAsString(*Args);
133       continue;
134     }
135 
136     // Warn about -mcpu= without an argument.
137     if (A->getOption().matches(options::OPT_mcpu_EQ) &&
138         A->containsValue("")) {
139       Diag(clang::diag::warn_drv_empty_joined_argument) <<
140         A->getAsString(*Args);
141     }
142   }
143 
144   for (arg_iterator it = Args->filtered_begin(options::OPT_UNKNOWN),
145          ie = Args->filtered_end(); it != ie; ++it) {
146     Diags.Report(diag::err_drv_unknown_argument) << (*it) ->getAsString(*Args);
147   }
148 
149   return Args;
150 }
151 
152 // Determine which compilation mode we are in. We look for options which
153 // affect the phase, starting with the earliest phases, and record which
154 // option we used to determine the final phase.
155 phases::ID Driver::getFinalPhase(const DerivedArgList &DAL, Arg **FinalPhaseArg)
156 const {
157   Arg *PhaseArg = nullptr;
158   phases::ID FinalPhase;
159 
160   // -{E,EP,P,M,MM} only run the preprocessor.
161   if (CCCIsCPP() ||
162       (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
163       (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
164       (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
165       (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
166     FinalPhase = phases::Preprocess;
167 
168     // -{fsyntax-only,-analyze,emit-ast,S} only run up to the compiler.
169   } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
170              (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
171              (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
172              (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
173              (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
174              (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
175              (PhaseArg = DAL.getLastArg(options::OPT__analyze,
176                                         options::OPT__analyze_auto)) ||
177              (PhaseArg = DAL.getLastArg(options::OPT_emit_ast)) ||
178              (PhaseArg = DAL.getLastArg(options::OPT_S))) {
179     FinalPhase = phases::Compile;
180 
181     // -c only runs up to the assembler.
182   } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
183     FinalPhase = phases::Assemble;
184 
185     // Otherwise do everything.
186   } else
187     FinalPhase = phases::Link;
188 
189   if (FinalPhaseArg)
190     *FinalPhaseArg = PhaseArg;
191 
192   return FinalPhase;
193 }
194 
195 static Arg* MakeInputArg(DerivedArgList &Args, OptTable *Opts,
196                          StringRef Value) {
197   Arg *A = new Arg(Opts->getOption(options::OPT_INPUT), Value,
198                    Args.getBaseArgs().MakeIndex(Value), Value.data());
199   Args.AddSynthesizedArg(A);
200   A->claim();
201   return A;
202 }
203 
204 DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
205   DerivedArgList *DAL = new DerivedArgList(Args);
206 
207   bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
208   for (ArgList::const_iterator it = Args.begin(),
209          ie = Args.end(); it != ie; ++it) {
210     const Arg *A = *it;
211 
212     // Unfortunately, we have to parse some forwarding options (-Xassembler,
213     // -Xlinker, -Xpreprocessor) because we either integrate their functionality
214     // (assembler and preprocessor), or bypass a previous driver ('collect2').
215 
216     // Rewrite linker options, to replace --no-demangle with a custom internal
217     // option.
218     if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
219          A->getOption().matches(options::OPT_Xlinker)) &&
220         A->containsValue("--no-demangle")) {
221       // Add the rewritten no-demangle argument.
222       DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
223 
224       // Add the remaining values as Xlinker arguments.
225       for (unsigned i = 0, e = A->getNumValues(); i != e; ++i)
226         if (StringRef(A->getValue(i)) != "--no-demangle")
227           DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker),
228                               A->getValue(i));
229 
230       continue;
231     }
232 
233     // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
234     // some build systems. We don't try to be complete here because we don't
235     // care to encourage this usage model.
236     if (A->getOption().matches(options::OPT_Wp_COMMA) &&
237         (A->getValue(0) == StringRef("-MD") ||
238          A->getValue(0) == StringRef("-MMD"))) {
239       // Rewrite to -MD/-MMD along with -MF.
240       if (A->getValue(0) == StringRef("-MD"))
241         DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
242       else
243         DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
244       if (A->getNumValues() == 2)
245         DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
246                             A->getValue(1));
247       continue;
248     }
249 
250     // Rewrite reserved library names.
251     if (A->getOption().matches(options::OPT_l)) {
252       StringRef Value = A->getValue();
253 
254       // Rewrite unless -nostdlib is present.
255       if (!HasNostdlib && Value == "stdc++") {
256         DAL->AddFlagArg(A, Opts->getOption(
257                               options::OPT_Z_reserved_lib_stdcxx));
258         continue;
259       }
260 
261       // Rewrite unconditionally.
262       if (Value == "cc_kext") {
263         DAL->AddFlagArg(A, Opts->getOption(
264                               options::OPT_Z_reserved_lib_cckext));
265         continue;
266       }
267     }
268 
269     // Pick up inputs via the -- option.
270     if (A->getOption().matches(options::OPT__DASH_DASH)) {
271       A->claim();
272       for (unsigned i = 0, e = A->getNumValues(); i != e; ++i)
273         DAL->append(MakeInputArg(*DAL, Opts, A->getValue(i)));
274       continue;
275     }
276 
277     DAL->append(*it);
278   }
279 
280   // Add a default value of -mlinker-version=, if one was given and the user
281   // didn't specify one.
282 #if defined(HOST_LINK_VERSION)
283   if (!Args.hasArg(options::OPT_mlinker_version_EQ)) {
284     DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
285                       HOST_LINK_VERSION);
286     DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
287   }
288 #endif
289 
290   return DAL;
291 }
292 
293 Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
294   llvm::PrettyStackTraceString CrashInfo("Compilation construction");
295 
296   // FIXME: Handle environment options which affect driver behavior, somewhere
297   // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
298 
299   if (char *env = ::getenv("COMPILER_PATH")) {
300     StringRef CompilerPath = env;
301     while (!CompilerPath.empty()) {
302       std::pair<StringRef, StringRef> Split
303         = CompilerPath.split(llvm::sys::EnvPathSeparator);
304       PrefixDirs.push_back(Split.first);
305       CompilerPath = Split.second;
306     }
307   }
308 
309   // We look for the driver mode option early, because the mode can affect
310   // how other options are parsed.
311   ParseDriverMode(ArgList.slice(1));
312 
313   // FIXME: What are we going to do with -V and -b?
314 
315   // FIXME: This stuff needs to go into the Compilation, not the driver.
316   bool CCCPrintActions;
317 
318   InputArgList *Args = ParseArgStrings(ArgList.slice(1));
319 
320   // -no-canonical-prefixes is used very early in main.
321   Args->ClaimAllArgs(options::OPT_no_canonical_prefixes);
322 
323   // Ignore -pipe.
324   Args->ClaimAllArgs(options::OPT_pipe);
325 
326   // Extract -ccc args.
327   //
328   // FIXME: We need to figure out where this behavior should live. Most of it
329   // should be outside in the client; the parts that aren't should have proper
330   // options, either by introducing new ones or by overloading gcc ones like -V
331   // or -b.
332   CCCPrintActions = Args->hasArg(options::OPT_ccc_print_phases);
333   CCCPrintBindings = Args->hasArg(options::OPT_ccc_print_bindings);
334   if (const Arg *A = Args->getLastArg(options::OPT_ccc_gcc_name))
335     CCCGenericGCCName = A->getValue();
336   CCCUsePCH = Args->hasFlag(options::OPT_ccc_pch_is_pch,
337                             options::OPT_ccc_pch_is_pth);
338   // FIXME: DefaultTargetTriple is used by the target-prefixed calls to as/ld
339   // and getToolChain is const.
340   if (IsCLMode()) {
341     // clang-cl targets MSVC-style Win32.
342     llvm::Triple T(DefaultTargetTriple);
343     T.setOS(llvm::Triple::Win32);
344     T.setEnvironment(llvm::Triple::MSVC);
345     DefaultTargetTriple = T.str();
346   }
347   if (const Arg *A = Args->getLastArg(options::OPT_target))
348     DefaultTargetTriple = A->getValue();
349   if (const Arg *A = Args->getLastArg(options::OPT_ccc_install_dir))
350     Dir = InstalledDir = A->getValue();
351   for (arg_iterator it = Args->filtered_begin(options::OPT_B),
352          ie = Args->filtered_end(); it != ie; ++it) {
353     const Arg *A = *it;
354     A->claim();
355     PrefixDirs.push_back(A->getValue(0));
356   }
357   if (const Arg *A = Args->getLastArg(options::OPT__sysroot_EQ))
358     SysRoot = A->getValue();
359   if (const Arg *A = Args->getLastArg(options::OPT__dyld_prefix_EQ))
360     DyldPrefix = A->getValue();
361   if (Args->hasArg(options::OPT_nostdlib))
362     UseStdLib = false;
363 
364   if (const Arg *A = Args->getLastArg(options::OPT_resource_dir))
365     ResourceDir = A->getValue();
366 
367   // Perform the default argument translations.
368   DerivedArgList *TranslatedArgs = TranslateInputArgs(*Args);
369 
370   // Owned by the host.
371   const ToolChain &TC = getToolChain(*Args);
372 
373   // The compilation takes ownership of Args.
374   Compilation *C = new Compilation(*this, TC, Args, TranslatedArgs);
375 
376   if (!HandleImmediateArgs(*C))
377     return C;
378 
379   // Construct the list of inputs.
380   InputList Inputs;
381   BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
382 
383   // Construct the list of abstract actions to perform for this compilation. On
384   // MachO targets this uses the driver-driver and universal actions.
385   if (TC.getTriple().isOSBinFormatMachO())
386     BuildUniversalActions(C->getDefaultToolChain(), C->getArgs(),
387                           Inputs, C->getActions());
388   else
389     BuildActions(C->getDefaultToolChain(), C->getArgs(), Inputs,
390                  C->getActions());
391 
392   if (CCCPrintActions) {
393     PrintActions(*C);
394     return C;
395   }
396 
397   BuildJobs(*C);
398 
399   return C;
400 }
401 
402 // When clang crashes, produce diagnostic information including the fully
403 // preprocessed source file(s).  Request that the developer attach the
404 // diagnostic information to a bug report.
405 void Driver::generateCompilationDiagnostics(Compilation &C,
406                                             const Command *FailingCommand) {
407   if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
408     return;
409 
410   // Don't try to generate diagnostics for link or dsymutil jobs.
411   if (FailingCommand && (FailingCommand->getCreator().isLinkJob() ||
412                          FailingCommand->getCreator().isDsymutilJob()))
413     return;
414 
415   // Print the version of the compiler.
416   PrintVersion(C, llvm::errs());
417 
418   Diag(clang::diag::note_drv_command_failed_diag_msg)
419     << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
420     "crash backtrace, preprocessed source, and associated run script.";
421 
422   // Suppress driver output and emit preprocessor output to temp file.
423   Mode = CPPMode;
424   CCGenDiagnostics = true;
425 
426   // Save the original job command(s).
427   std::string Cmd;
428   llvm::raw_string_ostream OS(Cmd);
429   if (FailingCommand)
430     FailingCommand->Print(OS, "\n", /*Quote*/ false, /*CrashReport*/ true);
431   else
432     // Crash triggered by FORCE_CLANG_DIAGNOSTICS_CRASH, which doesn't have an
433     // associated FailingCommand, so just pass all jobs.
434     C.getJobs().Print(OS, "\n", /*Quote*/ false, /*CrashReport*/ true);
435   OS.flush();
436 
437   // Keep track of whether we produce any errors while trying to produce
438   // preprocessed sources.
439   DiagnosticErrorTrap Trap(Diags);
440 
441   // Suppress tool output.
442   C.initCompilationForDiagnostics();
443 
444   // Construct the list of inputs.
445   InputList Inputs;
446   BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
447 
448   for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
449     bool IgnoreInput = false;
450 
451     // Ignore input from stdin or any inputs that cannot be preprocessed.
452     // Check type first as not all linker inputs have a value.
453    if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
454       IgnoreInput = true;
455     } else if (!strcmp(it->second->getValue(), "-")) {
456       Diag(clang::diag::note_drv_command_failed_diag_msg)
457         << "Error generating preprocessed source(s) - ignoring input from stdin"
458         ".";
459       IgnoreInput = true;
460     }
461 
462     if (IgnoreInput) {
463       it = Inputs.erase(it);
464       ie = Inputs.end();
465     } else {
466       ++it;
467     }
468   }
469 
470   if (Inputs.empty()) {
471     Diag(clang::diag::note_drv_command_failed_diag_msg)
472       << "Error generating preprocessed source(s) - no preprocessable inputs.";
473     return;
474   }
475 
476   // Don't attempt to generate preprocessed files if multiple -arch options are
477   // used, unless they're all duplicates.
478   llvm::StringSet<> ArchNames;
479   for (ArgList::const_iterator it = C.getArgs().begin(), ie = C.getArgs().end();
480        it != ie; ++it) {
481     Arg *A = *it;
482     if (A->getOption().matches(options::OPT_arch)) {
483       StringRef ArchName = A->getValue();
484       ArchNames.insert(ArchName);
485     }
486   }
487   if (ArchNames.size() > 1) {
488     Diag(clang::diag::note_drv_command_failed_diag_msg)
489       << "Error generating preprocessed source(s) - cannot generate "
490       "preprocessed source with multiple -arch options.";
491     return;
492   }
493 
494   // Construct the list of abstract actions to perform for this compilation. On
495   // Darwin OSes this uses the driver-driver and builds universal actions.
496   const ToolChain &TC = C.getDefaultToolChain();
497   if (TC.getTriple().isOSBinFormatMachO())
498     BuildUniversalActions(TC, C.getArgs(), Inputs, C.getActions());
499   else
500     BuildActions(TC, C.getArgs(), Inputs, C.getActions());
501 
502   BuildJobs(C);
503 
504   // If there were errors building the compilation, quit now.
505   if (Trap.hasErrorOccurred()) {
506     Diag(clang::diag::note_drv_command_failed_diag_msg)
507       << "Error generating preprocessed source(s).";
508     return;
509   }
510 
511   // Generate preprocessed output.
512   SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
513   C.ExecuteJob(C.getJobs(), FailingCommands);
514 
515   // If the command succeeded, we are done.
516   if (FailingCommands.empty()) {
517     Diag(clang::diag::note_drv_command_failed_diag_msg)
518       << "\n********************\n\n"
519       "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
520       "Preprocessed source(s) and associated run script(s) are located at:";
521     const ArgStringList &Files = C.getTempFiles();
522     for (ArgStringList::const_iterator it = Files.begin(), ie = Files.end();
523          it != ie; ++it) {
524       Diag(clang::diag::note_drv_command_failed_diag_msg) << *it;
525       std::string Script = StringRef(*it).rsplit('.').first;
526       // In some cases (modules) we'll dump extra data to help with reproducing
527       // the crash into a directory next to the output.
528       SmallString<128> VFS;
529       if (llvm::sys::fs::exists(Script + ".cache")) {
530         Diag(clang::diag::note_drv_command_failed_diag_msg)
531             << Script + ".cache";
532         VFS = llvm::sys::path::filename(Script + ".cache");
533         llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
534       }
535 
536       std::error_code EC;
537       Script += ".sh";
538       llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl);
539       if (EC) {
540         Diag(clang::diag::note_drv_command_failed_diag_msg)
541             << "Error generating run script: " + Script + " " + EC.message();
542       } else {
543         // Replace the original filename with the preprocessed one.
544         size_t I, E;
545         I = Cmd.find("-main-file-name ");
546         assert (I != std::string::npos && "Expected to find -main-file-name");
547         I += 16;
548         E = Cmd.find(" ", I);
549         assert (E != std::string::npos && "-main-file-name missing argument?");
550         StringRef OldFilename = StringRef(Cmd).slice(I, E);
551         StringRef NewFilename = llvm::sys::path::filename(*it);
552         I = StringRef(Cmd).rfind(OldFilename);
553         E = I + OldFilename.size();
554         if (E + 1 < Cmd.size() && Cmd[E] == '"')
555           ++E;  // Replace a trailing quote if present.
556         I = Cmd.rfind(" ", I) + 1;
557         Cmd.replace(I, E - I, NewFilename.data(), NewFilename.size());
558         if (!VFS.empty()) {
559           // Add the VFS overlay to the reproduction script.
560           I += NewFilename.size();
561           Cmd.insert(I, std::string(" -ivfsoverlay ") + VFS.c_str());
562         }
563         ScriptOS << Cmd;
564         Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
565       }
566     }
567     Diag(clang::diag::note_drv_command_failed_diag_msg)
568       << "\n\n********************";
569   } else {
570     // Failure, remove preprocessed files.
571     if (!C.getArgs().hasArg(options::OPT_save_temps))
572       C.CleanupFileList(C.getTempFiles(), true);
573 
574     Diag(clang::diag::note_drv_command_failed_diag_msg)
575       << "Error generating preprocessed source(s).";
576   }
577 }
578 
579 void Driver::setUpResponseFiles(Compilation &C, Job &J) {
580   if (JobList *Jobs = dyn_cast<JobList>(&J)) {
581     for (auto &Job : *Jobs)
582       setUpResponseFiles(C, Job);
583     return;
584   }
585 
586   Command *CurCommand = dyn_cast<Command>(&J);
587   if (!CurCommand)
588     return;
589 
590   // Since argumentsFitWithinSystemLimits() may underestimate system's capacity
591   // if the tool does not support response files, there is a chance/ that things
592   // will just work without a response file, so we silently just skip it.
593   if (CurCommand->getCreator().getResponseFilesSupport() == Tool::RF_None ||
594       llvm::sys::argumentsFitWithinSystemLimits(CurCommand->getArguments()))
595     return;
596 
597   std::string TmpName = GetTemporaryPath("response", "txt");
598   CurCommand->setResponseFile(C.addTempFile(C.getArgs().MakeArgString(
599       TmpName.c_str())));
600 }
601 
602 int Driver::ExecuteCompilation(Compilation &C,
603     SmallVectorImpl< std::pair<int, const Command *> > &FailingCommands) {
604   // Just print if -### was present.
605   if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
606     C.getJobs().Print(llvm::errs(), "\n", true);
607     return 0;
608   }
609 
610   // If there were errors building the compilation, quit now.
611   if (Diags.hasErrorOccurred())
612     return 1;
613 
614   // Set up response file names for each command, if necessary
615   setUpResponseFiles(C, C.getJobs());
616 
617   C.ExecuteJob(C.getJobs(), FailingCommands);
618 
619   // Remove temp files.
620   C.CleanupFileList(C.getTempFiles());
621 
622   // If the command succeeded, we are done.
623   if (FailingCommands.empty())
624     return 0;
625 
626   // Otherwise, remove result files and print extra information about abnormal
627   // failures.
628   for (SmallVectorImpl< std::pair<int, const Command *> >::iterator it =
629          FailingCommands.begin(), ie = FailingCommands.end(); it != ie; ++it) {
630     int Res = it->first;
631     const Command *FailingCommand = it->second;
632 
633     // Remove result files if we're not saving temps.
634     if (!C.getArgs().hasArg(options::OPT_save_temps)) {
635       const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
636       C.CleanupFileMap(C.getResultFiles(), JA, true);
637 
638       // Failure result files are valid unless we crashed.
639       if (Res < 0)
640         C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
641     }
642 
643     // Print extra information about abnormal failures, if possible.
644     //
645     // This is ad-hoc, but we don't want to be excessively noisy. If the result
646     // status was 1, assume the command failed normally. In particular, if it
647     // was the compiler then assume it gave a reasonable error code. Failures
648     // in other tools are less common, and they generally have worse
649     // diagnostics, so always print the diagnostic there.
650     const Tool &FailingTool = FailingCommand->getCreator();
651 
652     if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
653       // FIXME: See FIXME above regarding result code interpretation.
654       if (Res < 0)
655         Diag(clang::diag::err_drv_command_signalled)
656           << FailingTool.getShortName();
657       else
658         Diag(clang::diag::err_drv_command_failed)
659           << FailingTool.getShortName() << Res;
660     }
661   }
662   return 0;
663 }
664 
665 void Driver::PrintHelp(bool ShowHidden) const {
666   unsigned IncludedFlagsBitmask;
667   unsigned ExcludedFlagsBitmask;
668   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
669     getIncludeExcludeOptionFlagMasks();
670 
671   ExcludedFlagsBitmask |= options::NoDriverOption;
672   if (!ShowHidden)
673     ExcludedFlagsBitmask |= HelpHidden;
674 
675   getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
676                       IncludedFlagsBitmask, ExcludedFlagsBitmask);
677 }
678 
679 void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
680   // FIXME: The following handlers should use a callback mechanism, we don't
681   // know what the client would like to do.
682   OS << getClangFullVersion() << '\n';
683   const ToolChain &TC = C.getDefaultToolChain();
684   OS << "Target: " << TC.getTripleString() << '\n';
685 
686   // Print the threading model.
687   if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
688     // Don't print if the ToolChain would have barfed on it already
689     if (TC.isThreadModelSupported(A->getValue()))
690       OS << "Thread model: " << A->getValue();
691   } else
692     OS << "Thread model: " << TC.getThreadModel();
693   OS << '\n';
694 }
695 
696 /// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
697 /// option.
698 static void PrintDiagnosticCategories(raw_ostream &OS) {
699   // Skip the empty category.
700   for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories();
701        i != max; ++i)
702     OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
703 }
704 
705 bool Driver::HandleImmediateArgs(const Compilation &C) {
706   // The order these options are handled in gcc is all over the place, but we
707   // don't expect inconsistencies w.r.t. that to matter in practice.
708 
709   if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
710     llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
711     return false;
712   }
713 
714   if (C.getArgs().hasArg(options::OPT_dumpversion)) {
715     // Since -dumpversion is only implemented for pedantic GCC compatibility, we
716     // return an answer which matches our definition of __VERSION__.
717     //
718     // If we want to return a more correct answer some day, then we should
719     // introduce a non-pedantically GCC compatible mode to Clang in which we
720     // provide sensible definitions for -dumpversion, __VERSION__, etc.
721     llvm::outs() << "4.2.1\n";
722     return false;
723   }
724 
725   if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
726     PrintDiagnosticCategories(llvm::outs());
727     return false;
728   }
729 
730   if (C.getArgs().hasArg(options::OPT_help) ||
731       C.getArgs().hasArg(options::OPT__help_hidden)) {
732     PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
733     return false;
734   }
735 
736   if (C.getArgs().hasArg(options::OPT__version)) {
737     // Follow gcc behavior and use stdout for --version and stderr for -v.
738     PrintVersion(C, llvm::outs());
739     return false;
740   }
741 
742   if (C.getArgs().hasArg(options::OPT_v) ||
743       C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
744     PrintVersion(C, llvm::errs());
745     SuppressMissingInputWarning = true;
746   }
747 
748   const ToolChain &TC = C.getDefaultToolChain();
749 
750   if (C.getArgs().hasArg(options::OPT_v))
751     TC.printVerboseInfo(llvm::errs());
752 
753   if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
754     llvm::outs() << "programs: =";
755     for (ToolChain::path_list::const_iterator it = TC.getProgramPaths().begin(),
756            ie = TC.getProgramPaths().end(); it != ie; ++it) {
757       if (it != TC.getProgramPaths().begin())
758         llvm::outs() << ':';
759       llvm::outs() << *it;
760     }
761     llvm::outs() << "\n";
762     llvm::outs() << "libraries: =" << ResourceDir;
763 
764     StringRef sysroot = C.getSysRoot();
765 
766     for (ToolChain::path_list::const_iterator it = TC.getFilePaths().begin(),
767            ie = TC.getFilePaths().end(); it != ie; ++it) {
768       llvm::outs() << ':';
769       const char *path = it->c_str();
770       if (path[0] == '=')
771         llvm::outs() << sysroot << path + 1;
772       else
773         llvm::outs() << path;
774     }
775     llvm::outs() << "\n";
776     return false;
777   }
778 
779   // FIXME: The following handlers should use a callback mechanism, we don't
780   // know what the client would like to do.
781   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
782     llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
783     return false;
784   }
785 
786   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
787     llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n";
788     return false;
789   }
790 
791   if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
792     llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
793     return false;
794   }
795 
796   if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
797     const MultilibSet &Multilibs = TC.getMultilibs();
798 
799     for (MultilibSet::const_iterator I = Multilibs.begin(), E = Multilibs.end();
800          I != E; ++I) {
801       llvm::outs() << *I << "\n";
802     }
803     return false;
804   }
805 
806   if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
807     const MultilibSet &Multilibs = TC.getMultilibs();
808     for (MultilibSet::const_iterator I = Multilibs.begin(), E = Multilibs.end();
809          I != E; ++I) {
810       if (I->gccSuffix().empty())
811         llvm::outs() << ".\n";
812       else {
813         StringRef Suffix(I->gccSuffix());
814         assert(Suffix.front() == '/');
815         llvm::outs() << Suffix.substr(1) << "\n";
816       }
817     }
818     return false;
819   }
820 
821   if (C.getArgs().hasArg(options::OPT_print_multi_os_directory)) {
822     // FIXME: This should print out "lib/../lib", "lib/../lib64", or
823     // "lib/../lib32" as appropriate for the toolchain. For now, print
824     // nothing because it's not supported yet.
825     return false;
826   }
827 
828   return true;
829 }
830 
831 static unsigned PrintActions1(const Compilation &C, Action *A,
832                               std::map<Action*, unsigned> &Ids) {
833   if (Ids.count(A))
834     return Ids[A];
835 
836   std::string str;
837   llvm::raw_string_ostream os(str);
838 
839   os << Action::getClassName(A->getKind()) << ", ";
840   if (InputAction *IA = dyn_cast<InputAction>(A)) {
841     os << "\"" << IA->getInputArg().getValue() << "\"";
842   } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
843     os << '"' << BIA->getArchName() << '"'
844        << ", {" << PrintActions1(C, *BIA->begin(), Ids) << "}";
845   } else {
846     os << "{";
847     for (Action::iterator it = A->begin(), ie = A->end(); it != ie;) {
848       os << PrintActions1(C, *it, Ids);
849       ++it;
850       if (it != ie)
851         os << ", ";
852     }
853     os << "}";
854   }
855 
856   unsigned Id = Ids.size();
857   Ids[A] = Id;
858   llvm::errs() << Id << ": " << os.str() << ", "
859                << types::getTypeName(A->getType()) << "\n";
860 
861   return Id;
862 }
863 
864 void Driver::PrintActions(const Compilation &C) const {
865   std::map<Action*, unsigned> Ids;
866   for (ActionList::const_iterator it = C.getActions().begin(),
867          ie = C.getActions().end(); it != ie; ++it)
868     PrintActions1(C, *it, Ids);
869 }
870 
871 /// \brief Check whether the given input tree contains any compilation or
872 /// assembly actions.
873 static bool ContainsCompileOrAssembleAction(const Action *A) {
874   if (isa<CompileJobAction>(A) || isa<AssembleJobAction>(A))
875     return true;
876 
877   for (Action::const_iterator it = A->begin(), ie = A->end(); it != ie; ++it)
878     if (ContainsCompileOrAssembleAction(*it))
879       return true;
880 
881   return false;
882 }
883 
884 void Driver::BuildUniversalActions(const ToolChain &TC,
885                                    DerivedArgList &Args,
886                                    const InputList &BAInputs,
887                                    ActionList &Actions) const {
888   llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
889   // Collect the list of architectures. Duplicates are allowed, but should only
890   // be handled once (in the order seen).
891   llvm::StringSet<> ArchNames;
892   SmallVector<const char *, 4> Archs;
893   for (ArgList::const_iterator it = Args.begin(), ie = Args.end();
894        it != ie; ++it) {
895     Arg *A = *it;
896 
897     if (A->getOption().matches(options::OPT_arch)) {
898       // Validate the option here; we don't save the type here because its
899       // particular spelling may participate in other driver choices.
900       llvm::Triple::ArchType Arch =
901         tools::darwin::getArchTypeForMachOArchName(A->getValue());
902       if (Arch == llvm::Triple::UnknownArch) {
903         Diag(clang::diag::err_drv_invalid_arch_name)
904           << A->getAsString(Args);
905         continue;
906       }
907 
908       A->claim();
909       if (ArchNames.insert(A->getValue()))
910         Archs.push_back(A->getValue());
911     }
912   }
913 
914   // When there is no explicit arch for this platform, make sure we still bind
915   // the architecture (to the default) so that -Xarch_ is handled correctly.
916   if (!Archs.size())
917     Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
918 
919   ActionList SingleActions;
920   BuildActions(TC, Args, BAInputs, SingleActions);
921 
922   // Add in arch bindings for every top level action, as well as lipo and
923   // dsymutil steps if needed.
924   for (unsigned i = 0, e = SingleActions.size(); i != e; ++i) {
925     Action *Act = SingleActions[i];
926 
927     // Make sure we can lipo this kind of output. If not (and it is an actual
928     // output) then we disallow, since we can't create an output file with the
929     // right name without overwriting it. We could remove this oddity by just
930     // changing the output names to include the arch, which would also fix
931     // -save-temps. Compatibility wins for now.
932 
933     if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
934       Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
935         << types::getTypeName(Act->getType());
936 
937     ActionList Inputs;
938     for (unsigned i = 0, e = Archs.size(); i != e; ++i) {
939       Inputs.push_back(
940           new BindArchAction(std::unique_ptr<Action>(Act), Archs[i]));
941       if (i != 0)
942         Inputs.back()->setOwnsInputs(false);
943     }
944 
945     // Lipo if necessary, we do it this way because we need to set the arch flag
946     // so that -Xarch_ gets overwritten.
947     if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
948       Actions.append(Inputs.begin(), Inputs.end());
949     else
950       Actions.push_back(new LipoJobAction(Inputs, Act->getType()));
951 
952     // Handle debug info queries.
953     Arg *A = Args.getLastArg(options::OPT_g_Group);
954     if (A && !A->getOption().matches(options::OPT_g0) &&
955         !A->getOption().matches(options::OPT_gstabs) &&
956         ContainsCompileOrAssembleAction(Actions.back())) {
957 
958       // Add a 'dsymutil' step if necessary, when debug info is enabled and we
959       // have a compile input. We need to run 'dsymutil' ourselves in such cases
960       // because the debug info will refer to a temporary object file which
961       // will be removed at the end of the compilation process.
962       if (Act->getType() == types::TY_Image) {
963         ActionList Inputs;
964         Inputs.push_back(Actions.back());
965         Actions.pop_back();
966         Actions.push_back(new DsymutilJobAction(Inputs, types::TY_dSYM));
967       }
968 
969       // Verify the debug info output.
970       if (Args.hasArg(options::OPT_verify_debug_info)) {
971         std::unique_ptr<Action> VerifyInput(Actions.back());
972         Actions.pop_back();
973         Actions.push_back(new VerifyDebugInfoJobAction(std::move(VerifyInput),
974                                                        types::TY_Nothing));
975       }
976     }
977   }
978 }
979 
980 /// \brief Check that the file referenced by Value exists. If it doesn't,
981 /// issue a diagnostic and return false.
982 static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
983                                    StringRef Value) {
984   if (!D.getCheckInputsExist())
985     return true;
986 
987   // stdin always exists.
988   if (Value == "-")
989     return true;
990 
991   SmallString<64> Path(Value);
992   if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
993     if (!llvm::sys::path::is_absolute(Path.str())) {
994       SmallString<64> Directory(WorkDir->getValue());
995       llvm::sys::path::append(Directory, Value);
996       Path.assign(Directory);
997     }
998   }
999 
1000   if (llvm::sys::fs::exists(Twine(Path)))
1001     return true;
1002 
1003   if (D.IsCLMode() && llvm::sys::Process::FindInEnvPath("LIB", Value))
1004     return true;
1005 
1006   D.Diag(clang::diag::err_drv_no_such_file) << Path.str();
1007   return false;
1008 }
1009 
1010 // Construct a the list of inputs and their types.
1011 void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
1012                          InputList &Inputs) const {
1013   // Track the current user specified (-x) input. We also explicitly track the
1014   // argument used to set the type; we only want to claim the type when we
1015   // actually use it, so we warn about unused -x arguments.
1016   types::ID InputType = types::TY_Nothing;
1017   Arg *InputTypeArg = nullptr;
1018 
1019   // The last /TC or /TP option sets the input type to C or C++ globally.
1020   if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1021                                          options::OPT__SLASH_TP)) {
1022     InputTypeArg = TCTP;
1023     InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
1024         ? types::TY_C : types::TY_CXX;
1025 
1026     arg_iterator it = Args.filtered_begin(options::OPT__SLASH_TC,
1027                                           options::OPT__SLASH_TP);
1028     const arg_iterator ie = Args.filtered_end();
1029     Arg *Previous = *it++;
1030     bool ShowNote = false;
1031     while (it != ie) {
1032       Diag(clang::diag::warn_drv_overriding_flag_option)
1033           << Previous->getSpelling() << (*it)->getSpelling();
1034       Previous = *it++;
1035       ShowNote = true;
1036     }
1037     if (ShowNote)
1038       Diag(clang::diag::note_drv_t_option_is_global);
1039 
1040     // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1041     assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1042   }
1043 
1044   for (ArgList::const_iterator it = Args.begin(), ie = Args.end();
1045        it != ie; ++it) {
1046     Arg *A = *it;
1047 
1048     if (A->getOption().getKind() == Option::InputClass) {
1049       const char *Value = A->getValue();
1050       types::ID Ty = types::TY_INVALID;
1051 
1052       // Infer the input type if necessary.
1053       if (InputType == types::TY_Nothing) {
1054         // If there was an explicit arg for this, claim it.
1055         if (InputTypeArg)
1056           InputTypeArg->claim();
1057 
1058         // stdin must be handled specially.
1059         if (memcmp(Value, "-", 2) == 0) {
1060           // If running with -E, treat as a C input (this changes the builtin
1061           // macros, for example). This may be overridden by -ObjC below.
1062           //
1063           // Otherwise emit an error but still use a valid type to avoid
1064           // spurious errors (e.g., no inputs).
1065           if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
1066             Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1067                             : clang::diag::err_drv_unknown_stdin_type);
1068           Ty = types::TY_C;
1069         } else {
1070           // Otherwise lookup by extension.
1071           // Fallback is C if invoked as C preprocessor or Object otherwise.
1072           // We use a host hook here because Darwin at least has its own
1073           // idea of what .s is.
1074           if (const char *Ext = strrchr(Value, '.'))
1075             Ty = TC.LookupTypeForExtension(Ext + 1);
1076 
1077           if (Ty == types::TY_INVALID) {
1078             if (CCCIsCPP())
1079               Ty = types::TY_C;
1080             else
1081               Ty = types::TY_Object;
1082           }
1083 
1084           // If the driver is invoked as C++ compiler (like clang++ or c++) it
1085           // should autodetect some input files as C++ for g++ compatibility.
1086           if (CCCIsCXX()) {
1087             types::ID OldTy = Ty;
1088             Ty = types::lookupCXXTypeForCType(Ty);
1089 
1090             if (Ty != OldTy)
1091               Diag(clang::diag::warn_drv_treating_input_as_cxx)
1092                 << getTypeName(OldTy) << getTypeName(Ty);
1093           }
1094         }
1095 
1096         // -ObjC and -ObjC++ override the default language, but only for "source
1097         // files". We just treat everything that isn't a linker input as a
1098         // source file.
1099         //
1100         // FIXME: Clean this up if we move the phase sequence into the type.
1101         if (Ty != types::TY_Object) {
1102           if (Args.hasArg(options::OPT_ObjC))
1103             Ty = types::TY_ObjC;
1104           else if (Args.hasArg(options::OPT_ObjCXX))
1105             Ty = types::TY_ObjCXX;
1106         }
1107       } else {
1108         assert(InputTypeArg && "InputType set w/o InputTypeArg");
1109         if (!InputTypeArg->getOption().matches(options::OPT_x)) {
1110           // If emulating cl.exe, make sure that /TC and /TP don't affect input
1111           // object files.
1112           const char *Ext = strrchr(Value, '.');
1113           if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
1114             Ty = types::TY_Object;
1115         }
1116         if (Ty == types::TY_INVALID) {
1117           Ty = InputType;
1118           InputTypeArg->claim();
1119         }
1120       }
1121 
1122       if (DiagnoseInputExistence(*this, Args, Value))
1123         Inputs.push_back(std::make_pair(Ty, A));
1124 
1125     } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
1126       StringRef Value = A->getValue();
1127       if (DiagnoseInputExistence(*this, Args, Value)) {
1128         Arg *InputArg = MakeInputArg(Args, Opts, A->getValue());
1129         Inputs.push_back(std::make_pair(types::TY_C, InputArg));
1130       }
1131       A->claim();
1132     } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
1133       StringRef Value = A->getValue();
1134       if (DiagnoseInputExistence(*this, Args, Value)) {
1135         Arg *InputArg = MakeInputArg(Args, Opts, A->getValue());
1136         Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
1137       }
1138       A->claim();
1139     } else if (A->getOption().hasFlag(options::LinkerInput)) {
1140       // Just treat as object type, we could make a special type for this if
1141       // necessary.
1142       Inputs.push_back(std::make_pair(types::TY_Object, A));
1143 
1144     } else if (A->getOption().matches(options::OPT_x)) {
1145       InputTypeArg = A;
1146       InputType = types::lookupTypeForTypeSpecifier(A->getValue());
1147       A->claim();
1148 
1149       // Follow gcc behavior and treat as linker input for invalid -x
1150       // options. Its not clear why we shouldn't just revert to unknown; but
1151       // this isn't very important, we might as well be bug compatible.
1152       if (!InputType) {
1153         Diag(clang::diag::err_drv_unknown_language) << A->getValue();
1154         InputType = types::TY_Object;
1155       }
1156     }
1157   }
1158   if (CCCIsCPP() && Inputs.empty()) {
1159     // If called as standalone preprocessor, stdin is processed
1160     // if no other input is present.
1161     Arg *A = MakeInputArg(Args, Opts, "-");
1162     Inputs.push_back(std::make_pair(types::TY_C, A));
1163   }
1164 }
1165 
1166 void Driver::BuildActions(const ToolChain &TC, DerivedArgList &Args,
1167                           const InputList &Inputs, ActionList &Actions) const {
1168   llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
1169 
1170   if (!SuppressMissingInputWarning && Inputs.empty()) {
1171     Diag(clang::diag::err_drv_no_input_files);
1172     return;
1173   }
1174 
1175   Arg *FinalPhaseArg;
1176   phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
1177 
1178   if (FinalPhase == phases::Link && Args.hasArg(options::OPT_emit_llvm)) {
1179     Diag(clang::diag::err_drv_emit_llvm_link);
1180   }
1181 
1182   // Reject -Z* at the top level, these options should never have been exposed
1183   // by gcc.
1184   if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
1185     Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
1186 
1187   // Diagnose misuse of /Fo.
1188   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
1189     StringRef V = A->getValue();
1190     if (V.empty()) {
1191       // It has to have a value.
1192       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
1193       Args.eraseArg(options::OPT__SLASH_Fo);
1194     } else if (Inputs.size() > 1 && !llvm::sys::path::is_separator(V.back())) {
1195       // Check whether /Fo tries to name an output file for multiple inputs.
1196       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
1197         << A->getSpelling() << V;
1198       Args.eraseArg(options::OPT__SLASH_Fo);
1199     }
1200   }
1201 
1202   // Diagnose misuse of /Fa.
1203   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
1204     StringRef V = A->getValue();
1205     if (Inputs.size() > 1 && !llvm::sys::path::is_separator(V.back())) {
1206       // Check whether /Fa tries to name an asm file for multiple inputs.
1207       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
1208         << A->getSpelling() << V;
1209       Args.eraseArg(options::OPT__SLASH_Fa);
1210     }
1211   }
1212 
1213   // Diagnose misuse of /Fe.
1214   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fe)) {
1215     if (A->getValue()[0] == '\0') {
1216       // It has to have a value.
1217       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
1218       Args.eraseArg(options::OPT__SLASH_Fe);
1219     }
1220   }
1221 
1222   // Diagnose misuse of /o.
1223   if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
1224     if (A->getValue()[0] == '\0') {
1225       // It has to have a value.
1226       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
1227       Args.eraseArg(options::OPT__SLASH_o);
1228     }
1229   }
1230 
1231   // Construct the actions to perform.
1232   ActionList LinkerInputs;
1233 
1234   llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
1235   for (unsigned i = 0, e = Inputs.size(); i != e; ++i) {
1236     types::ID InputType = Inputs[i].first;
1237     const Arg *InputArg = Inputs[i].second;
1238 
1239     PL.clear();
1240     types::getCompilationPhases(InputType, PL);
1241 
1242     // If the first step comes after the final phase we are doing as part of
1243     // this compilation, warn the user about it.
1244     phases::ID InitialPhase = PL[0];
1245     if (InitialPhase > FinalPhase) {
1246       // Claim here to avoid the more general unused warning.
1247       InputArg->claim();
1248 
1249       // Suppress all unused style warnings with -Qunused-arguments
1250       if (Args.hasArg(options::OPT_Qunused_arguments))
1251         continue;
1252 
1253       // Special case when final phase determined by binary name, rather than
1254       // by a command-line argument with a corresponding Arg.
1255       if (CCCIsCPP())
1256         Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
1257           << InputArg->getAsString(Args)
1258           << getPhaseName(InitialPhase);
1259       // Special case '-E' warning on a previously preprocessed file to make
1260       // more sense.
1261       else if (InitialPhase == phases::Compile &&
1262                FinalPhase == phases::Preprocess &&
1263                getPreprocessedType(InputType) == types::TY_INVALID)
1264         Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
1265           << InputArg->getAsString(Args)
1266           << !!FinalPhaseArg
1267           << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
1268       else
1269         Diag(clang::diag::warn_drv_input_file_unused)
1270           << InputArg->getAsString(Args)
1271           << getPhaseName(InitialPhase)
1272           << !!FinalPhaseArg
1273           << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
1274       continue;
1275     }
1276 
1277     // Build the pipeline for this file.
1278     std::unique_ptr<Action> Current(new InputAction(*InputArg, InputType));
1279     for (SmallVectorImpl<phases::ID>::iterator
1280            i = PL.begin(), e = PL.end(); i != e; ++i) {
1281       phases::ID Phase = *i;
1282 
1283       // We are done if this step is past what the user requested.
1284       if (Phase > FinalPhase)
1285         break;
1286 
1287       // Queue linker inputs.
1288       if (Phase == phases::Link) {
1289         assert((i + 1) == e && "linking must be final compilation step.");
1290         LinkerInputs.push_back(Current.release());
1291         break;
1292       }
1293 
1294       // Some types skip the assembler phase (e.g., llvm-bc), but we can't
1295       // encode this in the steps because the intermediate type depends on
1296       // arguments. Just special case here.
1297       if (Phase == phases::Assemble && Current->getType() != types::TY_PP_Asm)
1298         continue;
1299 
1300       // Otherwise construct the appropriate action.
1301       Current = ConstructPhaseAction(Args, Phase, std::move(Current));
1302       if (Current->getType() == types::TY_Nothing)
1303         break;
1304     }
1305 
1306     // If we ended with something, add to the output list.
1307     if (Current)
1308       Actions.push_back(Current.release());
1309   }
1310 
1311   // Add a link action if necessary.
1312   if (!LinkerInputs.empty())
1313     Actions.push_back(new LinkJobAction(LinkerInputs, types::TY_Image));
1314 
1315   // If we are linking, claim any options which are obviously only used for
1316   // compilation.
1317   if (FinalPhase == phases::Link && PL.size() == 1) {
1318     Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
1319     Args.ClaimAllArgs(options::OPT_cl_compile_Group);
1320   }
1321 
1322   // Claim ignored clang-cl options.
1323   Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
1324 }
1325 
1326 std::unique_ptr<Action>
1327 Driver::ConstructPhaseAction(const ArgList &Args, phases::ID Phase,
1328                              std::unique_ptr<Action> Input) const {
1329   llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
1330   // Build the appropriate action.
1331   switch (Phase) {
1332   case phases::Link: llvm_unreachable("link action invalid here.");
1333   case phases::Preprocess: {
1334     types::ID OutputTy;
1335     // -{M, MM} alter the output type.
1336     if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
1337       OutputTy = types::TY_Dependencies;
1338     } else {
1339       OutputTy = Input->getType();
1340       if (!Args.hasFlag(options::OPT_frewrite_includes,
1341                         options::OPT_fno_rewrite_includes, false) &&
1342           !CCGenDiagnostics)
1343         OutputTy = types::getPreprocessedType(OutputTy);
1344       assert(OutputTy != types::TY_INVALID &&
1345              "Cannot preprocess this input type!");
1346     }
1347     return llvm::make_unique<PreprocessJobAction>(std::move(Input), OutputTy);
1348   }
1349   case phases::Precompile: {
1350     types::ID OutputTy = types::TY_PCH;
1351     if (Args.hasArg(options::OPT_fsyntax_only)) {
1352       // Syntax checks should not emit a PCH file
1353       OutputTy = types::TY_Nothing;
1354     }
1355     return llvm::make_unique<PrecompileJobAction>(std::move(Input), OutputTy);
1356   }
1357   case phases::Compile: {
1358     if (Args.hasArg(options::OPT_fsyntax_only))
1359       return llvm::make_unique<CompileJobAction>(std::move(Input),
1360                                                  types::TY_Nothing);
1361     if (Args.hasArg(options::OPT_rewrite_objc))
1362       return llvm::make_unique<CompileJobAction>(std::move(Input),
1363                                                  types::TY_RewrittenObjC);
1364     if (Args.hasArg(options::OPT_rewrite_legacy_objc))
1365       return llvm::make_unique<CompileJobAction>(std::move(Input),
1366                                                  types::TY_RewrittenLegacyObjC);
1367     if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
1368       return llvm::make_unique<AnalyzeJobAction>(std::move(Input),
1369                                                  types::TY_Plist);
1370     if (Args.hasArg(options::OPT__migrate))
1371       return llvm::make_unique<MigrateJobAction>(std::move(Input),
1372                                                  types::TY_Remap);
1373     if (Args.hasArg(options::OPT_emit_ast))
1374       return llvm::make_unique<CompileJobAction>(std::move(Input),
1375                                                  types::TY_AST);
1376     if (Args.hasArg(options::OPT_module_file_info))
1377       return llvm::make_unique<CompileJobAction>(std::move(Input),
1378                                                  types::TY_ModuleFile);
1379     if (Args.hasArg(options::OPT_verify_pch))
1380       return llvm::make_unique<VerifyPCHJobAction>(std::move(Input),
1381                                                    types::TY_Nothing);
1382     if (IsUsingLTO(Args)) {
1383       types::ID Output =
1384         Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
1385       return llvm::make_unique<CompileJobAction>(std::move(Input), Output);
1386     }
1387     if (Args.hasArg(options::OPT_emit_llvm)) {
1388       types::ID Output =
1389         Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
1390       return llvm::make_unique<CompileJobAction>(std::move(Input), Output);
1391     }
1392     return llvm::make_unique<CompileJobAction>(std::move(Input),
1393                                                types::TY_PP_Asm);
1394   }
1395   case phases::Assemble:
1396     return llvm::make_unique<AssembleJobAction>(std::move(Input),
1397                                                 types::TY_Object);
1398   }
1399 
1400   llvm_unreachable("invalid phase in ConstructPhaseAction");
1401 }
1402 
1403 bool Driver::IsUsingLTO(const ArgList &Args) const {
1404   if (Args.hasFlag(options::OPT_flto, options::OPT_fno_lto, false))
1405     return true;
1406 
1407   return false;
1408 }
1409 
1410 void Driver::BuildJobs(Compilation &C) const {
1411   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
1412 
1413   Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
1414 
1415   // It is an error to provide a -o option if we are making multiple output
1416   // files.
1417   if (FinalOutput) {
1418     unsigned NumOutputs = 0;
1419     for (ActionList::const_iterator it = C.getActions().begin(),
1420            ie = C.getActions().end(); it != ie; ++it)
1421       if ((*it)->getType() != types::TY_Nothing)
1422         ++NumOutputs;
1423 
1424     if (NumOutputs > 1) {
1425       Diag(clang::diag::err_drv_output_argument_with_multiple_files);
1426       FinalOutput = nullptr;
1427     }
1428   }
1429 
1430   // Collect the list of architectures.
1431   llvm::StringSet<> ArchNames;
1432   if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO()) {
1433     for (ArgList::const_iterator it = C.getArgs().begin(), ie = C.getArgs().end();
1434          it != ie; ++it) {
1435       Arg *A = *it;
1436       if (A->getOption().matches(options::OPT_arch))
1437         ArchNames.insert(A->getValue());
1438     }
1439   }
1440 
1441   for (ActionList::const_iterator it = C.getActions().begin(),
1442          ie = C.getActions().end(); it != ie; ++it) {
1443     Action *A = *it;
1444 
1445     // If we are linking an image for multiple archs then the linker wants
1446     // -arch_multiple and -final_output <final image name>. Unfortunately, this
1447     // doesn't fit in cleanly because we have to pass this information down.
1448     //
1449     // FIXME: This is a hack; find a cleaner way to integrate this into the
1450     // process.
1451     const char *LinkingOutput = nullptr;
1452     if (isa<LipoJobAction>(A)) {
1453       if (FinalOutput)
1454         LinkingOutput = FinalOutput->getValue();
1455       else
1456         LinkingOutput = DefaultImageName.c_str();
1457     }
1458 
1459     InputInfo II;
1460     BuildJobsForAction(C, A, &C.getDefaultToolChain(),
1461                        /*BoundArch*/nullptr,
1462                        /*AtTopLevel*/ true,
1463                        /*MultipleArchs*/ ArchNames.size() > 1,
1464                        /*LinkingOutput*/ LinkingOutput,
1465                        II);
1466   }
1467 
1468   // If the user passed -Qunused-arguments or there were errors, don't warn
1469   // about any unused arguments.
1470   if (Diags.hasErrorOccurred() ||
1471       C.getArgs().hasArg(options::OPT_Qunused_arguments))
1472     return;
1473 
1474   // Claim -### here.
1475   (void) C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
1476 
1477   // Claim --driver-mode, it was handled earlier.
1478   (void) C.getArgs().hasArg(options::OPT_driver_mode);
1479 
1480   for (ArgList::const_iterator it = C.getArgs().begin(), ie = C.getArgs().end();
1481        it != ie; ++it) {
1482     Arg *A = *it;
1483 
1484     // FIXME: It would be nice to be able to send the argument to the
1485     // DiagnosticsEngine, so that extra values, position, and so on could be
1486     // printed.
1487     if (!A->isClaimed()) {
1488       if (A->getOption().hasFlag(options::NoArgumentUnused))
1489         continue;
1490 
1491       // Suppress the warning automatically if this is just a flag, and it is an
1492       // instance of an argument we already claimed.
1493       const Option &Opt = A->getOption();
1494       if (Opt.getKind() == Option::FlagClass) {
1495         bool DuplicateClaimed = false;
1496 
1497         for (arg_iterator it = C.getArgs().filtered_begin(&Opt),
1498                ie = C.getArgs().filtered_end(); it != ie; ++it) {
1499           if ((*it)->isClaimed()) {
1500             DuplicateClaimed = true;
1501             break;
1502           }
1503         }
1504 
1505         if (DuplicateClaimed)
1506           continue;
1507       }
1508 
1509       Diag(clang::diag::warn_drv_unused_argument)
1510         << A->getAsString(C.getArgs());
1511     }
1512   }
1513 }
1514 
1515 static const Tool *SelectToolForJob(Compilation &C, const ToolChain *TC,
1516                                     const JobAction *JA,
1517                                     const ActionList *&Inputs) {
1518   const Tool *ToolForJob = nullptr;
1519 
1520   // See if we should look for a compiler with an integrated assembler. We match
1521   // bottom up, so what we are actually looking for is an assembler job with a
1522   // compiler input.
1523 
1524   if (TC->useIntegratedAs() &&
1525       !C.getArgs().hasArg(options::OPT_save_temps) &&
1526       !C.getArgs().hasArg(options::OPT_via_file_asm) &&
1527       !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
1528       !C.getArgs().hasArg(options::OPT__SLASH_Fa) &&
1529       isa<AssembleJobAction>(JA) &&
1530       Inputs->size() == 1 && isa<CompileJobAction>(*Inputs->begin())) {
1531     const Tool *Compiler =
1532       TC->SelectTool(cast<JobAction>(**Inputs->begin()));
1533     if (!Compiler)
1534       return nullptr;
1535     if (Compiler->hasIntegratedAssembler()) {
1536       Inputs = &(*Inputs)[0]->getInputs();
1537       ToolForJob = Compiler;
1538     }
1539   }
1540 
1541   // Otherwise use the tool for the current job.
1542   if (!ToolForJob)
1543     ToolForJob = TC->SelectTool(*JA);
1544 
1545   // See if we should use an integrated preprocessor. We do so when we have
1546   // exactly one input, since this is the only use case we care about
1547   // (irrelevant since we don't support combine yet).
1548   if (Inputs->size() == 1 && isa<PreprocessJobAction>(*Inputs->begin()) &&
1549       !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
1550       !C.getArgs().hasArg(options::OPT_traditional_cpp) &&
1551       !C.getArgs().hasArg(options::OPT_save_temps) &&
1552       !C.getArgs().hasArg(options::OPT_rewrite_objc) &&
1553       ToolForJob->hasIntegratedCPP())
1554     Inputs = &(*Inputs)[0]->getInputs();
1555 
1556   return ToolForJob;
1557 }
1558 
1559 void Driver::BuildJobsForAction(Compilation &C,
1560                                 const Action *A,
1561                                 const ToolChain *TC,
1562                                 const char *BoundArch,
1563                                 bool AtTopLevel,
1564                                 bool MultipleArchs,
1565                                 const char *LinkingOutput,
1566                                 InputInfo &Result) const {
1567   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
1568 
1569   if (const InputAction *IA = dyn_cast<InputAction>(A)) {
1570     // FIXME: It would be nice to not claim this here; maybe the old scheme of
1571     // just using Args was better?
1572     const Arg &Input = IA->getInputArg();
1573     Input.claim();
1574     if (Input.getOption().matches(options::OPT_INPUT)) {
1575       const char *Name = Input.getValue();
1576       Result = InputInfo(Name, A->getType(), Name);
1577     } else
1578       Result = InputInfo(&Input, A->getType(), "");
1579     return;
1580   }
1581 
1582   if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
1583     const ToolChain *TC;
1584     const char *ArchName = BAA->getArchName();
1585 
1586     if (ArchName)
1587       TC = &getToolChain(C.getArgs(), ArchName);
1588     else
1589       TC = &C.getDefaultToolChain();
1590 
1591     BuildJobsForAction(C, *BAA->begin(), TC, BAA->getArchName(),
1592                        AtTopLevel, MultipleArchs, LinkingOutput, Result);
1593     return;
1594   }
1595 
1596   const ActionList *Inputs = &A->getInputs();
1597 
1598   const JobAction *JA = cast<JobAction>(A);
1599   const Tool *T = SelectToolForJob(C, TC, JA, Inputs);
1600   if (!T)
1601     return;
1602 
1603   // Only use pipes when there is exactly one input.
1604   InputInfoList InputInfos;
1605   for (ActionList::const_iterator it = Inputs->begin(), ie = Inputs->end();
1606        it != ie; ++it) {
1607     // Treat dsymutil and verify sub-jobs as being at the top-level too, they
1608     // shouldn't get temporary output names.
1609     // FIXME: Clean this up.
1610     bool SubJobAtTopLevel = false;
1611     if (AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A)))
1612       SubJobAtTopLevel = true;
1613 
1614     InputInfo II;
1615     BuildJobsForAction(C, *it, TC, BoundArch, SubJobAtTopLevel, MultipleArchs,
1616                        LinkingOutput, II);
1617     InputInfos.push_back(II);
1618   }
1619 
1620   // Always use the first input as the base input.
1621   const char *BaseInput = InputInfos[0].getBaseInput();
1622 
1623   // ... except dsymutil actions, which use their actual input as the base
1624   // input.
1625   if (JA->getType() == types::TY_dSYM)
1626     BaseInput = InputInfos[0].getFilename();
1627 
1628   // Determine the place to write output to, if any.
1629   if (JA->getType() == types::TY_Nothing)
1630     Result = InputInfo(A->getType(), BaseInput);
1631   else
1632     Result = InputInfo(GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
1633                                           AtTopLevel, MultipleArchs),
1634                        A->getType(), BaseInput);
1635 
1636   if (CCCPrintBindings && !CCGenDiagnostics) {
1637     llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
1638                  << " - \"" << T->getName() << "\", inputs: [";
1639     for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
1640       llvm::errs() << InputInfos[i].getAsString();
1641       if (i + 1 != e)
1642         llvm::errs() << ", ";
1643     }
1644     llvm::errs() << "], output: " << Result.getAsString() << "\n";
1645   } else {
1646     T->ConstructJob(C, *JA, Result, InputInfos,
1647                     C.getArgsForToolChain(TC, BoundArch), LinkingOutput);
1648   }
1649 }
1650 
1651 /// \brief Create output filename based on ArgValue, which could either be a
1652 /// full filename, filename without extension, or a directory. If ArgValue
1653 /// does not provide a filename, then use BaseName, and use the extension
1654 /// suitable for FileType.
1655 static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
1656                                         StringRef BaseName, types::ID FileType) {
1657   SmallString<128> Filename = ArgValue;
1658 
1659   if (ArgValue.empty()) {
1660     // If the argument is empty, output to BaseName in the current dir.
1661     Filename = BaseName;
1662   } else if (llvm::sys::path::is_separator(Filename.back())) {
1663     // If the argument is a directory, output to BaseName in that dir.
1664     llvm::sys::path::append(Filename, BaseName);
1665   }
1666 
1667   if (!llvm::sys::path::has_extension(ArgValue)) {
1668     // If the argument didn't provide an extension, then set it.
1669     const char *Extension = types::getTypeTempSuffix(FileType, true);
1670 
1671     if (FileType == types::TY_Image &&
1672         Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
1673       // The output file is a dll.
1674       Extension = "dll";
1675     }
1676 
1677     llvm::sys::path::replace_extension(Filename, Extension);
1678   }
1679 
1680   return Args.MakeArgString(Filename.c_str());
1681 }
1682 
1683 const char *Driver::GetNamedOutputPath(Compilation &C,
1684                                        const JobAction &JA,
1685                                        const char *BaseInput,
1686                                        const char *BoundArch,
1687                                        bool AtTopLevel,
1688                                        bool MultipleArchs) const {
1689   llvm::PrettyStackTraceString CrashInfo("Computing output path");
1690   // Output to a user requested destination?
1691   if (AtTopLevel && !isa<DsymutilJobAction>(JA) &&
1692       !isa<VerifyJobAction>(JA)) {
1693     if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
1694       return C.addResultFile(FinalOutput->getValue(), &JA);
1695   }
1696 
1697   // For /P, preprocess to file named after BaseInput.
1698   if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
1699     assert(AtTopLevel && isa<PreprocessJobAction>(JA));
1700     StringRef BaseName = llvm::sys::path::filename(BaseInput);
1701     StringRef NameArg;
1702     if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi,
1703                                         options::OPT__SLASH_o))
1704       NameArg = A->getValue();
1705     return C.addResultFile(MakeCLOutputFilename(C.getArgs(), NameArg, BaseName,
1706                                                 types::TY_PP_C), &JA);
1707   }
1708 
1709   // Default to writing to stdout?
1710   if (AtTopLevel && !CCGenDiagnostics &&
1711       (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile))
1712     return "-";
1713 
1714   // Is this the assembly listing for /FA?
1715   if (JA.getType() == types::TY_PP_Asm &&
1716       (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
1717        C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
1718     // Use /Fa and the input filename to determine the asm file name.
1719     StringRef BaseName = llvm::sys::path::filename(BaseInput);
1720     StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
1721     return C.addResultFile(MakeCLOutputFilename(C.getArgs(), FaValue, BaseName,
1722                                                 JA.getType()), &JA);
1723   }
1724 
1725   // Output to a temporary file?
1726   if ((!AtTopLevel && !C.getArgs().hasArg(options::OPT_save_temps) &&
1727         !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
1728       CCGenDiagnostics) {
1729     StringRef Name = llvm::sys::path::filename(BaseInput);
1730     std::pair<StringRef, StringRef> Split = Name.split('.');
1731     std::string TmpName =
1732       GetTemporaryPath(Split.first,
1733           types::getTypeTempSuffix(JA.getType(), IsCLMode()));
1734     return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
1735   }
1736 
1737   SmallString<128> BasePath(BaseInput);
1738   StringRef BaseName;
1739 
1740   // Dsymutil actions should use the full path.
1741   if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
1742     BaseName = BasePath;
1743   else
1744     BaseName = llvm::sys::path::filename(BasePath);
1745 
1746   // Determine what the derived output name should be.
1747   const char *NamedOutput;
1748 
1749   if (JA.getType() == types::TY_Object &&
1750       C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
1751     // The /Fo or /o flag decides the object filename.
1752     StringRef Val = C.getArgs().getLastArg(options::OPT__SLASH_Fo,
1753                                            options::OPT__SLASH_o)->getValue();
1754     NamedOutput = MakeCLOutputFilename(C.getArgs(), Val, BaseName,
1755                                        types::TY_Object);
1756   } else if (JA.getType() == types::TY_Image &&
1757              C.getArgs().hasArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)) {
1758     // The /Fe or /o flag names the linked file.
1759     StringRef Val = C.getArgs().getLastArg(options::OPT__SLASH_Fe,
1760                                            options::OPT__SLASH_o)->getValue();
1761     NamedOutput = MakeCLOutputFilename(C.getArgs(), Val, BaseName,
1762                                        types::TY_Image);
1763   } else if (JA.getType() == types::TY_Image) {
1764     if (IsCLMode()) {
1765       // clang-cl uses BaseName for the executable name.
1766       NamedOutput = MakeCLOutputFilename(C.getArgs(), "", BaseName,
1767                                          types::TY_Image);
1768     } else if (MultipleArchs && BoundArch) {
1769       SmallString<128> Output(DefaultImageName.c_str());
1770       Output += "-";
1771       Output.append(BoundArch);
1772       NamedOutput = C.getArgs().MakeArgString(Output.c_str());
1773     } else
1774       NamedOutput = DefaultImageName.c_str();
1775   } else {
1776     const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
1777     assert(Suffix && "All types used for output should have a suffix.");
1778 
1779     std::string::size_type End = std::string::npos;
1780     if (!types::appendSuffixForType(JA.getType()))
1781       End = BaseName.rfind('.');
1782     SmallString<128> Suffixed(BaseName.substr(0, End));
1783     if (MultipleArchs && BoundArch) {
1784       Suffixed += "-";
1785       Suffixed.append(BoundArch);
1786     }
1787     Suffixed += '.';
1788     Suffixed += Suffix;
1789     NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
1790   }
1791 
1792   // If we're saving temps and the temp file conflicts with the input file,
1793   // then avoid overwriting input file.
1794   if (!AtTopLevel && C.getArgs().hasArg(options::OPT_save_temps) &&
1795       NamedOutput == BaseName) {
1796 
1797     bool SameFile = false;
1798     SmallString<256> Result;
1799     llvm::sys::fs::current_path(Result);
1800     llvm::sys::path::append(Result, BaseName);
1801     llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
1802     // Must share the same path to conflict.
1803     if (SameFile) {
1804       StringRef Name = llvm::sys::path::filename(BaseInput);
1805       std::pair<StringRef, StringRef> Split = Name.split('.');
1806       std::string TmpName =
1807         GetTemporaryPath(Split.first,
1808             types::getTypeTempSuffix(JA.getType(), IsCLMode()));
1809       return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
1810     }
1811   }
1812 
1813   // As an annoying special case, PCH generation doesn't strip the pathname.
1814   if (JA.getType() == types::TY_PCH) {
1815     llvm::sys::path::remove_filename(BasePath);
1816     if (BasePath.empty())
1817       BasePath = NamedOutput;
1818     else
1819       llvm::sys::path::append(BasePath, NamedOutput);
1820     return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
1821   } else {
1822     return C.addResultFile(NamedOutput, &JA);
1823   }
1824 }
1825 
1826 std::string Driver::GetFilePath(const char *Name, const ToolChain &TC) const {
1827   // Respect a limited subset of the '-Bprefix' functionality in GCC by
1828   // attempting to use this prefix when looking for file paths.
1829   for (Driver::prefix_list::const_iterator it = PrefixDirs.begin(),
1830        ie = PrefixDirs.end(); it != ie; ++it) {
1831     std::string Dir(*it);
1832     if (Dir.empty())
1833       continue;
1834     if (Dir[0] == '=')
1835       Dir = SysRoot + Dir.substr(1);
1836     SmallString<128> P(Dir);
1837     llvm::sys::path::append(P, Name);
1838     if (llvm::sys::fs::exists(Twine(P)))
1839       return P.str();
1840   }
1841 
1842   SmallString<128> P(ResourceDir);
1843   llvm::sys::path::append(P, Name);
1844   if (llvm::sys::fs::exists(Twine(P)))
1845     return P.str();
1846 
1847   const ToolChain::path_list &List = TC.getFilePaths();
1848   for (ToolChain::path_list::const_iterator
1849          it = List.begin(), ie = List.end(); it != ie; ++it) {
1850     std::string Dir(*it);
1851     if (Dir.empty())
1852       continue;
1853     if (Dir[0] == '=')
1854       Dir = SysRoot + Dir.substr(1);
1855     SmallString<128> P(Dir);
1856     llvm::sys::path::append(P, Name);
1857     if (llvm::sys::fs::exists(Twine(P)))
1858       return P.str();
1859   }
1860 
1861   return Name;
1862 }
1863 
1864 std::string Driver::GetProgramPath(const char *Name,
1865                                    const ToolChain &TC) const {
1866   // FIXME: Needs a better variable than DefaultTargetTriple
1867   std::string TargetSpecificExecutable(DefaultTargetTriple + "-" + Name);
1868   // Respect a limited subset of the '-Bprefix' functionality in GCC by
1869   // attempting to use this prefix when looking for program paths.
1870   for (const auto &PrefixDir : PrefixDirs) {
1871     if (llvm::sys::fs::is_directory(PrefixDir)) {
1872       SmallString<128> P(PrefixDir);
1873       llvm::sys::path::append(P, TargetSpecificExecutable);
1874       if (llvm::sys::fs::can_execute(Twine(P)))
1875         return P.str();
1876       llvm::sys::path::remove_filename(P);
1877       llvm::sys::path::append(P, Name);
1878       if (llvm::sys::fs::can_execute(Twine(P)))
1879         return P.str();
1880     } else {
1881       SmallString<128> P(PrefixDir + Name);
1882       if (llvm::sys::fs::can_execute(Twine(P)))
1883         return P.str();
1884     }
1885   }
1886 
1887   const ToolChain::path_list &List = TC.getProgramPaths();
1888   for (const auto &Path : List) {
1889     SmallString<128> P(Path);
1890     llvm::sys::path::append(P, TargetSpecificExecutable);
1891     if (llvm::sys::fs::can_execute(Twine(P)))
1892       return P.str();
1893     llvm::sys::path::remove_filename(P);
1894     llvm::sys::path::append(P, Name);
1895     if (llvm::sys::fs::can_execute(Twine(P)))
1896       return P.str();
1897   }
1898 
1899   // If all else failed, search the path.
1900   std::string P(llvm::sys::FindProgramByName(TargetSpecificExecutable));
1901   if (!P.empty())
1902     return P;
1903 
1904   P = llvm::sys::FindProgramByName(Name);
1905   if (!P.empty())
1906     return P;
1907 
1908   return Name;
1909 }
1910 
1911 std::string Driver::GetTemporaryPath(StringRef Prefix, const char *Suffix)
1912   const {
1913   SmallString<128> Path;
1914   std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
1915   if (EC) {
1916     Diag(clang::diag::err_unable_to_make_temp) << EC.message();
1917     return "";
1918   }
1919 
1920   return Path.str();
1921 }
1922 
1923 /// \brief Compute target triple from args.
1924 ///
1925 /// This routine provides the logic to compute a target triple from various
1926 /// args passed to the driver and the default triple string.
1927 static llvm::Triple computeTargetTriple(StringRef DefaultTargetTriple,
1928                                         const ArgList &Args,
1929                                         StringRef DarwinArchName) {
1930   // FIXME: Already done in Compilation *Driver::BuildCompilation
1931   if (const Arg *A = Args.getLastArg(options::OPT_target))
1932     DefaultTargetTriple = A->getValue();
1933 
1934   llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
1935 
1936   // Handle Apple-specific options available here.
1937   if (Target.isOSBinFormatMachO()) {
1938     // If an explict Darwin arch name is given, that trumps all.
1939     if (!DarwinArchName.empty()) {
1940       tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
1941       return Target;
1942     }
1943 
1944     // Handle the Darwin '-arch' flag.
1945     if (Arg *A = Args.getLastArg(options::OPT_arch)) {
1946       StringRef ArchName = A->getValue();
1947       tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
1948     }
1949   }
1950 
1951   // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
1952   // '-mbig-endian'/'-EB'.
1953   if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
1954                                options::OPT_mbig_endian)) {
1955     if (A->getOption().matches(options::OPT_mlittle_endian)) {
1956       if (Target.getArch() == llvm::Triple::mips)
1957         Target.setArch(llvm::Triple::mipsel);
1958       else if (Target.getArch() == llvm::Triple::mips64)
1959         Target.setArch(llvm::Triple::mips64el);
1960       else if (Target.getArch() == llvm::Triple::aarch64_be)
1961         Target.setArch(llvm::Triple::aarch64);
1962     } else {
1963       if (Target.getArch() == llvm::Triple::mipsel)
1964         Target.setArch(llvm::Triple::mips);
1965       else if (Target.getArch() == llvm::Triple::mips64el)
1966         Target.setArch(llvm::Triple::mips64);
1967       else if (Target.getArch() == llvm::Triple::aarch64)
1968         Target.setArch(llvm::Triple::aarch64_be);
1969     }
1970   }
1971 
1972   // Skip further flag support on OSes which don't support '-m32' or '-m64'.
1973   if (Target.getArchName() == "tce" || Target.getOS() == llvm::Triple::Minix)
1974     return Target;
1975 
1976   // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
1977   if (Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
1978                                options::OPT_m32, options::OPT_m16)) {
1979     llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
1980 
1981     if (A->getOption().matches(options::OPT_m64)) {
1982       AT = Target.get64BitArchVariant().getArch();
1983       if (Target.getEnvironment() == llvm::Triple::GNUX32)
1984         Target.setEnvironment(llvm::Triple::GNU);
1985     } else if (A->getOption().matches(options::OPT_mx32) &&
1986              Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
1987       AT = llvm::Triple::x86_64;
1988       Target.setEnvironment(llvm::Triple::GNUX32);
1989     } else if (A->getOption().matches(options::OPT_m32)) {
1990       AT = Target.get32BitArchVariant().getArch();
1991       if (Target.getEnvironment() == llvm::Triple::GNUX32)
1992         Target.setEnvironment(llvm::Triple::GNU);
1993     } else if (A->getOption().matches(options::OPT_m16) &&
1994              Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
1995       AT = llvm::Triple::x86;
1996       Target.setEnvironment(llvm::Triple::CODE16);
1997     }
1998 
1999     if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
2000       Target.setArch(AT);
2001   }
2002 
2003   return Target;
2004 }
2005 
2006 const ToolChain &Driver::getToolChain(const ArgList &Args,
2007                                       StringRef DarwinArchName) const {
2008   llvm::Triple Target = computeTargetTriple(DefaultTargetTriple, Args,
2009                                             DarwinArchName);
2010 
2011   ToolChain *&TC = ToolChains[Target.str()];
2012   if (!TC) {
2013     switch (Target.getOS()) {
2014     case llvm::Triple::Darwin:
2015     case llvm::Triple::MacOSX:
2016     case llvm::Triple::IOS:
2017       TC = new toolchains::DarwinClang(*this, Target, Args);
2018       break;
2019     case llvm::Triple::DragonFly:
2020       TC = new toolchains::DragonFly(*this, Target, Args);
2021       break;
2022     case llvm::Triple::OpenBSD:
2023       TC = new toolchains::OpenBSD(*this, Target, Args);
2024       break;
2025     case llvm::Triple::Bitrig:
2026       TC = new toolchains::Bitrig(*this, Target, Args);
2027       break;
2028     case llvm::Triple::NetBSD:
2029       TC = new toolchains::NetBSD(*this, Target, Args);
2030       break;
2031     case llvm::Triple::FreeBSD:
2032       TC = new toolchains::FreeBSD(*this, Target, Args);
2033       break;
2034     case llvm::Triple::Minix:
2035       TC = new toolchains::Minix(*this, Target, Args);
2036       break;
2037     case llvm::Triple::Linux:
2038       if (Target.getArch() == llvm::Triple::hexagon)
2039         TC = new toolchains::Hexagon_TC(*this, Target, Args);
2040       else
2041         TC = new toolchains::Linux(*this, Target, Args);
2042       break;
2043     case llvm::Triple::Solaris:
2044       TC = new toolchains::Solaris(*this, Target, Args);
2045       break;
2046     case llvm::Triple::Win32:
2047       switch (Target.getEnvironment()) {
2048       default:
2049         if (Target.isOSBinFormatELF())
2050           TC = new toolchains::Generic_ELF(*this, Target, Args);
2051         else if (Target.isOSBinFormatMachO())
2052           TC = new toolchains::MachO(*this, Target, Args);
2053         else
2054           TC = new toolchains::Generic_GCC(*this, Target, Args);
2055         break;
2056       case llvm::Triple::GNU:
2057         // FIXME: We need a MinGW toolchain.  Use the default Generic_GCC
2058         // toolchain for now as the default case would below otherwise.
2059         if (Target.isOSBinFormatELF())
2060           TC = new toolchains::Generic_ELF(*this, Target, Args);
2061         else
2062           TC = new toolchains::Generic_GCC(*this, Target, Args);
2063         break;
2064       case llvm::Triple::MSVC:
2065       case llvm::Triple::UnknownEnvironment:
2066         TC = new toolchains::Windows(*this, Target, Args);
2067         break;
2068       }
2069       break;
2070     default:
2071       // TCE is an OSless target
2072       if (Target.getArchName() == "tce") {
2073         TC = new toolchains::TCEToolChain(*this, Target, Args);
2074         break;
2075       }
2076       // If Hexagon is configured as an OSless target
2077       if (Target.getArch() == llvm::Triple::hexagon) {
2078         TC = new toolchains::Hexagon_TC(*this, Target, Args);
2079         break;
2080       }
2081       if (Target.getArch() == llvm::Triple::xcore) {
2082         TC = new toolchains::XCore(*this, Target, Args);
2083         break;
2084       }
2085       if (Target.isOSBinFormatELF()) {
2086         TC = new toolchains::Generic_ELF(*this, Target, Args);
2087         break;
2088       }
2089       if (Target.getObjectFormat() == llvm::Triple::MachO) {
2090         TC = new toolchains::MachO(*this, Target, Args);
2091         break;
2092       }
2093       TC = new toolchains::Generic_GCC(*this, Target, Args);
2094       break;
2095     }
2096   }
2097   return *TC;
2098 }
2099 
2100 bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
2101   // Check if user requested no clang, or clang doesn't understand this type (we
2102   // only handle single inputs for now).
2103   if (JA.size() != 1 ||
2104       !types::isAcceptedByClang((*JA.begin())->getType()))
2105     return false;
2106 
2107   // Otherwise make sure this is an action clang understands.
2108   if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
2109       !isa<CompileJobAction>(JA))
2110     return false;
2111 
2112   return true;
2113 }
2114 
2115 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
2116 /// grouped values as integers. Numbers which are not provided are set to 0.
2117 ///
2118 /// \return True if the entire string was parsed (9.2), or all groups were
2119 /// parsed (10.3.5extrastuff).
2120 bool Driver::GetReleaseVersion(const char *Str, unsigned &Major,
2121                                unsigned &Minor, unsigned &Micro,
2122                                bool &HadExtra) {
2123   HadExtra = false;
2124 
2125   Major = Minor = Micro = 0;
2126   if (*Str == '\0')
2127     return true;
2128 
2129   char *End;
2130   Major = (unsigned) strtol(Str, &End, 10);
2131   if (*Str != '\0' && *End == '\0')
2132     return true;
2133   if (*End != '.')
2134     return false;
2135 
2136   Str = End+1;
2137   Minor = (unsigned) strtol(Str, &End, 10);
2138   if (*Str != '\0' && *End == '\0')
2139     return true;
2140   if (*End != '.')
2141     return false;
2142 
2143   Str = End+1;
2144   Micro = (unsigned) strtol(Str, &End, 10);
2145   if (*Str != '\0' && *End == '\0')
2146     return true;
2147   if (Str == End)
2148     return false;
2149   HadExtra = true;
2150   return true;
2151 }
2152 
2153 std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
2154   unsigned IncludedFlagsBitmask = 0;
2155   unsigned ExcludedFlagsBitmask = options::NoDriverOption;
2156 
2157   if (Mode == CLMode) {
2158     // Include CL and Core options.
2159     IncludedFlagsBitmask |= options::CLOption;
2160     IncludedFlagsBitmask |= options::CoreOption;
2161   } else {
2162     ExcludedFlagsBitmask |= options::CLOption;
2163   }
2164 
2165   return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
2166 }
2167 
2168 bool clang::driver::isOptimizationLevelFast(const llvm::opt::ArgList &Args) {
2169   return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
2170 }
2171