Driver.cpp revision 54d76db0aa7107597cac0b80d8e138a37e6d1de9 
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
12#include "clang/Driver/Action.h"
13#include "clang/Driver/Arg.h"
14#include "clang/Driver/ArgList.h"
15#include "clang/Driver/Compilation.h"
16#include "clang/Driver/DriverDiagnostic.h"
17#include "clang/Driver/HostInfo.h"
18#include "clang/Driver/Job.h"
19#include "clang/Driver/OptTable.h"
20#include "clang/Driver/Option.h"
21#include "clang/Driver/Options.h"
22#include "clang/Driver/Tool.h"
23#include "clang/Driver/ToolChain.h"
24#include "clang/Driver/Types.h"
25
26#include "clang/Basic/Version.h"
27
28#include "llvm/ADT/StringSet.h"
29#include "llvm/Support/PrettyStackTrace.h"
30#include "llvm/Support/raw_ostream.h"
31#include "llvm/System/Path.h"
32#include "llvm/System/Program.h"
33
34#include "InputInfo.h"
35
36#include <map>
37
38using namespace clang::driver;
39using namespace clang;
40
41// Used to set values for "production" clang, for releases.
42// #define USE_PRODUCTION_CLANG
43
44Driver::Driver(llvm::StringRef _Name, llvm::StringRef _Dir,
45               llvm::StringRef _DefaultHostTriple,
46               llvm::StringRef _DefaultImageName,
47               bool IsProduction, Diagnostic &_Diags)
48  : Opts(createDriverOptTable()), Diags(_Diags),
49    Name(_Name), Dir(_Dir), DefaultHostTriple(_DefaultHostTriple),
50    DefaultImageName(_DefaultImageName),
51    Host(0),
52    CCCIsCXX(false), CCCEcho(false), CCCPrintBindings(false),
53    CCCGenericGCCName("gcc"), CCCUseClang(true),
54    CCCUseClangCXX(true), CCCUseClangCPP(true), CCCUsePCH(true),
55    SuppressMissingInputWarning(false) {
56  if (IsProduction) {
57    // In a "production" build, only use clang on architectures we expect to
58    // work, and don't use clang C++.
59    //
60    // During development its more convenient to always have the driver use
61    // clang, but we don't want users to be confused when things don't work, or
62    // to file bugs for things we don't support.
63    CCCClangArchs.insert(llvm::Triple::x86);
64    CCCClangArchs.insert(llvm::Triple::x86_64);
65    CCCClangArchs.insert(llvm::Triple::arm);
66
67    CCCUseClangCXX = false;
68  }
69}
70
71Driver::~Driver() {
72  delete Opts;
73  delete Host;
74}
75
76InputArgList *Driver::ParseArgStrings(const char **ArgBegin,
77                                      const char **ArgEnd) {
78  llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
79  unsigned MissingArgIndex, MissingArgCount;
80  InputArgList *Args = getOpts().ParseArgs(ArgBegin, ArgEnd,
81                                           MissingArgIndex, MissingArgCount);
82
83  // Check for missing argument error.
84  if (MissingArgCount)
85    Diag(clang::diag::err_drv_missing_argument)
86      << Args->getArgString(MissingArgIndex) << MissingArgCount;
87
88  // Check for unsupported options.
89  for (ArgList::const_iterator it = Args->begin(), ie = Args->end();
90       it != ie; ++it) {
91    Arg *A = *it;
92    if (A->getOption().isUnsupported()) {
93      Diag(clang::diag::err_drv_unsupported_opt) << A->getAsString(*Args);
94      continue;
95    }
96  }
97
98  return Args;
99}
100
101Compilation *Driver::BuildCompilation(int argc, const char **argv) {
102  llvm::PrettyStackTraceString CrashInfo("Compilation construction");
103
104  // FIXME: Handle environment options which effect driver behavior, somewhere
105  // (client?). GCC_EXEC_PREFIX, COMPILER_PATH, LIBRARY_PATH, LPATH,
106  // CC_PRINT_OPTIONS.
107
108  // FIXME: What are we going to do with -V and -b?
109
110  // FIXME: This stuff needs to go into the Compilation, not the driver.
111  bool CCCPrintOptions = false, CCCPrintActions = false;
112
113  const char **Start = argv + 1, **End = argv + argc;
114  const char *HostTriple = DefaultHostTriple.c_str();
115
116  InputArgList *Args = ParseArgStrings(Start, End);
117
118  // -no-canonical-prefixes is used very early in main.
119  Args->ClaimAllArgs(options::OPT_no_canonical_prefixes);
120
121  // Extract -ccc args.
122  //
123  // FIXME: We need to figure out where this behavior should live. Most of it
124  // should be outside in the client; the parts that aren't should have proper
125  // options, either by introducing new ones or by overloading gcc ones like -V
126  // or -b.
127  CCCPrintOptions = Args->hasArg(options::OPT_ccc_print_options);
128  CCCPrintActions = Args->hasArg(options::OPT_ccc_print_phases);
129  CCCPrintBindings = Args->hasArg(options::OPT_ccc_print_bindings);
130  CCCIsCXX = Args->hasArg(options::OPT_ccc_cxx) || CCCIsCXX;
131  CCCEcho = Args->hasArg(options::OPT_ccc_echo);
132  if (const Arg *A = Args->getLastArg(options::OPT_ccc_gcc_name))
133    CCCGenericGCCName = A->getValue(*Args);
134  CCCUseClangCXX = Args->hasFlag(options::OPT_ccc_clang_cxx,
135                                 options::OPT_ccc_no_clang_cxx,
136                                 CCCUseClangCXX);
137  CCCUsePCH = Args->hasFlag(options::OPT_ccc_pch_is_pch,
138                            options::OPT_ccc_pch_is_pth);
139  CCCUseClang = !Args->hasArg(options::OPT_ccc_no_clang);
140  CCCUseClangCPP = !Args->hasArg(options::OPT_ccc_no_clang_cpp);
141  if (const Arg *A = Args->getLastArg(options::OPT_ccc_clang_archs)) {
142    llvm::StringRef Cur = A->getValue(*Args);
143
144    CCCClangArchs.clear();
145    while (!Cur.empty()) {
146      std::pair<llvm::StringRef, llvm::StringRef> Split = Cur.split(',');
147
148      if (!Split.first.empty()) {
149        llvm::Triple::ArchType Arch =
150          llvm::Triple(Split.first, "", "").getArch();
151
152        if (Arch == llvm::Triple::UnknownArch) {
153          Diag(clang::diag::err_drv_invalid_arch_name) << Arch;
154          continue;
155        }
156
157        CCCClangArchs.insert(Arch);
158      }
159
160      Cur = Split.second;
161    }
162  }
163  if (const Arg *A = Args->getLastArg(options::OPT_ccc_host_triple))
164    HostTriple = A->getValue(*Args);
165  if (const Arg *A = Args->getLastArg(options::OPT_ccc_install_dir))
166    Dir = A->getValue(*Args);
167
168  Host = GetHostInfo(HostTriple);
169
170  // The compilation takes ownership of Args.
171  Compilation *C = new Compilation(*this, *Host->CreateToolChain(*Args), Args);
172
173  // FIXME: This behavior shouldn't be here.
174  if (CCCPrintOptions) {
175    PrintOptions(C->getArgs());
176    return C;
177  }
178
179  if (!HandleImmediateArgs(*C))
180    return C;
181
182  // Construct the list of abstract actions to perform for this compilation. We
183  // avoid passing a Compilation here simply to enforce the abstraction that
184  // pipelining is not host or toolchain dependent (other than the driver driver
185  // test).
186  if (Host->useDriverDriver())
187    BuildUniversalActions(C->getArgs(), C->getActions());
188  else
189    BuildActions(C->getArgs(), C->getActions());
190
191  if (CCCPrintActions) {
192    PrintActions(*C);
193    return C;
194  }
195
196  BuildJobs(*C);
197
198  return C;
199}
200
201int Driver::ExecuteCompilation(const Compilation &C) const {
202  // Just print if -### was present.
203  if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
204    C.PrintJob(llvm::errs(), C.getJobs(), "\n", true);
205    return 0;
206  }
207
208  // If there were errors building the compilation, quit now.
209  if (getDiags().getNumErrors())
210    return 1;
211
212  const Command *FailingCommand = 0;
213  int Res = C.ExecuteJob(C.getJobs(), FailingCommand);
214
215  // Remove temp files.
216  C.CleanupFileList(C.getTempFiles());
217
218  // If the compilation failed, remove result files as well.
219  if (Res != 0 && !C.getArgs().hasArg(options::OPT_save_temps))
220    C.CleanupFileList(C.getResultFiles(), true);
221
222  // Print extra information about abnormal failures, if possible.
223  if (Res) {
224    // This is ad-hoc, but we don't want to be excessively noisy. If the result
225    // status was 1, assume the command failed normally. In particular, if it
226    // was the compiler then assume it gave a reasonable error code. Failures in
227    // other tools are less common, and they generally have worse diagnostics,
228    // so always print the diagnostic there.
229    const Action &Source = FailingCommand->getSource();
230    bool IsFriendlyTool = (isa<PreprocessJobAction>(Source) ||
231                           isa<PrecompileJobAction>(Source) ||
232                           isa<AnalyzeJobAction>(Source) ||
233                           isa<CompileJobAction>(Source));
234
235    if (!IsFriendlyTool || Res != 1) {
236      // FIXME: See FIXME above regarding result code interpretation.
237      if (Res < 0)
238        Diag(clang::diag::err_drv_command_signalled)
239          << Source.getClassName() << -Res;
240      else
241        Diag(clang::diag::err_drv_command_failed)
242          << Source.getClassName() << Res;
243    }
244  }
245
246  return Res;
247}
248
249void Driver::PrintOptions(const ArgList &Args) const {
250  unsigned i = 0;
251  for (ArgList::const_iterator it = Args.begin(), ie = Args.end();
252       it != ie; ++it, ++i) {
253    Arg *A = *it;
254    llvm::errs() << "Option " << i << " - "
255                 << "Name: \"" << A->getOption().getName() << "\", "
256                 << "Values: {";
257    for (unsigned j = 0; j < A->getNumValues(); ++j) {
258      if (j)
259        llvm::errs() << ", ";
260      llvm::errs() << '"' << A->getValue(Args, j) << '"';
261    }
262    llvm::errs() << "}\n";
263  }
264}
265
266// FIXME: Move -ccc options to real options in the .td file (or eliminate), and
267// then move to using OptTable::PrintHelp.
268void Driver::PrintHelp(bool ShowHidden) const {
269  getOpts().PrintHelp(llvm::outs(), Name.c_str(),
270                      "clang \"gcc-compatible\" driver", ShowHidden);
271}
272
273void Driver::PrintVersion(const Compilation &C, llvm::raw_ostream &OS) const {
274  // FIXME: The following handlers should use a callback mechanism, we don't
275  // know what the client would like to do.
276#ifdef CLANG_VENDOR
277  OS << CLANG_VENDOR;
278#endif
279  OS << "clang version " CLANG_VERSION_STRING " ("
280     << getClangSubversionPath();
281  if (unsigned Revision = getClangSubversionRevision())
282    OS << " " << Revision;
283  OS << ")" << '\n';
284
285  const ToolChain &TC = C.getDefaultToolChain();
286  OS << "Target: " << TC.getTripleString() << '\n';
287
288  // Print the threading model.
289  //
290  // FIXME: Implement correctly.
291  OS << "Thread model: " << "posix" << '\n';
292}
293
294bool Driver::HandleImmediateArgs(const Compilation &C) {
295  // The order these options are handled in in gcc is all over the place, but we
296  // don't expect inconsistencies w.r.t. that to matter in practice.
297
298  if (C.getArgs().hasArg(options::OPT_dumpversion)) {
299    llvm::outs() << CLANG_VERSION_STRING "\n";
300    return false;
301  }
302
303  if (C.getArgs().hasArg(options::OPT__help) ||
304      C.getArgs().hasArg(options::OPT__help_hidden)) {
305    PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
306    return false;
307  }
308
309  if (C.getArgs().hasArg(options::OPT__version)) {
310    // Follow gcc behavior and use stdout for --version and stderr for -v.
311    PrintVersion(C, llvm::outs());
312    return false;
313  }
314
315  if (C.getArgs().hasArg(options::OPT_v) ||
316      C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
317    PrintVersion(C, llvm::errs());
318    SuppressMissingInputWarning = true;
319  }
320
321  const ToolChain &TC = C.getDefaultToolChain();
322  if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
323    llvm::outs() << "programs: =";
324    for (ToolChain::path_list::const_iterator it = TC.getProgramPaths().begin(),
325           ie = TC.getProgramPaths().end(); it != ie; ++it) {
326      if (it != TC.getProgramPaths().begin())
327        llvm::outs() << ':';
328      llvm::outs() << *it;
329    }
330    llvm::outs() << "\n";
331    llvm::outs() << "libraries: =";
332    for (ToolChain::path_list::const_iterator it = TC.getFilePaths().begin(),
333           ie = TC.getFilePaths().end(); it != ie; ++it) {
334      if (it != TC.getFilePaths().begin())
335        llvm::outs() << ':';
336      llvm::outs() << *it;
337    }
338    llvm::outs() << "\n";
339    return false;
340  }
341
342  // FIXME: The following handlers should use a callback mechanism, we don't
343  // know what the client would like to do.
344  if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
345    llvm::outs() << GetFilePath(A->getValue(C.getArgs()), TC) << "\n";
346    return false;
347  }
348
349  if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
350    llvm::outs() << GetProgramPath(A->getValue(C.getArgs()), TC) << "\n";
351    return false;
352  }
353
354  if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
355    llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
356    return false;
357  }
358
359  if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
360    // FIXME: We need tool chain support for this.
361    llvm::outs() << ".;\n";
362
363    switch (C.getDefaultToolChain().getTriple().getArch()) {
364    default:
365      break;
366
367    case llvm::Triple::x86_64:
368      llvm::outs() << "x86_64;@m64" << "\n";
369      break;
370
371    case llvm::Triple::ppc64:
372      llvm::outs() << "ppc64;@m64" << "\n";
373      break;
374    }
375    return false;
376  }
377
378  // FIXME: What is the difference between print-multi-directory and
379  // print-multi-os-directory?
380  if (C.getArgs().hasArg(options::OPT_print_multi_directory) ||
381      C.getArgs().hasArg(options::OPT_print_multi_os_directory)) {
382    switch (C.getDefaultToolChain().getTriple().getArch()) {
383    default:
384    case llvm::Triple::x86:
385    case llvm::Triple::ppc:
386      llvm::outs() << "." << "\n";
387      break;
388
389    case llvm::Triple::x86_64:
390      llvm::outs() << "x86_64" << "\n";
391      break;
392
393    case llvm::Triple::ppc64:
394      llvm::outs() << "ppc64" << "\n";
395      break;
396    }
397    return false;
398  }
399
400  return true;
401}
402
403static unsigned PrintActions1(const Compilation &C, Action *A,
404                              std::map<Action*, unsigned> &Ids) {
405  if (Ids.count(A))
406    return Ids[A];
407
408  std::string str;
409  llvm::raw_string_ostream os(str);
410
411  os << Action::getClassName(A->getKind()) << ", ";
412  if (InputAction *IA = dyn_cast<InputAction>(A)) {
413    os << "\"" << IA->getInputArg().getValue(C.getArgs()) << "\"";
414  } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
415    os << '"' << (BIA->getArchName() ? BIA->getArchName() :
416                  C.getDefaultToolChain().getArchName()) << '"'
417       << ", {" << PrintActions1(C, *BIA->begin(), Ids) << "}";
418  } else {
419    os << "{";
420    for (Action::iterator it = A->begin(), ie = A->end(); it != ie;) {
421      os << PrintActions1(C, *it, Ids);
422      ++it;
423      if (it != ie)
424        os << ", ";
425    }
426    os << "}";
427  }
428
429  unsigned Id = Ids.size();
430  Ids[A] = Id;
431  llvm::errs() << Id << ": " << os.str() << ", "
432               << types::getTypeName(A->getType()) << "\n";
433
434  return Id;
435}
436
437void Driver::PrintActions(const Compilation &C) const {
438  std::map<Action*, unsigned> Ids;
439  for (ActionList::const_iterator it = C.getActions().begin(),
440         ie = C.getActions().end(); it != ie; ++it)
441    PrintActions1(C, *it, Ids);
442}
443
444void Driver::BuildUniversalActions(const ArgList &Args,
445                                   ActionList &Actions) const {
446  llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
447  // Collect the list of architectures. Duplicates are allowed, but should only
448  // be handled once (in the order seen).
449  llvm::StringSet<> ArchNames;
450  llvm::SmallVector<const char *, 4> Archs;
451  for (ArgList::const_iterator it = Args.begin(), ie = Args.end();
452       it != ie; ++it) {
453    Arg *A = *it;
454
455    if (A->getOption().matches(options::OPT_arch)) {
456      // Validate the option here; we don't save the type here because its
457      // particular spelling may participate in other driver choices.
458      llvm::Triple::ArchType Arch =
459        llvm::Triple::getArchTypeForDarwinArchName(A->getValue(Args));
460      if (Arch == llvm::Triple::UnknownArch) {
461        Diag(clang::diag::err_drv_invalid_arch_name)
462          << A->getAsString(Args);
463        continue;
464      }
465
466      A->claim();
467      if (ArchNames.insert(A->getValue(Args)))
468        Archs.push_back(A->getValue(Args));
469    }
470  }
471
472  // When there is no explicit arch for this platform, make sure we still bind
473  // the architecture (to the default) so that -Xarch_ is handled correctly.
474  if (!Archs.size())
475    Archs.push_back(0);
476
477  // FIXME: We killed off some others but these aren't yet detected in a
478  // functional manner. If we added information to jobs about which "auxiliary"
479  // files they wrote then we could detect the conflict these cause downstream.
480  if (Archs.size() > 1) {
481    // No recovery needed, the point of this is just to prevent
482    // overwriting the same files.
483    if (const Arg *A = Args.getLastArg(options::OPT_save_temps))
484      Diag(clang::diag::err_drv_invalid_opt_with_multiple_archs)
485        << A->getAsString(Args);
486  }
487
488  ActionList SingleActions;
489  BuildActions(Args, SingleActions);
490
491  // Add in arch binding and lipo (if necessary) for every top level action.
492  for (unsigned i = 0, e = SingleActions.size(); i != e; ++i) {
493    Action *Act = SingleActions[i];
494
495    // Make sure we can lipo this kind of output. If not (and it is an actual
496    // output) then we disallow, since we can't create an output file with the
497    // right name without overwriting it. We could remove this oddity by just
498    // changing the output names to include the arch, which would also fix
499    // -save-temps. Compatibility wins for now.
500
501    if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
502      Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
503        << types::getTypeName(Act->getType());
504
505    ActionList Inputs;
506    for (unsigned i = 0, e = Archs.size(); i != e; ++i)
507      Inputs.push_back(new BindArchAction(Act, Archs[i]));
508
509    // Lipo if necessary, we do it this way because we need to set the arch flag
510    // so that -Xarch_ gets overwritten.
511    if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
512      Actions.append(Inputs.begin(), Inputs.end());
513    else
514      Actions.push_back(new LipoJobAction(Inputs, Act->getType()));
515  }
516}
517
518void Driver::BuildActions(const ArgList &Args, ActionList &Actions) const {
519  llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
520  // Start by constructing the list of inputs and their types.
521
522  // Track the current user specified (-x) input. We also explicitly track the
523  // argument used to set the type; we only want to claim the type when we
524  // actually use it, so we warn about unused -x arguments.
525  types::ID InputType = types::TY_Nothing;
526  Arg *InputTypeArg = 0;
527
528  llvm::SmallVector<std::pair<types::ID, const Arg*>, 16> Inputs;
529  for (ArgList::const_iterator it = Args.begin(), ie = Args.end();
530       it != ie; ++it) {
531    Arg *A = *it;
532
533    if (isa<InputOption>(A->getOption())) {
534      const char *Value = A->getValue(Args);
535      types::ID Ty = types::TY_INVALID;
536
537      // Infer the input type if necessary.
538      if (InputType == types::TY_Nothing) {
539        // If there was an explicit arg for this, claim it.
540        if (InputTypeArg)
541          InputTypeArg->claim();
542
543        // stdin must be handled specially.
544        if (memcmp(Value, "-", 2) == 0) {
545          // If running with -E, treat as a C input (this changes the builtin
546          // macros, for example). This may be overridden by -ObjC below.
547          //
548          // Otherwise emit an error but still use a valid type to avoid
549          // spurious errors (e.g., no inputs).
550          if (!Args.hasArgNoClaim(options::OPT_E))
551            Diag(clang::diag::err_drv_unknown_stdin_type);
552          Ty = types::TY_C;
553        } else {
554          // Otherwise lookup by extension, and fallback to ObjectType if not
555          // found. We use a host hook here because Darwin at least has its own
556          // idea of what .s is.
557          if (const char *Ext = strrchr(Value, '.'))
558            Ty = Host->lookupTypeForExtension(Ext + 1);
559
560          if (Ty == types::TY_INVALID)
561            Ty = types::TY_Object;
562        }
563
564        // -ObjC and -ObjC++ override the default language, but only for "source
565        // files". We just treat everything that isn't a linker input as a
566        // source file.
567        //
568        // FIXME: Clean this up if we move the phase sequence into the type.
569        if (Ty != types::TY_Object) {
570          if (Args.hasArg(options::OPT_ObjC))
571            Ty = types::TY_ObjC;
572          else if (Args.hasArg(options::OPT_ObjCXX))
573            Ty = types::TY_ObjCXX;
574        }
575      } else {
576        assert(InputTypeArg && "InputType set w/o InputTypeArg");
577        InputTypeArg->claim();
578        Ty = InputType;
579      }
580
581      // Check that the file exists. It isn't clear this is worth doing, since
582      // the tool presumably does this anyway, and this just adds an extra stat
583      // to the equation, but this is gcc compatible.
584      if (memcmp(Value, "-", 2) != 0 && !llvm::sys::Path(Value).exists())
585        Diag(clang::diag::err_drv_no_such_file) << A->getValue(Args);
586      else
587        Inputs.push_back(std::make_pair(Ty, A));
588
589    } else if (A->getOption().isLinkerInput()) {
590      // Just treat as object type, we could make a special type for this if
591      // necessary.
592      Inputs.push_back(std::make_pair(types::TY_Object, A));
593
594    } else if (A->getOption().matches(options::OPT_x)) {
595      InputTypeArg = A;
596      InputType = types::lookupTypeForTypeSpecifier(A->getValue(Args));
597
598      // Follow gcc behavior and treat as linker input for invalid -x
599      // options. Its not clear why we shouldn't just revert to unknown; but
600      // this isn't very important, we might as well be bug comatible.
601      if (!InputType) {
602        Diag(clang::diag::err_drv_unknown_language) << A->getValue(Args);
603        InputType = types::TY_Object;
604      }
605    }
606  }
607
608  if (!SuppressMissingInputWarning && Inputs.empty()) {
609    Diag(clang::diag::err_drv_no_input_files);
610    return;
611  }
612
613  // Determine which compilation mode we are in. We look for options which
614  // affect the phase, starting with the earliest phases, and record which
615  // option we used to determine the final phase.
616  Arg *FinalPhaseArg = 0;
617  phases::ID FinalPhase;
618
619  // -{E,M,MM} only run the preprocessor.
620  if ((FinalPhaseArg = Args.getLastArg(options::OPT_E)) ||
621      (FinalPhaseArg = Args.getLastArg(options::OPT_M)) ||
622      (FinalPhaseArg = Args.getLastArg(options::OPT_MM))) {
623    FinalPhase = phases::Preprocess;
624
625    // -{fsyntax-only,-analyze,emit-ast,S} only run up to the compiler.
626  } else if ((FinalPhaseArg = Args.getLastArg(options::OPT_fsyntax_only)) ||
627             (FinalPhaseArg = Args.getLastArg(options::OPT__analyze,
628                                              options::OPT__analyze_auto)) ||
629             (FinalPhaseArg = Args.getLastArg(options::OPT_emit_ast)) ||
630             (FinalPhaseArg = Args.getLastArg(options::OPT_S))) {
631    FinalPhase = phases::Compile;
632
633    // -c only runs up to the assembler.
634  } else if ((FinalPhaseArg = Args.getLastArg(options::OPT_c))) {
635    FinalPhase = phases::Assemble;
636
637    // Otherwise do everything.
638  } else
639    FinalPhase = phases::Link;
640
641  // Reject -Z* at the top level, these options should never have been exposed
642  // by gcc.
643  if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
644    Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
645
646  // Construct the actions to perform.
647  ActionList LinkerInputs;
648  for (unsigned i = 0, e = Inputs.size(); i != e; ++i) {
649    types::ID InputType = Inputs[i].first;
650    const Arg *InputArg = Inputs[i].second;
651
652    unsigned NumSteps = types::getNumCompilationPhases(InputType);
653    assert(NumSteps && "Invalid number of steps!");
654
655    // If the first step comes after the final phase we are doing as part of
656    // this compilation, warn the user about it.
657    phases::ID InitialPhase = types::getCompilationPhase(InputType, 0);
658    if (InitialPhase > FinalPhase) {
659      // Claim here to avoid the more general unused warning.
660      InputArg->claim();
661
662      // Special case '-E' warning on a previously preprocessed file to make
663      // more sense.
664      if (InitialPhase == phases::Compile && FinalPhase == phases::Preprocess &&
665          getPreprocessedType(InputType) == types::TY_INVALID)
666        Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
667          << InputArg->getAsString(Args)
668          << FinalPhaseArg->getOption().getName();
669      else
670        Diag(clang::diag::warn_drv_input_file_unused)
671          << InputArg->getAsString(Args)
672          << getPhaseName(InitialPhase)
673          << FinalPhaseArg->getOption().getName();
674      continue;
675    }
676
677    // Build the pipeline for this file.
678    Action *Current = new InputAction(*InputArg, InputType);
679    for (unsigned i = 0; i != NumSteps; ++i) {
680      phases::ID Phase = types::getCompilationPhase(InputType, i);
681
682      // We are done if this step is past what the user requested.
683      if (Phase > FinalPhase)
684        break;
685
686      // Queue linker inputs.
687      if (Phase == phases::Link) {
688        assert(i + 1 == NumSteps && "linking must be final compilation step.");
689        LinkerInputs.push_back(Current);
690        Current = 0;
691        break;
692      }
693
694      // Some types skip the assembler phase (e.g., llvm-bc), but we can't
695      // encode this in the steps because the intermediate type depends on
696      // arguments. Just special case here.
697      if (Phase == phases::Assemble && Current->getType() != types::TY_PP_Asm)
698        continue;
699
700      // Otherwise construct the appropriate action.
701      Current = ConstructPhaseAction(Args, Phase, Current);
702      if (Current->getType() == types::TY_Nothing)
703        break;
704    }
705
706    // If we ended with something, add to the output list.
707    if (Current)
708      Actions.push_back(Current);
709  }
710
711  // Add a link action if necessary.
712  if (!LinkerInputs.empty())
713    Actions.push_back(new LinkJobAction(LinkerInputs, types::TY_Image));
714
715  // If we are linking, claim any options which are obviously only used for
716  // compilation.
717  if (FinalPhase == phases::Link)
718    Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
719}
720
721Action *Driver::ConstructPhaseAction(const ArgList &Args, phases::ID Phase,
722                                     Action *Input) const {
723  llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
724  // Build the appropriate action.
725  switch (Phase) {
726  case phases::Link: assert(0 && "link action invalid here.");
727  case phases::Preprocess: {
728    types::ID OutputTy;
729    // -{M, MM} alter the output type.
730    if (Args.hasArg(options::OPT_M) || Args.hasArg(options::OPT_MM)) {
731      OutputTy = types::TY_Dependencies;
732    } else {
733      OutputTy = types::getPreprocessedType(Input->getType());
734      assert(OutputTy != types::TY_INVALID &&
735             "Cannot preprocess this input type!");
736    }
737    return new PreprocessJobAction(Input, OutputTy);
738  }
739  case phases::Precompile:
740    return new PrecompileJobAction(Input, types::TY_PCH);
741  case phases::Compile: {
742    bool HasO4 = false;
743    if (const Arg *A = Args.getLastArg(options::OPT_O_Group))
744      HasO4 = A->getOption().matches(options::OPT_O4);
745
746    if (Args.hasArg(options::OPT_fsyntax_only)) {
747      return new CompileJobAction(Input, types::TY_Nothing);
748    } else if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto)) {
749      return new AnalyzeJobAction(Input, types::TY_Plist);
750    } else if (Args.hasArg(options::OPT_emit_ast)) {
751      return new CompileJobAction(Input, types::TY_AST);
752    } else if (Args.hasArg(options::OPT_emit_llvm) ||
753               Args.hasArg(options::OPT_flto) || HasO4) {
754      types::ID Output =
755        Args.hasArg(options::OPT_S) ? types::TY_LLVMAsm : types::TY_LLVMBC;
756      return new CompileJobAction(Input, Output);
757    } else {
758      return new CompileJobAction(Input, types::TY_PP_Asm);
759    }
760  }
761  case phases::Assemble:
762    return new AssembleJobAction(Input, types::TY_Object);
763  }
764
765  assert(0 && "invalid phase in ConstructPhaseAction");
766  return 0;
767}
768
769void Driver::BuildJobs(Compilation &C) const {
770  llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
771  bool SaveTemps = C.getArgs().hasArg(options::OPT_save_temps);
772  bool UsePipes = C.getArgs().hasArg(options::OPT_pipe);
773
774  // FIXME: Pipes are forcibly disabled until we support executing them.
775  if (!CCCPrintBindings)
776    UsePipes = false;
777
778  // -save-temps inhibits pipes.
779  if (SaveTemps && UsePipes)
780    Diag(clang::diag::warn_drv_pipe_ignored_with_save_temps);
781
782  Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
783
784  // It is an error to provide a -o option if we are making multiple output
785  // files.
786  if (FinalOutput) {
787    unsigned NumOutputs = 0;
788    for (ActionList::const_iterator it = C.getActions().begin(),
789           ie = C.getActions().end(); it != ie; ++it)
790      if ((*it)->getType() != types::TY_Nothing)
791        ++NumOutputs;
792
793    if (NumOutputs > 1) {
794      Diag(clang::diag::err_drv_output_argument_with_multiple_files);
795      FinalOutput = 0;
796    }
797  }
798
799  for (ActionList::const_iterator it = C.getActions().begin(),
800         ie = C.getActions().end(); it != ie; ++it) {
801    Action *A = *it;
802
803    // If we are linking an image for multiple archs then the linker wants
804    // -arch_multiple and -final_output <final image name>. Unfortunately, this
805    // doesn't fit in cleanly because we have to pass this information down.
806    //
807    // FIXME: This is a hack; find a cleaner way to integrate this into the
808    // process.
809    const char *LinkingOutput = 0;
810    if (isa<LipoJobAction>(A)) {
811      if (FinalOutput)
812        LinkingOutput = FinalOutput->getValue(C.getArgs());
813      else
814        LinkingOutput = DefaultImageName.c_str();
815    }
816
817    InputInfo II;
818    BuildJobsForAction(C, A, &C.getDefaultToolChain(),
819                       /*BoundArch*/0,
820                       /*CanAcceptPipe*/ true,
821                       /*AtTopLevel*/ true,
822                       /*LinkingOutput*/ LinkingOutput,
823                       II);
824  }
825
826  // If the user passed -Qunused-arguments or there were errors, don't warn
827  // about any unused arguments.
828  if (Diags.getNumErrors() ||
829      C.getArgs().hasArg(options::OPT_Qunused_arguments))
830    return;
831
832  // Claim -### here.
833  (void) C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
834
835  for (ArgList::const_iterator it = C.getArgs().begin(), ie = C.getArgs().end();
836       it != ie; ++it) {
837    Arg *A = *it;
838
839    // FIXME: It would be nice to be able to send the argument to the
840    // Diagnostic, so that extra values, position, and so on could be printed.
841    if (!A->isClaimed()) {
842      if (A->getOption().hasNoArgumentUnused())
843        continue;
844
845      // Suppress the warning automatically if this is just a flag, and it is an
846      // instance of an argument we already claimed.
847      const Option &Opt = A->getOption();
848      if (isa<FlagOption>(Opt)) {
849        bool DuplicateClaimed = false;
850
851        for (arg_iterator it = C.getArgs().filtered_begin(&Opt),
852               ie = C.getArgs().filtered_end(); it != ie; ++it) {
853          if ((*it)->isClaimed()) {
854            DuplicateClaimed = true;
855            break;
856          }
857        }
858
859        if (DuplicateClaimed)
860          continue;
861      }
862
863      Diag(clang::diag::warn_drv_unused_argument)
864        << A->getAsString(C.getArgs());
865    }
866  }
867}
868
869void Driver::BuildJobsForAction(Compilation &C,
870                                const Action *A,
871                                const ToolChain *TC,
872                                const char *BoundArch,
873                                bool CanAcceptPipe,
874                                bool AtTopLevel,
875                                const char *LinkingOutput,
876                                InputInfo &Result) const {
877  llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
878
879  bool UsePipes = C.getArgs().hasArg(options::OPT_pipe);
880  // FIXME: Pipes are forcibly disabled until we support executing them.
881  if (!CCCPrintBindings)
882    UsePipes = false;
883
884  if (const InputAction *IA = dyn_cast<InputAction>(A)) {
885    // FIXME: It would be nice to not claim this here; maybe the old scheme of
886    // just using Args was better?
887    const Arg &Input = IA->getInputArg();
888    Input.claim();
889    if (isa<PositionalArg>(Input)) {
890      const char *Name = Input.getValue(C.getArgs());
891      Result = InputInfo(Name, A->getType(), Name);
892    } else
893      Result = InputInfo(&Input, A->getType(), "");
894    return;
895  }
896
897  if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
898    const ToolChain *TC = &C.getDefaultToolChain();
899
900    std::string Arch;
901    if (BAA->getArchName())
902      TC = Host->CreateToolChain(C.getArgs(), BAA->getArchName());
903
904    BuildJobsForAction(C, *BAA->begin(), TC, BAA->getArchName(),
905                       CanAcceptPipe, AtTopLevel, LinkingOutput, Result);
906    return;
907  }
908
909  const JobAction *JA = cast<JobAction>(A);
910  const Tool &T = TC->SelectTool(C, *JA);
911
912  // See if we should use an integrated preprocessor. We do so when we have
913  // exactly one input, since this is the only use case we care about
914  // (irrelevant since we don't support combine yet).
915  const ActionList *Inputs = &A->getInputs();
916  if (Inputs->size() == 1 && isa<PreprocessJobAction>(*Inputs->begin())) {
917    if (!C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
918        !C.getArgs().hasArg(options::OPT_traditional_cpp) &&
919        !C.getArgs().hasArg(options::OPT_save_temps) &&
920        T.hasIntegratedCPP()) {
921      Inputs = &(*Inputs)[0]->getInputs();
922    }
923  }
924
925  // Only use pipes when there is exactly one input.
926  bool TryToUsePipeInput = Inputs->size() == 1 && T.acceptsPipedInput();
927  InputInfoList InputInfos;
928  for (ActionList::const_iterator it = Inputs->begin(), ie = Inputs->end();
929       it != ie; ++it) {
930    InputInfo II;
931    BuildJobsForAction(C, *it, TC, BoundArch, TryToUsePipeInput,
932                       /*AtTopLevel*/false, LinkingOutput, II);
933    InputInfos.push_back(II);
934  }
935
936  // Determine if we should output to a pipe.
937  bool OutputToPipe = false;
938  if (CanAcceptPipe && T.canPipeOutput()) {
939    // Some actions default to writing to a pipe if they are the top level phase
940    // and there was no user override.
941    //
942    // FIXME: Is there a better way to handle this?
943    if (AtTopLevel) {
944      if (isa<PreprocessJobAction>(A) && !C.getArgs().hasArg(options::OPT_o))
945        OutputToPipe = true;
946    } else if (UsePipes)
947      OutputToPipe = true;
948  }
949
950  // Figure out where to put the job (pipes).
951  Job *Dest = &C.getJobs();
952  if (InputInfos[0].isPipe()) {
953    assert(TryToUsePipeInput && "Unrequested pipe!");
954    assert(InputInfos.size() == 1 && "Unexpected pipe with multiple inputs.");
955    Dest = &InputInfos[0].getPipe();
956  }
957
958  // Always use the first input as the base input.
959  const char *BaseInput = InputInfos[0].getBaseInput();
960
961  // Determine the place to write output to (nothing, pipe, or filename) and
962  // where to put the new job.
963  if (JA->getType() == types::TY_Nothing) {
964    Result = InputInfo(A->getType(), BaseInput);
965  } else if (OutputToPipe) {
966    // Append to current piped job or create a new one as appropriate.
967    PipedJob *PJ = dyn_cast<PipedJob>(Dest);
968    if (!PJ) {
969      PJ = new PipedJob();
970      // FIXME: Temporary hack so that -ccc-print-bindings work until we have
971      // pipe support. Please remove later.
972      if (!CCCPrintBindings)
973        cast<JobList>(Dest)->addJob(PJ);
974      Dest = PJ;
975    }
976    Result = InputInfo(PJ, A->getType(), BaseInput);
977  } else {
978    Result = InputInfo(GetNamedOutputPath(C, *JA, BaseInput, AtTopLevel),
979                       A->getType(), BaseInput);
980  }
981
982  if (CCCPrintBindings) {
983    llvm::errs() << "# \"" << T.getToolChain().getTripleString() << '"'
984                 << " - \"" << T.getName() << "\", inputs: [";
985    for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
986      llvm::errs() << InputInfos[i].getAsString();
987      if (i + 1 != e)
988        llvm::errs() << ", ";
989    }
990    llvm::errs() << "], output: " << Result.getAsString() << "\n";
991  } else {
992    T.ConstructJob(C, *JA, *Dest, Result, InputInfos,
993                   C.getArgsForToolChain(TC, BoundArch), LinkingOutput);
994  }
995}
996
997const char *Driver::GetNamedOutputPath(Compilation &C,
998                                       const JobAction &JA,
999                                       const char *BaseInput,
1000                                       bool AtTopLevel) const {
1001  llvm::PrettyStackTraceString CrashInfo("Computing output path");
1002  // Output to a user requested destination?
1003  if (AtTopLevel) {
1004    if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
1005      return C.addResultFile(FinalOutput->getValue(C.getArgs()));
1006  }
1007
1008  // Output to a temporary file?
1009  if (!AtTopLevel && !C.getArgs().hasArg(options::OPT_save_temps)) {
1010    std::string TmpName =
1011      GetTemporaryPath(types::getTypeTempSuffix(JA.getType()));
1012    return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
1013  }
1014
1015  llvm::sys::Path BasePath(BaseInput);
1016  std::string BaseName(BasePath.getLast());
1017
1018  // Determine what the derived output name should be.
1019  const char *NamedOutput;
1020  if (JA.getType() == types::TY_Image) {
1021    NamedOutput = DefaultImageName.c_str();
1022  } else {
1023    const char *Suffix = types::getTypeTempSuffix(JA.getType());
1024    assert(Suffix && "All types used for output should have a suffix.");
1025
1026    std::string::size_type End = std::string::npos;
1027    if (!types::appendSuffixForType(JA.getType()))
1028      End = BaseName.rfind('.');
1029    std::string Suffixed(BaseName.substr(0, End));
1030    Suffixed += '.';
1031    Suffixed += Suffix;
1032    NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
1033  }
1034
1035  // As an annoying special case, PCH generation doesn't strip the pathname.
1036  if (JA.getType() == types::TY_PCH) {
1037    BasePath.eraseComponent();
1038    if (BasePath.isEmpty())
1039      BasePath = NamedOutput;
1040    else
1041      BasePath.appendComponent(NamedOutput);
1042    return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()));
1043  } else {
1044    return C.addResultFile(NamedOutput);
1045  }
1046}
1047
1048std::string Driver::GetFilePath(const char *Name, const ToolChain &TC) const {
1049  const ToolChain::path_list &List = TC.getFilePaths();
1050  for (ToolChain::path_list::const_iterator
1051         it = List.begin(), ie = List.end(); it != ie; ++it) {
1052    llvm::sys::Path P(*it);
1053    P.appendComponent(Name);
1054    if (P.exists())
1055      return P.str();
1056  }
1057
1058  return Name;
1059}
1060
1061std::string Driver::GetProgramPath(const char *Name, const ToolChain &TC,
1062                                   bool WantFile) const {
1063  const ToolChain::path_list &List = TC.getProgramPaths();
1064  for (ToolChain::path_list::const_iterator
1065         it = List.begin(), ie = List.end(); it != ie; ++it) {
1066    llvm::sys::Path P(*it);
1067    P.appendComponent(Name);
1068    if (WantFile ? P.exists() : P.canExecute())
1069      return P.str();
1070  }
1071
1072  // If all else failed, search the path.
1073  llvm::sys::Path P(llvm::sys::Program::FindProgramByName(Name));
1074  if (!P.empty())
1075    return P.str();
1076
1077  return Name;
1078}
1079
1080std::string Driver::GetTemporaryPath(const char *Suffix) const {
1081  // FIXME: This is lame; sys::Path should provide this function (in particular,
1082  // it should know how to find the temporary files dir).
1083  std::string Error;
1084  const char *TmpDir = ::getenv("TMPDIR");
1085  if (!TmpDir)
1086    TmpDir = ::getenv("TEMP");
1087  if (!TmpDir)
1088    TmpDir = ::getenv("TMP");
1089  if (!TmpDir)
1090    TmpDir = "/tmp";
1091  llvm::sys::Path P(TmpDir);
1092  P.appendComponent("cc");
1093  if (P.makeUnique(false, &Error)) {
1094    Diag(clang::diag::err_drv_unable_to_make_temp) << Error;
1095    return "";
1096  }
1097
1098  // FIXME: Grumble, makeUnique sometimes leaves the file around!?  PR3837.
1099  P.eraseFromDisk(false, 0);
1100
1101  P.appendSuffix(Suffix);
1102  return P.str();
1103}
1104
1105const HostInfo *Driver::GetHostInfo(const char *TripleStr) const {
1106  llvm::PrettyStackTraceString CrashInfo("Constructing host");
1107  llvm::Triple Triple(TripleStr);
1108
1109  switch (Triple.getOS()) {
1110  case llvm::Triple::AuroraUX:
1111    return createAuroraUXHostInfo(*this, Triple);
1112  case llvm::Triple::Darwin:
1113    return createDarwinHostInfo(*this, Triple);
1114  case llvm::Triple::DragonFly:
1115    return createDragonFlyHostInfo(*this, Triple);
1116  case llvm::Triple::OpenBSD:
1117    return createOpenBSDHostInfo(*this, Triple);
1118  case llvm::Triple::FreeBSD:
1119    return createFreeBSDHostInfo(*this, Triple);
1120  case llvm::Triple::Linux:
1121    return createLinuxHostInfo(*this, Triple);
1122  default:
1123    return createUnknownHostInfo(*this, Triple);
1124  }
1125}
1126
1127bool Driver::ShouldUseClangCompiler(const Compilation &C, const JobAction &JA,
1128                                    const llvm::Triple &Triple) const {
1129  // Check if user requested no clang, or clang doesn't understand this type (we
1130  // only handle single inputs for now).
1131  if (!CCCUseClang || JA.size() != 1 ||
1132      !types::isAcceptedByClang((*JA.begin())->getType()))
1133    return false;
1134
1135  // Otherwise make sure this is an action clang understands.
1136  if (isa<PreprocessJobAction>(JA)) {
1137    if (!CCCUseClangCPP) {
1138      Diag(clang::diag::warn_drv_not_using_clang_cpp);
1139      return false;
1140    }
1141  } else if (!isa<PrecompileJobAction>(JA) && !isa<CompileJobAction>(JA))
1142    return false;
1143
1144  // Use clang for C++?
1145  if (!CCCUseClangCXX && types::isCXX((*JA.begin())->getType())) {
1146    Diag(clang::diag::warn_drv_not_using_clang_cxx);
1147    return false;
1148  }
1149
1150  // Always use clang for precompiling and AST generation, regardless of archs.
1151  if (isa<PrecompileJobAction>(JA) || JA.getType() == types::TY_AST)
1152    return true;
1153
1154  // Finally, don't use clang if this isn't one of the user specified archs to
1155  // build.
1156  if (!CCCClangArchs.empty() && !CCCClangArchs.count(Triple.getArch())) {
1157    Diag(clang::diag::warn_drv_not_using_clang_arch) << Triple.getArchName();
1158    return false;
1159  }
1160
1161  return true;
1162}
1163
1164/// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
1165/// grouped values as integers. Numbers which are not provided are set to 0.
1166///
1167/// \return True if the entire string was parsed (9.2), or all groups were
1168/// parsed (10.3.5extrastuff).
1169bool Driver::GetReleaseVersion(const char *Str, unsigned &Major,
1170                               unsigned &Minor, unsigned &Micro,
1171                               bool &HadExtra) {
1172  HadExtra = false;
1173
1174  Major = Minor = Micro = 0;
1175  if (*Str == '\0')
1176    return true;
1177
1178  char *End;
1179  Major = (unsigned) strtol(Str, &End, 10);
1180  if (*Str != '\0' && *End == '\0')
1181    return true;
1182  if (*End != '.')
1183    return false;
1184
1185  Str = End+1;
1186  Minor = (unsigned) strtol(Str, &End, 10);
1187  if (*Str != '\0' && *End == '\0')
1188    return true;
1189  if (*End != '.')
1190    return false;
1191
1192  Str = End+1;
1193  Micro = (unsigned) strtol(Str, &End, 10);
1194  if (*Str != '\0' && *End == '\0')
1195    return true;
1196  if (Str == End)
1197    return false;
1198  HadExtra = true;
1199  return true;
1200}
1201