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